The article provides a guide on generating Detailed Reports within the Sinch Engage platform. It outlines steps for configuring data filters, including selecting a date range, targeting specific accounts, and choosing message statuses and contacts.
Important - Due to data retention regulations, we only store the past 12 months messaging history.
Running detailed reports
-
In the menu, click on Reports, then select Detailed Reports:
From the Detailed Reports page, you can configure your data filters: - Select a date range (up to 12 months) by clicking in the field. Select a start and end date within a 12 month range OR select from one of the predefined date quick links.
- Select the account(s) you wish to report on. If you are in the parent account you will be able to view all sub-accounts at all levels. If you are logged into a sub-account at any level, you can only report on that sub account, or those further down the account hierarchy. To report on the parent or other sub accounts you need to switch to the parent account.
- Select the status' of the messages you wish to be included in the report.
- Select the contact to whom the targeted messages were sent.
- To search Metadata, click on the Advanced Filters option and select the metadata key here (e.g. Sender ID). Enter the Metadata value in the field next to this (e.g. - if you have selected "Sender" as the metadata key, here you would enter the name or number of the sender).
- Click on Apply Filters.
Note - You can leave fields blank to include all values within each parameter; however, a date range is always required.
Message Tables
Notes -
- When you have adjusted the displayed columns, they will be remembered as your default column display whenever you visit this page, as long as you use the same device and browser. They can also be re-adjusted or reverted at any time.
- Data will not be displayed if:
- No messages were sent within the date range specified.
- No messages corresponding to the applied filters were sent within the date range specified.
Outbound
The outbound messages for the specified filter selections will be displayed in the Sent (outbound) tab. You can add or remove columns from the Columns dropdown list depending on your preferences:
Available columns for the outbound table are as follows:
- Timestamp - gateway timestamp of message processing time
- From - source number
- To - destination number
- Format - message type
- Message - message content
- Status - message status
- DeliveredTimestamp - carrier returned delivered timestamp
- ReasonDescription - message status description
- ReasonCode - message status code
- Units - number of units consumed per message
- Account ID - unique identifier of account
- Message ID - unique message identifier returned from messaging gateway
- Destination Country - destination country of recipient
- Source Country - source country of sender
- BroadcastId - unique identifier of broadcast
- BroadcastName - name of broadcast
- UserId - unique identifier of sending user
- UserName - label and address of sending user
Inbound
Inbound messages for the specified filter selections are displayed in the Received (inbound) tab. Like the Outbound message table, you can configure the Inbound table columns as well.
Available columns for the inbound table are as follows:
- Timestamp - gateway timestamp of message processing time
- From - source number
- To - destination number
- Message - message content
- Account ID - receiving account
- Outbound Message ID - unique message identifier assigned to the original outbound message by the messaging gateway
- Inbound Message ID - unique message identifier assigned to the inbound message by the messaging gateway
- Format - format of the message
- Source Country - the originating country of the inbound message
- Destination Country - the destination country of the inbound message
- Broadcast ID - unique identifier of outbound message broadcast
- BroadcastName - name of broadcast
- UserId - unique identifier of sending user
- UserName - label and address of sending user
Messages vs Units
When viewing reports we display the outbound message content and also detail the number of units used:
Outbound messages
The number of messages which have been sent within the specified date range. One message may be made up of several message parts (depending on the length of the message), but will be received as a single message on the recipient's handset.
Units used
Units (also referred to as message parts and billing units) are the number of message parts that have been sent within the specified date range. One message can be made up of multiple message parts (units) when a message exceeds 160 characters (GSM charset). So a message of 161 characters will equate to 2 units. For multipart messages, the units are then calculated in blocks of 153 to allow for concatenation (so the message is displayed as one long message on the recipient's handset).
If you include any non-GSM character in your message the character limit is reduced to 70 for the first message and blocks of 67 for multipart messages.