GET /v1/automations/metrics
GET
/v1/automations/metrics
const url = 'https://seu-endereco-da-api/v1/automations/metrics?ids=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://seu-endereco-da-api/v1/automations/metrics?ids=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0' \ --header 'Authorization: Bearer <token>'Permissão que a Chave de acesso precisa: Ler disparos automáticos (automations:read).
Authorizations
Seção intitulada “Authorizations”Parameters
Seção intitulada “Parameters”Query Parameters
Seção intitulada “Query Parameters”ids
required
Array<string>
Comma-separated automation ids (max 100); the window is the last 30 days
Responses
Seção intitulada “Responses”Media typeapplication/json
object
items
required
Array<object>
object
automationId
required
string format: uuid
sent
required
Messages sent in the last 30 days
number
delivered
required
Sent messages that were delivered or read
number
read
required
Sent messages that were read
number
replied
required
Sent messages the contact answered within 72 hours in the same conversation
number
Example generated
{ "items": [ { "automationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "sent": 1, "delivered": 1, "read": 1, "replied": 1 } ]}