Sign in

v1

latestOpenAPI 3.1.02026-07-2458221215.8 KB
Messages

Fetch message analytics

Returns engagement analytics for multiple messages. Request body specifies message IDs. Each result includes message_id and the analytics object with nullable ISO-8601 timestamps for each engagement event. Missing or inaccessible message IDs are omitted from results.

get/analytics/messages

Query parameters

message_idsstring[] required

List of message IDs to fetch analytics for.

Response

OK

urlstring

The URL of the analytics resource

Example response

{
  "results": [
    {
      "sending_attempted": {
        "timestamp": "2022-03-10T16:15:50Z"
      },
      "delivered": {
        "timestamp": "2022-03-10T16:15:50Z"
      },
      "failed": {
        "timestamp": "2022-03-10T16:15:50Z"
      },
      "read": {
        "timestamp": "2022-03-10T16:15:50Z"
      },
      "clicked": {
        "buttons": [
          {
            "timestamp": "2022-03-10T16:15:50Z"
          }
        ]
      },
      "freeform_replied": {
        "timestamp": "2022-03-10T16:15:50Z"
      }
    }
  ]
}