Dashboards & Reporting

SMS Summary

This data source provides summary-level information about both MT and MO SMS messages. You can compare the messages you send against the messages delivered or failed, and the data source can calculate this as success and failure rates. You can investigate why messages failed by looking at the delivery receipt codes by mobile operator and country. Lastly, you can filter the reports by message originator, time, mobile operator, country, etc.

The data source contains data for two years prior to the current date. The maximum date range supported is 403 days.

Standard reports

Standard reports were designed by OpenMarket as a set of default scheduled reports useful to most businesses. The SMS Summary is the source for these standard reports: 

  • SMS Monthly Summary - 13 months
  • SMS Daily Summary - This Month
  • SMS Daily Summary - Last Month

Your ability to access these reports depends on whether your OpenMarket account manager has provisioned them for your company, and whether your organization's administrator has either shared the reports with you or given you access to the SMS Summary data source. If you have access to the data source then you can add the standard reports to your folders. If the reports are shared with you then you have either Can View or Can Edit access.

Custom reports

Custom reports are one-time and scheduled reports that you create yourself. You can use this data source to create custom reports; for example:

Quick tips

Some helpful tips for when using this data source are:

  • If you want a high-level view of message delivery, use Message Status; if you want to investigate why messages failed, use Delivery Receipt Code (or Delivery Receipt Description).

  • For most use cases you'll want to include Message Direction as it separates out MO traffic from MT traffic.

  • The Success Rate and Failure Rate fields ignore any messages where we are still "awaiting report". As well, if you include either field, you'll see that additional aggregate fields are automatically added to the report, so as to calculate the values.

  • Message Originator refers to your short codes, VMNs, etc, through which you send and receive messages. It never refers to an end user's number.

When using this data source, the following fields report similar information and you might want to include only one of them:

  • Country Name shows the full name and Country Code Alpha-2 shows a two letter abbreviation.

  • Delivery Receipt Codes is the code number and delivery Receipt Description is a text description. If you need to check the report against the delivery receipts you've received from OpenMarket, the easiest thing to use is Delivery Receipt Codes.

  • Account Name and Account ID are linked unique identifiers, so you only need to include the field that suits you. If you want to see what the possible values for either field, then:

    1. Add them as filters
    2. Use the drop-down to check the field values (and remove the filters when ready)

Note: If you are filtering the report by a dialable message originator or the end user's phone number, then you need to make sure you supply the number in international format; e.g. with the country code included. For example: 12515550100 (US number) or 447700900750 (UK number). Don't include a "+" character. This doesn't apply to short codes, which you should enter as is.

Fields and Filters

The following table describes the SMS Summary Data Source fields and filters. Click any field you want to add to the report, and in the Alias field enter a new name for the column. If you do not assign an alias to the field, the default column name is used.

SMS Summary Data Source Fields and Filters

Parameter

Description

Accepted Date

The time and date (in UTC) when we accepted a valid message request from your account or from a mobile operator.

While not required fields, we recommend adding the Accepted Date, Delivered Date and Updated Date fields as they are useful in analyzing an SMS message's history. If included, you can select to group messages by:

  • Second — this is the default value.
  • Minute
  • 15 Minutes
  • 30 Minutes
  • Hour
  • Day — as per the UTC
  • Week — this is Sundays to Saturdays
  • Month — each calendar month
  • Quarter — The quarters are: January-March, April-June, July-September, October-December
  • Year — year by 1st of January until 31st of December

Filterable? Yes. When used as a filter, it is always required.

You can filter the report by the following:

  • Predefined — select a predefined choice. This can be either Today, Yesterday, This Week, Last Week, This Month, or Last Month; however remember that the maximum date range is restricted to 2 days for this report (as set in the Accepted Date filter)
  • Rolling — select the type of time period (e.g. Hours) and how many units of that time you want included in the report. For example, "5 Hours" will create a report that, when run, includes the last 5 hours data.
  • Equals — select a specific date by clicking the calendar icon, or by entering the date using a yyyy/mm/dd format.
  • Custom Range — select a date range; however, remember that the maximum data range is 2 days for this report.

