MessagingTrafficReport
Query the Messaging Traffic Report via the Explore API. Provides information for each message including sender, direction, and interaction details. Up to a month of data per request.
Select
The MessagingTrafficReport is a report view. The connector processes the following pseudo-columns server-side; any other WHERE clause conditions are evaluated client-side.
- TimespanFrom supports the following operator: >=
- TimespanTo supports the following operator: <
- Timezone supports the following operator: =
If TimespanFrom and TimespanTo are omitted, the connector defaults the time range to the last 31 days.
For example, the following query is processed server-side:
SELECT * FROM MessagingTrafficReport WHERE TimespanFrom >= '2025-01-01' AND TimespanTo < '2025-02-01'
Columns
| Name | Type | References | Description |
| MessageId [KEY] | String | The unique identifier of the message. | |
| ContactId | String |
Contacts.Id | The unique identifier of the contact. |
| InteractionId | String |
CallsReport.InteractionId | The unique identifier of the interaction. |
| ContactPersonId | String | The identifier of the contact person. | |
| ChannelType | String | The type of messaging channel. Example values: EMAIL, SMS. | |
| ContactPersonName | String | The name of the contact person. | |
| MessageCreatedAt | Datetime | The date and time the message was created. | |
| MessageDirectionSort | String | The sort value for the message direction. | |
| MessageDirection | String | The direction of the message. Example values: Inbound, Outbound. | |
| UserId | String |
Users.Id | The unique identifier of the agent, if applicable. |
| UserName | String | The name of the agent, if applicable. |
Pseudocolumns
Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description | |
| TimespanFrom | Datetime | The start date for the report timespan. | |
| TimespanTo | Datetime | The end date for the report timespan. | |
| Timezone | String | The IANA timezone for the report timespan. |