Get agent event insights

Retrieve per-event-type volume, completion, and latency for the events sent to the agent over a date range, broken down by the event type supplied. Figures are rolled up once a day, so the most recent day may still be incomplete.

get

Authorizations

D360-API-KEYstringRequired

API Key for Messaging API authentication. Send your API key in the D360-API-KEY header.

Query parameters

start_datestringRequired

First day to include, as YYYY-MM-DD in Pacific Time, which may differ from your own time zone. The boundary is inclusive.

end_datestringRequired

Last day to include, as YYYY-MM-DD in Pacific Time, which may differ from your own time zone. The boundary is inclusive. start_date and end_date may span at most 30 days, counting both the first and last day.

event_typestringOptional

Return only this event type, named as you sent it. Omit to get every event type received in the range.

Header parameters

X-API-Versionstring · enumOptional

Meta Business Agent API version

Possible values:

Responses

200

The agent event insights for the requested range

application/json

The agent event insights for the requested range

avg_e2e_latency_msnumberOptional

Mean time in milliseconds from receiving an event to the agent finishing with it, across every event type in the range. Null when nothing ran end to end

Example: 842.5

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

429

Too many requests

application/json

500

Server error

application/json

get/insights/agent_events

GET /insights/agent_events?start_date=text&end_date=text HTTP/1.1
Host: waba-v2.360dialog.io
D360-API-KEY: YOUR_API_KEY
Accept: */*

{
  "avg_e2e_latency_ms": 842.5,
  "data": [
    {
      "avg_e2e_latency_ms": 842.5,
      "event_type": "order_update",
      "received": 1200,
      "successfully_processed": 1150
    }
  ]
}