Fluxo de integração - API de consulta de Instrumentos
Atualmente disponibilizamos dois endpoints um que permite a consulta das informações de todos os instrumentos cadastrados, e outro que permite a consulta das informações dos instrumentos, como questões, dimensões e fatores.
A consulta de instrumentos é muito importante para a configuração das integrações de score.
Acesse o endpoint Consulta todos os instrumentos para consultar todos os instrumentos cadastrados na conta.
Acesse o endpoint Consulta dados do instrumento via uid_instrumentConsulta dados do instrumento via uid_instrument para consultar todas as informações incluindo dimensões, fatores e questões de um instrumento específico.
Parâmetros da requisição
| Nome do campo | Descrição | Obrigatório/regra de negócio |
|---|---|---|
| instrument | UID do instrumento | Obrigatório. O UID do instrumento pode ser encontrado na área de administração de instrumentos no endereço da página de edição do instrumento. |
ATENÇÃO
O
uid_instrumentpode ser obtido através da requisição para obter todos os instrumentos
Exemplo de requisição:
curl --location 'https://www.pulses.com.br/api/engage/v1/instruments/[uid_instrument]' \
--header 'Authorization: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--header 'Cookie: PHPSESSID=746h8innd3jk81itjvqfi63tbv' \
--data ''
Exemplo de response:
Após recebido, a requisição será processada em segundo plano retornando a resposta conforme o modelo abaixo.
{
"uid_instrument": "UID DO INSTRUMENTO", //uid do instrumento que está sendo consultado
"id_instrument": 0, //id do instrumento. Identificador interno do instrumento dentro da plataforma
"id_send_group": 0, //id do grupo de envio. Identificador interno do instrumento dentro da plataforma
"id_instrument_reference": 0, //id do instrumento de referência. Identificador interno do instrumento dentro da plataforma
"name": "NOME DO INSTRUMENTO", //nome do instrumento
"type": "TIPO DO INSTRUMENTO", //tipo do instrumento
"all_at_once": 0,
"recency": 0,
"max_questions": 0, //quantidade máxima de questões
"active": 0, //instrumento ativo (1: sim, 0: não)
"locked": 0, //instrumento bloqueado para respostas (1:sim, 0:não)
"hierarchical": 0, //instrumento hierárquico (0:sim, 1:não)
"confidentiality": 0, //confidencialidade (0:pesquisa identificada, 1:pesquisa confidencial, 2:pesquisa parcialmente identificada)
"messages": null,
"minimum_respondents": 0, //mínimo de respondentes esperada para resultados
"questions_config": {
"type": "string",
"scale": {
"max": 100,
"min": 0
},
"hide_feedback": bool
},
"current_cycle": 0, //ciclo atual
"is_deepening_cycle": 0, //ciclo de aprofundamento (0: não, 1:sim)
"calculation_type": 0, //tipo de cálculo do score (1:média de respostas, 2:categorização de respostas, 3:categorização do indivíduo, 4:NPS)
"self_attribute": 0,
"lagging": 0, //lagging de score, valor em semanas
"distribution_type": 0, // Tipo de distribuição de perguntas utilizado no instrumento (1: Automatizado, 2:Manual)
"skip_text": 0,
"grouping_type": 0,
"first_answer_date": "YYYY-MM-DD HH:MM:SS", //data da primeira resposta
"last_answer_date": "YYYY-MM-DD HH:MM:SS", //data da última resposta
"send_type": 0, //tipo de envio
"frequency": 0, //frequência de envio
"grouping": "questions",
"groups": [
{
"id_group": 0,
"id_instrument": 0,
"parent": 0,
"image": "URL da imagem",
"active": bool,
"deleted": 0,
"answered": 0,
"title": {
"en-US": [
{
"text": "string",
"description": "string"
}
],
"es-ES": [
{
"text": "string",
"description": "string"
}
],
"pt-BR": [
{
"text": "string",
"description": "string"
}
]
},
"hidden": 0,
"created_at": "YYYY-MM-DD HH:MM:SS",
"updated_at": "YYYY-MM-DD HH:MM:SS",
"deleted_at": null,
"order": 0,
"questions": [],
"groups": [
{
"id_group": 0,
"id_instrument": 0,
"parent": 0,
"image": null,
"active": bool,
"deleted": 0,
"answered": 0,
"title": {
"en-US": [
{
"text": "string",
"description": "string"
}
],
"es-ES": [
{
"text": "string",
"description": "string"
}
],
"pt-BR": [
{
"text": "string",
"description": "string"
}
]
},
"hidden": 0,
"created_at": "YYYY-MM-DD HH:MM:SS",
"updated_at": "YYYY-MM-DD HH:MM:SS",
"deleted_at": null,
"order": 0,
"questions": [
{
"id_instrument": 0,
"id_question": 0,
"id_group": 0,
"id_parent_group": 0,
"config": {
"type": "slider_images",
"scale": {
"max": 100,
"min": 0
},
"title": {
"en-US": [
{
"text": "string",
"description": "string"
}
],
"es-ES": [
{
"text": "string",
"description": "string"
}
],
"pt-BR": [
{
"text": "string",
"description": "string"
}
]
},
"options": [
{
"text": {
"en-US": [
"string"
],
"es-ES": [
"string"
],
"pt-BR": [
"string"
]
},
"image": "URL da imagem"
},
{
"image": "URL da imagem"
},
{
"text": {
"en-US": [
"string"
],
"es-ES": [
"string"
],
"pt-BR": [
"string"
]
},
"image": "string"
}
]
},
"deepening": 0,
"order": 0,
"required": bool,
"currentVariation": 0,
"active": bool,
"skip_text": 0,
"answers": 0,
"confidentiality": 0
},
],
"groups": []
}
]
}
],
"active_questions": 0,
"hasAnswers": bool,
"hasSentPulses": bool
}
Updated 2 months ago