Consumo dos scores agregado

get

https://www.pulses.com.br/api/engage/v1/score/{uid_instrument}

Essa rota visa oferecer uma alternativa ao endpoint de respostas individuais, sendo compatível com instrumentos confidenciais, e com retorno já consolidado, pronto para uso em dashboards ou análises externas.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

uid_instrument

string

required

Identificador do instrumento a ser consultado. Esse parâmetro faz parte da URL do endpoint.

Query Params

endDate

string

Data final do período de consulta. Se não for informada, será considerada a data atual. O formato deve ser YYYY-MM-DD. Para instrumentos em frequência não contínua (bimestral, trimestral, semestral, anual), esse campo será aplicado apenas nas resposta, não sendo considerado para a hierarquia (grupos e líderes).

idLeader

string

ID do líder utilizado como filtro.

leaderHierarchyDepth

string

enum

Define o nível de profundidade hierárquica de lideranças a ser considerado no cálculo do score. Os valores podem ser "direct" para considerar apenas liderados diretos ou "full" para considerar toda a hierarquia abaixo, em todos os níveis. Caso não seja informado, o valor default é "direct".

Allowed:

idGroup

string

ID do grupo utilizado como filtro.

groupHierarchyDepth

string

enum

Define o nível de profundidade hierárquica de grupos a ser considerado no cálculo do score. Os valores podem ser "direct" para considerar apenas os respondentes do grupo ou "full" para considerar toda a hierarquia abaixo, em todos os níveis. Caso não seja informado, o valor default é "direct".

Allowed:

idQuestion

string

ID da questão utilizada como filtro.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Sucesso

400Parâmetros inválidos. Cada parâmetro inválido estará dentro do objeto "errors".

404Filtro não encontrado