[DNP]WhatsApp Reports
This topic has been segregated into WhatsApp Tabular Report and WhatsApp Summary Report. Do not publish this page. [AA]
The WhatsApp Reports contain the following reports:
- Summary Report - It provides a summary of the overall WhatsApp messages. For example, on a particular day how many messages were sent, how many were failed, how many were delivered, how much amount was charged for sessions, and many more. For more details about report columns, see Summary Report.
- Detailed Report or Tabular Report - It provides the detail of each WhatsApp message. For example, message content, the status of the message, the reason for message failure, and many more. For more details on report columns, see Tabular Report.
Summary Report
The Summary Report is classified into the following two types of reports:
WhatsApp Summary Report for Messages
The WhatsApp Summary-Messages report helps you in the performance analysis of the messages. For example, how many messages get delivered or failed, read by the WhatsApp message recipient, and many more. Overall, this report displays the complete journey of WhatsApp messages from a message sent to the message received by the recipient.
The Summary Report for Messages contains the following details:
| Column Title | Description | Example |
|---|---|---|
| DATE | Date when the WhatsApp message is initiated by an active WhatsApp number. | Nov 25, 2022 |
| WABA ID | WhatsApp Business Account ID. | 5XXXXXXXXXXXXX6 |
| WA PHONE NUMBER | Approved WhatsApp phone number through which the message is sent or received. | 6XXXXXXXXXX3 |
| DISPLAY NAME | Name that appears to the users. The Business Name you have assigned to your approved WhatsApp number. | Kalerya Italy (MWC + Tiledesk) |
| COUNTRY | End user's country. In the case of outgoing messages, this is the destination country. In the case of incoming messages, this is the country of the end user from where a message is sent to you. | United States of America |
| MESSAGE TYPE | Indicates whether a WhatsApp message is incoming (users sending a message to you), outgoing (you are sending a message to the user), or template (you have sent a message to the recipient using a template). | Outgoing session message |
| CREATED | The total number of messages intended to be sent. Incoming messages will never have a value under this column. | 2 |
| FAILED | The total number of messages that failed to be delivered to the recipient. It includes the WhatsApp messages that failed at the application level or at the Meta level. Incoming messages will never have a value under this column. | 0 |
| SENT | The number of messages that are passed to the Meta server to be sent to a receiver. Incoming messages will never have a value under this column. Note: There could be a reason for messages getting failed while getting delivered to the recipient numbers once a message is initiated from the Meta server. These failed messages are counted in the Failed column. | 2 |
| DELIVERED | The number of messages that get delivered to the recipients. Incoming messages will never have a value under this column. | 2 |
| READ | The number of messages that are read by the recipients. Incoming messages will never have a value under this column. | 2 |
| RECEIVED | The number of messages received from the user to you. This column is only applicable when the Message Type column has incoming messages. | - |
WhatsApp Summary Report for Sessions
The WhatsApp Summary-Sessions report enables you to get the total number of sessions initiated for the WhatsApp number, the amount charged for sessions, and many more.
The Summary Report for Sessions contains the following details:
| Column Title | Description | Example |
|---|---|---|
| DATE | Date when the WhatsApp session is initiated. | Nov 25, 2022 |
| WABA ID | WhatsApp Business Account ID. | 6XXXXXXXXXXXXX5 |
| WA PHONE NUMBER | Approved WhatsApp Phone Number through which you send or receive messages. | 3XXXXXXXXXX6 |
| DISPLAY NAME | Name that appears to the users. The Business Name you have assigned to your approved WhatsApp number. | Kaleyra BOT-PRD-KDM-1 |
| COUNTRY | End user's country. | India |
| SESSION TYPE | It can be business-initiated, user-initiated, or referral. For more information on session type, see Types of Conversations. | User-initiated |
| FREE TIER | WhatsApp provides the first 1000 free sessions (business-initiated or user-initiated) to the users. If the session is within this limit, it appears as Yes or else No (if crossed the free tier and it is chargeable). | Yes |
| NUMBER OF SESSIONS | The total number of sessions initiated for WhatsApp Phone Number having the country, same session type, and free tier values on the given date. | 1 |
| AMOUNT ($) | For referral sessions, the sessions are not charged. For Free Tier, the amount will be zero. Except that all other WhatsApp sessions are chargeable based on country, session type, and the overall number of sessions. | 0 |
Tabular Report
The Tabular Report contains the following details:
Column Title | Description | Example |
|---|---|---|
WABA ID | WhatsApp Business Account ID. | 8XXXXXXXXXXXXX1 |
WHATSAPP_ID | Unique ID generated on the message request. | 7XXXXXX9-9XXX-4XXX-8XXX-4XXXXXXXXXX4:0 |
FROM | Approved WhatsApp Phone Number through which the message is sent. | United Kingdom of Great Britain and Northern Ireland |
TO | The recipient number to which the message is sent. | 4XXXXXXXXXX1 |
MESSAGE_DIRECTION | The direction of the messages. If the value is True, it indicates the incoming message. If the value is False, it indicates the outgoing message. | false |
SOURCE | The source of the WhatsApp messages. It can be API or webhook. | api |
FORMAT | The format of the WhatsApp messages. It can be one of the following:
| text |
REASON_FOR_FAILURE | The reasons for the failure of the initiated WhatsApp messages. | The message failed because more than 24 hours have passed since the customer last replied to this number. |
COUNTRY | End user's country. In the case of outgoing messages, this is the destination country. In the case of incoming messages, this is the country of the end user from where a message is sent to you. | India |
TEMPLATE_NAME | The name of the template used for sending the message. | contact_us |
MESSAGE | The WhatsApp message that you have sent or received. | T-Shirt XL |
CREATED_AT | Date and time when the message was requested. | 2022-11-25T08:34:10.000Z |
FAILED_AT | Date and time when the message failed. | 2022-11-25T08:34:10.000Z |
SENT_AT | Date and time when the message was sent to the Meta server. | 2022-11-25T08:34:10.000Z |
DELIVERED_AT | Date and time when the message reached the user's mobile device. | 2022-11-25T08:34:10.000Z |
SEEN_AT | Date and time when the message was viewed on the mobile device. | 2022-11-25T08:34:10.000Z |
PARENT_SERVICE_TYPE | Indicates whether a WhatsApp message is incoming (users sending a message to you), outgoing (you are sending a message to the user), or template (you have sent a message to the recipient using a template). | session_outgoing |
CONVERSATION_TYPE | The type of session to which the message is associated. | user_initiated |
CONVERSATION_ID | Unique session ID for WhatsApp session. | eXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX4 |
CONVERSATION_MSG_TYPE | Indicates the session message type.
| In Conversation |
CAMPAIGN_ID | Unique ID for each campaign. | 0xxxx210-3xx2-11xx-9x58-0xx1559xxx49 |
REF | The REF parameter is optional in API requests. Customers can pass the required information for this parameter that they want displayed in the report. | |
REF1 | The REF1 is an optional parameter that can be passed in the API requests. Customers can pass the required information for this parameter that they want displayed in the report. | |
REF2 | The REF2 parameter is optional in API requests. Customers can pass the required information for this parameter that they want displayed in the report. |
Updated 6 days ago