When creating a scheduled report, use either the Predefined or the Rolling options as these adjust for each run of the report to show data relative to the run time.

Account ID

The unique ID of an account you have with OpenMarket. Depending on your business requirements, you may have multiple accounts to send RCS messages. You can alternatively use Account Name in the report. Include if your business is using multiple accounts, particularly if your business units use different accounts that you will need to report on.


Filterable? Yes. Enter one or more account IDs on which to filter. From the drop-down list, enter the account ID, and then select it from the list. Search and add additional account IDs as needed. A tally keeps track of the number of IDs added to the filter. Alternately, you can filter on Account Name.

Account Name

The unique name of an account you have with OpenMarket. Depending on your business requirements, you may have multiple accounts to send and receive SMS messages.

You can alternatively use Account ID in the report. Include if your business is using multiple accounts, particularly if your business units use different accounts that you will need to report on.


Filterable? Yes. Enter one or more account names on which to filter. From the drop-down list, enter the account name, and then select it from the list. Search and add additional account names as needed. A tally keeps track of the number of account names added to the filter. Alternately, you can filter on Account ID.

API Version

This field is left blank for MO messages. This is useful in custom reports only if you are currently using multiple OpenMarket APIs (e.g. both the version 3 or version 4 options), or are transitioning from one API to another (e.g. from the legacy UK APIs to version 4).


Filterable? Yes. Enter one or more API versions on which to filter. From the drop-down list, enter the API version, and then select it from the list.A tally keeps track of the number of API versions added to the filter. API version filters are:

  • VERSION_4 — Our HTTP Global SMS API
  • VERSION_4_SMPP — Our SMPP Global SMS API
  • US_VERSION_3 — Our version 3 HTTP SMS API
  • US_VERSION_3_SMPP — Our version 3 SMPP API
  • UKGW — The legacy UK APIs (HTTP and SMPP options)
Company ID

The identifier of the company that sent and/or received the message.


Filterable? Yes. Enter one or more company IDs on which to filter. From the drop-down list, enter the company ID, and then select it from the list. Search and add additional company IDs as needed. A tally keeps track of the number of IDs added to the filter. Alternately, you can filter on Company Name.

Company Name

The name of the company that sent and/or received the message.


Filterable? Yes. Enter the full company name by which to filter. Alternately, you can filter on Company ID.

Country Code Alpha-2

The two-letter code that identifies the country or region. For example, AU (Australia) or CA (Canada). You can find a list of the codes on Wikipedia.

  • For MTs, this is the country of the destination
  • For MOs, this is the country of the originator

The value ## means that we were not sent the country details back from the mobile operator (most operators include this and other details in the delivery receipt they send us). It is not linked to the delivery status of the message.

You can alternately use the Country Name, which lists the full name of the country or region.


Filterable? Yes. You can filter by one or more country alpha codes. From the drop-down list, enter or search for the country code then select it. As you select country codes, a tally keeps track of the number of country codes added to the filter.

Country Name

The name of the country in which the end user's phone number is registered.

The value unknown means that we were not sent the country details back from the mobile operator (most operators include this and other details in the delivery receipt they send us). It is not linked to the delivery status of the message.

You can alternately use the Country Code, which is the two-letter code for a country or region.


Filterable? Yes. You can filter by one or more country names. From the drop-down list, enter or search for the country name, and then select it. As you select country names, a tally keeps track of the number of country names added to the filter.

Delivery Receipt Code

A code number and message that identifies the current or final delivery state of a message. If you want a high-level view of message delivery, use Message Status.


Filterable? Yes. Use this to look at the specific delivery issues you may have had, as it provides a granular breakdown of issues that is useful for troubleshooting.

Codes can differ between API versions. See the following:

