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",
"id_instrument": 0,
"id_send_group": 0,
"id_instrument_reference": 0,
"name": "NOME DO INSTRUMENTO",
"type": "TIPO DO INSTRUMENTO",
"all_at_once": 0,
"recency": 0,
"max_questions": 0,
"active": 0,
"locked": 0,
"hierarchical": 0,
"confidentiality": 0,
"messages": null,
"minimum_respondents": 0,
"questions_config": {
"type": "string",
"scale": {
"max": 100,
"min": 0
},
"hide_feedback": bool
},
"current_cycle": 0,
"is_deepening_cycle": 0,
"calculation_type": 0,
"self_attribute": 0,
"lagging": 0,
"distribution_type": 0,
"skip_text": 0,
"grouping_type": 0,
"first_answer_date": "YYYY-MM-DD HH:MM:SS",
"last_answer_date": "YYYY-MM-DD HH:MM:SS",
"send_type": 0,
"frequency": 0,
"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 6 months ago