Channel Metrics

Querying Message Metrics

In order to query message metrics you must have a channel and perform a HTTP request to the following endpoints with a valid access key.

Fetch message metrics by channel ID

Retrieve a TimeSeries of metrics for the given FilterType and FilterId

Filter Types	Filter ID
Channel	The Channel ID of the Channel
Platform	Currently Unused
Status	Currently Unused

Group By	Notes
status	Groups the results by the channel status, such as "queued, sent, delivered" etc.

Fetch message metrics

Fetch message metrics for a platform or channel

POST/workspaces/{workspaceId}/reporting/messages/{filterType}/{filterId}/metrics

Authorization

useraccessKey

Body

application/json

periodStart*PeriodTime (string (date-time))

periodEnd*PeriodTime (string (date-time))

periodGroup*enum

minutehourdaymonth

selectarray of enum

filterByobject

groupByarray of enum

Response

200422

List of results

Body

application/json

periodGroupenum

minutehourdaymonth

dataColumns*array of enum

resultsarray of object

Request

JavaScriptCurl

const response = await fetch('/workspaces/{workspaceId}/reporting/messages/{filterType}/{filterId}/metrics', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "periodStart": "2024-07-27T04:20:58.444Z",
      "periodEnd": "2024-07-27T04:20:58.444Z",
      "periodGroup": "minute"
    }),
});
const data = await response.json();

Response

{
  "periodGroup": "minute",
  "dataColumns": [
    "messageType"
  ],
  "results": [
    {
      "periodTime": "2024-07-27T04:20:58.444Z",
      "data": [
        "text"
      ]
    }
  ]
}

Fetch channel metrics using query parameter filters

Fetch channel metrics

Fetch channel metrics using various query parameters

GET/workspaces/{workspaceId}/reporting/channels/metrics

Authorization

useraccessKey

Path parameters

workspaceId*string (uuid)

The ID of the workspace

Query parameters

Response

200422

List of results

Body

application/json

summaryobject

timeSeriesarray of object

Request

JavaScriptCurl

const response = await fetch('/workspaces/{workspaceId}/reporting/channels/metrics', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

[
  {
    "summary": {
      "channelId": "123e4567-e89b-12d3-a456-426614174000",
      "channelName": "text",
      "channelPlatformId": "text",
      "channelStatus": "text",
      "messageType": "text",
      "direction": "text",
      "attributedRevenue": 0,
      "currency": "text"
    },
    "timeSeries": [
      {
        "periodDate": "2024-07-27T04:20:58.444Z"
      }
    ]
  }
]