SMS 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

Accepted Date

Description

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

Field

While not a required field, you'll need the Accepted Date field if you want to look at messaging patterns across a given time period.

If included, messages are grouped by one of:

  • 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

Filter

The options are:

  • Predefined — select a predefined choice. Weeks are Sunday to Saturday, and Months are the calendar months.
  • Rolling — select the type of time period (e.g. Weeks) 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.
  • Custom Range — select a date range.

When creating a scheduled report, use either the predefined or the rolling option, as these adjust for each run of the report to show data relative to the run time.

Account ID

Description

The unique ID 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 Name in the report.

Field

Include if your business is using multiple accounts, particularly if your business units use different accounts that you will need to report on.

Filter

Select one or more of your accounts to filter the report by.

Account Name

Description

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.

Field

Include if your business is using multiple accounts (particularly to split out reporting).

Filter

Select one or more of your accounts to filter the report by.

Country Code Alpha-2

Description

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.

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 alternatively use Country Name, which lists the full name of the country or region.

Field

Include this field if you send messages to multiple countries, and you want to look for any messaging issues by country, or reconcile what has occurred by region.

Filter

You can filter by one or more countries.

Country Data  

Country Name

Description

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 alternatively use Country Code Alpha-2, which is the two-letter code for a country or region.

Field

Include this field if you send messages to multiple countries, and you want to look for any messaging issues by country, or reconcile what has occurred by region.

Filter

You can filter by one or more countries.

Delivery Receipt Code

Description

A number that identifies the current or final delivery state of a message. Examples include:

  • 0 (Message sent)
  • 4 (Message delivered)
  • 811 (Message Delivery Error - Message expired )

For the Global SMS API (v4), see Delivery Receipt Codes and Troubleshooting.

For the version 3 SMS APIs, see Response and Delivery Receipt Codes for SMS Version 3 API.

You can alternatively use Delivery Receipt Description in the report.

Field

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.

Filter

Choose one or more codes to filter the report by. For example, to see the messages that did not reach the end user's handset due to a specific issue.

Delivery Receipt Description

Description

A description of the current or final delivery status of a message. The number indicates the delivery receipt code. Examples include:

  • Message sent (0)
  • Message delivered (4)
  • Message Delivery Error - Message expired (811)

You can alternatively use Delivery Receipt Code in the report.

Field

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.

Filter

Choose one or more codes to filter the report by. For example, to see the messages that did not reach the end user's handset due to a specific issue.

Failure Rate

Description

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.

Field

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.

Filter

Choose from 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

Message Direction

Description

Indicates whether the message was sent from your account or from an end user:

  • MT — message from your account
  • MO — message from end user

Field

Include this field to split the message traffic into messages you sent versus received. Without it, we will include traffic in both directions in the same row of the report. Alternatively, you may want to filter by direction for your reports.

Filter

Use this to create a report for just your messages sent (or alternatively messages received).

Message Originator

Description

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).

Field

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.

Filter

Create a report for one or more message originators. 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 (e.g. press "Enter" between each number).

Message Status

Description

Provides the current or final delivery status of a message. Possible values 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.

Field

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.

Filter

Use this to filter a report for Delivered, Awaiting Report, or Failed messages.

Mobile Operator ID

Description

The OpenMarket ID for the mobile operator associated with the end user's phone number. This is always a number, such as 383 for AT&T, and 348 for T-Mobile in the UK.

If we do not know the operator for the phone number, we return the value -1.

You can alternatively use Mobile Operator Name in the report.

Field

Use this field if you want to see the operators your end user's are connected to.

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

Filter

Select one or more operators to filter your report by. This can be useful for troubleshooting high message failures with a specific operator — include the delivery receipt code in the report.

Mobile Operator Name

Description

The name of the mobile operator associated with the end user's phone number.

If we do not know the operator for the phone number, we return the value unknown.

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.

Field

Use this field if you want to see the operators your end user's are connected to.

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

Filter

Select one or more operators to filter your report by. This can be useful for troubleshooting high message failures with a specific operator — include the delivery receipt code in the report.

Product Name

Description

Whether the message was sent as a global one-way or two-way message.

If you're using our Global SMS (v4) 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.

Field

Useful if you need to reconcile your one-way and two-way messaging, particularly if you are using our Global SMS API.

Filter

Filter to see what messaging was one-way or two-way.

Subaccount

Description

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.

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

Field

Include this field if you are grouping messaging programs using subaccount; otherwise, you can ignore this field.

Filter

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. To add multiple subaccount groups, include a line space (e.g. press "Enter" between each number).

Success Rate

Description

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.

Field

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.

Filter

Choose from 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

Messages Accepted (aggregate field)

Description

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

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

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.

Field

Choose Sum to see the sum of messages accepted (you can ignore the None option).

Filter

Choose Sum to see the sum of messages accepted (you can ignore the None option).

Then choose from 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.

Messages Awaiting Report (aggregate field)

Description

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".

Field

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.

Choose Sum to see the sum of messages awaiting report (you can ignore the None option).

Filter

Choose Sum to see the sum of messages awaiting report (you can ignore the None option).

Then choose from 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.

Messages Delivered (aggregate field)

Description

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

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

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.

Field

Choose Sum to see the sum of messages delivered (you can ignore the None option).

Filter

Choose Sum to see the sum of messages delivered (you can ignore the None option).

Then choose from 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.

Messages Failed (aggregate field)

Description

The number of MT messages that were not successfully delivered.

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

Field

Choose Sum to see the sum of messages that failed to reach the end user (you can ignore the None option).

Filter

Choose Sum to see the sum of messages that failed to reach the end user (you can ignore the None option).

Then choose from 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.

Operator Lookups (aggregate field)

Description

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.

Field

Useful if you want to see the lookups, particularly by location. Choose Sum to see the sum of lookups (you can ignore the None option).

Filter

Choose Sum to see the sum of lookups (you can ignore the None option).

Then choose from 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.