Alternately, you can filter by Delivery Receipt Description. You can filter by one or more codes. From the drop-down list, enter or search for the code then select it. As you select codes, a tally keeps track of the number of codes added to the filter.

Delivery Receipt Description

Use this to look at the specific delivery issues you may have had, as it provides a granular breakdown of issues that is useful for troubleshooting. If you want a high-level view of message delivery, use Message Status.


Filterable? Yes.

Codes can differ between API versions. See the following:

Alternately, you can filter by Delivery Receipt Code. You can filter by one or more descriptions. From the drop-down list, enter or search for the description, and then select it. As you select descriptions, a tally keeps track of the number of descriptions added to the filter.

Failure Rate

The percentage of messages that failed to be delivered. It does not include messages for which we are awaiting a status from the mobile operator. This is calculated by dividing the number of messages failed by the number accepted and multiplying by 100.

Use this field to see whether failure rates changed over time, or were influenced by mobile operator or country.

This field is calculated using other fields, which means that the report also needs the Messages Failed and Messages Accepted fields. These are automatically included if you select Failure Rate.

Filterable?: No.

Message Direction

Indicates whether the message was sent from your account or from an end user. Useful to quickly determine the direction of the message, particularly if you are using Message Originator and Phone Number in the report (and do not include Destination Address or Sender Address, which indicate direction).


Filterable? Yes. You can select one or both of:

  • MT — for filtering on messages sent from your account
  • MO — for filtering on messages sent from an end user

Message Originator

The source number used to send an MT message or receive an MO message. Types of originators include short codes, text-enabled landlines, toll-free numbers, alphanumeric strings, and virtual mobile numbers (long codes).


Filterable? Yes. Multiple values are supported. This is a free-text field, so you will need to know your originators before using this filter. To add multiple originators, include a line space between each number—that is, press the Enter key after adding each number so that each number is on its own line. Use this to split the message traffic by your message originators. You can use this in conjunction with the Message Direction field to see the messages coming from and to that originator.

Message Status

Provides the current or final delivery status of a message. Use this if you want a high-level view of message delivery. This is in comparison to using the delivery receipt code, which provides a more granular breakdown of delivery issues and is more suited to specific troubleshooting.


Filterable? Yes. Filters are:

  • Delivered — the message was successfully delivered
  • Awaiting Report — we forwarded the message to the operator, however we have not received a delivery receipt yet
  • Failed — the message was not delivered. The delivery receipt code will identify the reason the message failed.
  • Accepted — the message was accepted by the operator
  • Rejected — the message was rejected by the operator after the number of retries was exhausted
  • Expired — the message could not be delivered during the set validity period
  • Retrying — the message has not yet been delivered, but retries are being attempted
  • Unknown — the status of the message cannot be determined for some reason

You can select one or more statuses on which to filter. As you select statuses to add, a tally keeps track of the number of statuses added to the filter.

Mobile Operator ID

Use this field if you want to see the operators your end users are connected to, organized by mobile operator ID. This can be useful for troubleshooting high message failures with a specific operator — include the delivery receipt code in the report.

Note, however, that this does not always indicate the operator that we directly sent the messages to; some messages are sent off-net—for example, using a related operator in the same region—or in more remote locations, by a high-quality route.


Filterable?: Yes.

This is always a number, such as 383 for AT&T, and 348 for T-Mobile in the UK. For the US, if the operator is unknown, we return a value of 0. For the rest of the world, an unknown operator is returned as -1.

Select one ore more mobile operators to add to the filter. As you select operators, a tally keeps track of the number of operators added to the filter.

You can alternatively use Mobile Operator Name in the report.

Mobile Operator Name

Use this field if you want to see the operators your end users are connected to, organized by mobile operator name. This can be useful for troubleshooting high message failures with a specific operator — include the delivery receipt code in the report.

Note, however, that this does not always indicate the operator that we directly sent the messages to; some messages are sent off-net—for example, using a related operator in the same region—or in more remote locations, by a high-quality route.


