Messages

Fetch message analytics

Changed on Nov 3, 2026

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

Request

Base URL
https://api.superchat.com/v1.0
URL
https://api.superchat.com/v1.0/analytics/messages
Auth
API key in header X-API-KEY

Query parameters

message_idsstring[] required

List of message IDs to fetch analytics for.

Response

urlstring required

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"
      }
    }
  ]
}

Changes

Nov 3, 202631e7bd6f37e9 Revision changes
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property // became required for the status
- info
  the response property // became required for the status
- info
  the response property // became required for the status
- info
  the response property // became required for the status
- info
  the response property became required for the status
- info
  the response property // became required for the status
- info
  the response property /////// became required for the status
- info
  the response property /////// became required for the status
- info
  the response property ///////// became required for the status
- info
  the response property ///////// became required for the status
- info
  the response property ///////// became required for the status
- info
  the response property // became required for the status
- info
  the response property /////// became required for the status
- info
  the response property // became required for the status
- info
  the response property /////// became required for the status
- info
  the response property // became required for the status
- info
  the response property /////// became required for the status
- info
  the response property // became required for the status
- info
  the response property // became required for the status
- info
  the response property /////// became required for the status
- info
  the response property // became required for the status
- info
  the response property /////// became required for the status
- info
  the response property became required for the status

Operation history