Channel Metrics
Querying Message Metrics
Last updated
Was this helpful?
Querying Message Metrics
Last updated
Was this helpful?
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.
Retrieve a TimeSeries of metrics for the given FilterType and FilterId
Channel
The Channel ID of the Channel
Platform
Currently Unused
Status
Currently Unused
status
Groups the results by the channel status, such as "queued, sent, delivered" etc.
Fetch message metrics for a platform or channel
/workspaces/{workspaceId}/reporting/messages/{filterType}//{filterId}/metrics
The ID of the workspace
The type of message metrics filter
channel
, platform
, status
The ID of the filter, being platformId or channelId
minute
, hour
, day
, month
Fetch channel metrics using various query parameters
/workspaces/{workspaceId}/reporting/channels/metrics
The ID of the workspace
The date and time in the format 'YYYY-MM-DDTHH:MM:SSZ' or 'YYYY-MM-DDTHH:MM:SS-HH:MM'.
The date and time in the format 'YYYY-MM-DDTHH:MM:SSZ' or 'YYYY-MM-DDTHH:MM:SS-HH:MM'.
The time grouping of the period for which to fetch metrics. If provided time series will be returned and grouped by this period.
minute
, hour
, day
, month
Filter conditions for which to fetch metrics. Each condition is a string in the format of 'equals(field
,value
)'.
Available field-value pairs are
channelID
- UUID, can supply multiple equals conditions for multiple channelIdsplatformID
- string, can supply multiple equals conditions for multiple platforms
status
- string, can supply multiple equals conditions for multiple statuses
name
- string, only one condition allowedmessageType
- string, can supply multiple equals conditions for multiple messageTypes
direction
- string, only one condition allowed