Message Metrics

Query Metrics Related to Messages

Get message attributes

Fetch message attributes using various query parameters

GET/workspaces/{workspaceId}/reporting/messages

Path parameters

workspaceId*string (uuid)

The ID of the workspace

Query parameters

Response

200422

An array of messages

Body

application/json

ChannelIDstring

ChannelNamestring

ChannelSenderTypestring

CampaignIDstring

ChargeableUnitsinteger

PartCountinteger

PlatformIDstring

Statusstring

FailureCodestring

CreatedAtstring (date-time)

SentAtstring (date-time)

DeliveredAtstring (date-time)

Directionstring

Fromobject

Toobject

MessageTypestring

ExtraInformationobject

UseCasestring

Activityobject

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/reporting/messages?periodStart=2024-12-22T02%3A07%3A26.671Z', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200422

[
  {
    "ChannelID": "text",
    "ChannelName": "text",
    "ChannelSenderType": "text",
    "CampaignID": "text",
    "ChargeableUnits": 0,
    "PartCount": 0,
    "PlatformID": "text",
    "Status": "text",
    "FailureCode": "text",
    "CreatedAt": "2024-12-22T02:07:26.671Z",
    "SentAt": "2024-12-22T02:07:26.671Z",
    "DeliveredAt": "2024-12-22T02:07:26.671Z",
    "Direction": "text",
    "From": {
      "Key": "text",
      "Value": "text",
      "CountryCode": "text"
    },
    "To": {
      "Value": [
        "text"
      ],
      "CountryCodes": [
        "text"
      ]
    },
    "MessageType": "text",
    "ExtraInformation": {
      "Operator": "text",
      "MailboxProvider": "text",
      "MailboxProviderRegion": "text"
    },
    "UseCase": "text",
    "Activity": {
      "OpenedAt": "2024-12-22T02:07:26.671Z",
      "ClickedAt": "2024-12-22T02:07:26.671Z"
    }
  }
]