Consulta as ações que aconteceram em uma ou mais notificaçõies. Ações são interações que um destinatário realizou com uma notificação. Por exemplo:
A consulta a está API retorna todos as ações que ocorreram na faixa de datas especificadas em start_date e end_date conforme o timezone configurado para a entidade que está sendo consultada.
Metrics (GET) /metrics/notifications/actions/{entity_id}/bydate/{start_date}/{end_date}
| Parâmetro | Finalidade |
|---|---|
| entity_id | Código da clínica, consultório, ou hospital cadastrado na API. |
| start_date | Data inicial a ser pesquisada. |
| end_date | Data final a ser pesquisada. |
Sim
Nenhum
[
{
"params": {
"day": "16",
"hour": "16",
"when": "2019-10-16T16:27:00Z",
"year": "2019",
"month": "10",
"doctor": "Pedro Lucas Santos",
"minute": "27",
"event_date": "2019-10-16T16:27:00Z",
"doctor_gender": "M",
"doctor_expertise": "Cardiologista",
"doctor_external_id": "pedrolucassantos"
},
"task_id": "ck1plefj4000201mi9pyney6d",
"external_id": "ck1pleb2q0002h3glrv73b0aq",
"target": "appointment",
"channel": "mobile",
"notification_id": "ck1plef54000001mikpkpoj76",
"entity_id": "cjth5ux7n000001l1zmd7tk99",
"action": "confirm",
"contact": {
"external_id": "aloísiomendonçafraga",
"name": "Aloísio Mendonça Fraga"
},
"date": "2019-10-13T23:10:42.207240+00:00",
"uid": "+5527988791560",
"category": "medical"
}
]
O campo action informa a ação que ocorreu. A data do evento está no campo date.
O campo external_id corresponde à chave primária da tabela de agendamentos do seu banco de dados e que foi informado no momento da criaçãoda notificação.
Os campos category, target informa o plugin usado para criar a notificação e o campo params os parametros específicos deste tipo notificação.
Nos campos channel e uid está o canal de comunicação por onde ocorreu a ação e o número de telefone, email ou id do usuário naquele canal.
curl -X GET "https://api.notifier.datanuvem.ai/v1/metrics/notifications/actions/cjth5ux7n000001l1zmd7tk99/2019-10-13/2019-10-13" -H "accept: application/json" -H "Authorization: Bearer <COLOQUE AQUI O TOKEN DE AUTENTICAÇAO>" -H "Content-Type: application/json"
O Exemplo acima consulta todas as ações que ocorreram no dia 13/10/2019 para a entidade jth5ux7n000001l1zmd7tk99.
Aviso
O campo date está no timezone universal UTC.