Filterable? Yes.

This filter list organizes mobile operators by name, followed by their country of operation and mobile operator ID.

If the operator is in the US, and unknown, we return a value of unknown (US, 0). For the rest of the world, this is returned as unknown (null ,-1)

Select one ore more mobile operators to add to the filter. As you select operators, a tally keeps track of the number of operators added to the filter.

You can alternatively use Mobile Operator ID in the report, particularly if you need to compare this report to information OpenMarket returns in our API responses.

Product Name

This indicates whether or not the sent message was a global one-way or two-way message. This is useful if you need to reconcile your one-way and two-way messaging, particularly if you are using our HTTP Global SMS API.

If you're using our HTTP Global SMS API, you can specify whether a message is one-way or two-way in your request, using "interaction". If you don't specify this, or if you're using another API version or another product, then OpenMarket determines the product based on the message originator you used to send the message, and what region the message was sent to.

Note that all US and Canadian messaging is two-way.

For MO messages, the value is always two-way.


Filterable?: Yes. Filters are:

  • One Way
  • Two Way
  • Unknown

MO messages are included in the two-way data, so if you want only MT or MO messages in the report, filter by Message Direction.

Subaccount

This field is only populated if you are using the UK SMS API (also known as the MX API). It contains information included in the MT message request. This value is filterable, so that you can group your messages in Dashboards & Reporting using your own campaign or program identifiers. It has no effect on the message or its delivery. Include this field if you are grouping messaging programs using subaccount; otherwise, you can ignore this field.

Do not use subaccount for individual identifiers, such as "ticket" or "transaction" IDs.


Filterable?: Yes. Use to filter the report by one or more of your subaccount groups. This is a free-text field, so you'll need to know the possible values you have sent with your messages. You can filter on multiple subaccounts. Each subaccount must be on its own line—that is, press the Enter key after adding each subaccount.

Success Rate

The percentage of messages that were successfully delivered. This is calculated by dividing the number of messages delivered by the number accepted and multiplying by 100.

Use this field to see whether success rates changed over time, or were influenced by mobile operator or country.

This field is calculated using other fields, which means that the report also needs the Messages Deliveredand Messages Accepted fields. These are automatically included if you select Success Rate.

Filterable?: No:

Aggregate fields

Aggregate fields are also filterable fields. When using fields for aggregation, choose Sum to see the sum of the field aggregation requested (you can ignore the None option), and then choose one of the following:

  • Equals — this option selects a specific value. We recommend not using it as a filter
  • Greater Than
  • Greater Than or Equal To
  • Less Than
  • Less Than or Equal To
  • Between — the left-hand value must be lower than the right-hand value

SMS Summary Data Source Aggregate Fields

Parameter

Description

Messages Accepted

The number of message requests that we accepted from your account or the mobile operators.

If you want to see Messages Accepted data split into the messages you sent versus the messages you received, then include Message Direction in your report as a field or a filter.

Messages Awaiting Report

Number of MT messages for which the mobile operator has not yet provided a final delivery status.

In the final report, the default name of the column "Sum of Messages Awaiting Report".

Include this field if your report is from the recent past (within seven days) and you want to differentiate between messages accepted, delivered, and those where the outcome isn't yet finalized. Almost all messages have a final outcome within seven days, so this field isn't useful if the report is set further back in time.

Messages Delivered

The number of MT messages that the mobile operator confirmed as successfully delivered, or the number of MOs sent to the mobile operator.

If you want to see Messages Delivered data split into the messages you sent versus the messages you received, then include Message Direction in your report as a field or a filter.

Messages Failed

The number of MT messages that were not successfully delivered.

Operator Lookups

The number of operator lookups we performed. These lookups identify the country and mobile operator for a phone number.

Note that, unless your request specified the mobile operator, OpenMarket normally performs a lookup. In certain regions (and depending on your contract) you may be charged for these lookups.