Messaging Traffic Report

Overview

The Messaging Traffic Report provides the information for each message, such as: when the message was sent, who sent it, the direction of the message, the message ID, the interaction ID that contains the message, etc.

🚧

Interaction

An interaction consists of the full activity of communication between agents and callers, and contacts are subsets of an interaction (transfers or fallbacks to different ring groups).

Usage

Specify messaging_traffic as report type in the Explore API request path: /data/reports/messaging_traffic/jobs.

📘

Messaging Traffic Report metrics

Report Example

{
    "entries": [
        {
            "contact_id": "f2bd0d65-3a68-4189-a322-16edbe16ef90",
            "channel_type": "EMAIL",
            "contact_person_id": "[email protected]",
            "contact_person_name": "",
            "interaction_id": "7b8ae824abf4460f8baec54e344b1905",
            "message_created_at": "2022-08-22 19:49:12",
            "message_direction": "Inbound",
            "message_id": "da0b5b91-e7fd-488f-ae02-922a52a18e60",
            "user_id": null,
            "user_name": null
        },
        {
            "contact_id": "d9024365-c940-4515-a8d4-80508466c0a8",
            "channel_type": "EMAIL",
            "contact_person_id": "[email protected]",
            "contact_person_name": "",
            "interaction_id": "fc032d083df846a7b9164a279c47a8e3",
            "message_created_at": "2022-08-22 18:36:06",
            "message_direction": "Inbound",
            "message_id": "72405c25-3e5c-4f89-bb14-f18873c83188",
            "user_id": null,
            "user_name": null
        }
    ],
    "total": 49
}

❗️

Data and Report Availability

Up to a month of data per request.

There are no limits on the data available regarding the timeframe.

📘

Messaging Traffic Report @ Explore API vs @ Reporting API - Data Availability and Data Freshness

Regarding data freshness, there is no difference between the Explore API and Reporting API. Both share the same assumptions of data and report availability.


Did this page help you?