Partner Center Users

Reporting Insights replaces the current reporting tools for standard rate and bulk SMS that are currently available in Partner Center. Partner Center provides reporting for customers using our UK SMS HTTP or SMPP APIs, as well as MEP customers who are viewing transaction history outside of MEP.

Although Partner Center will continue to be available, we encourage you to switch to Reporting Insights so that you can benefit from: 

  • Graphical Dashboards—visualize your SMS messaging using graphical dashboards; features include simple pie & bar charts, geo-maps, and feature widgets that allow on-screen drill-down or data aging.
  • Custom reports—create on-time and scheduled reports in multiple formats that meet your specific requirements. Filter by sub account, mobile operator, message originator (your short code, etc), success rate, and other included fields.
  • Shared and private data option—you can share the reports and dashboards you create to some or all of your colleagues, or keep them private, if desired.
  • Troubleshooting by delivery report or status—you can create reports and graphs focusing on individual delivery receipt codes (or descriptions), including filtering for the "top 5/10/15/20" issues you're seeing.

Who shouldn't move to Reporting Insights?

If you are a premium-rate SMS customer, you should continue to use Partner Center. If desired, you can view some or all of your traffic via Reporting Insights; however, there is no distinction between premium and non-premium traffic. Reporting Insights does not report on things like the tariffs, number of charge attempts, billing success, or the billed value. All SMS traffic is potentially included in a report; however, you can filter reports by message originator (e.g. short code) to break out your traffic into premium and non-premium.

Also, if you rely on the reports being near-real time (e.g. within 5 minutes), then you will need to continue to use Partner Center for reporting. Reporting Insights provides data that is 30 minutes or older. Note that this ensures that solutions with sensitive and timed data, such as two-factor authentication, have sensitive data (e.g. PINs) withheld until the PINs have timed out.

How to get started

In order to start using Reporting Insights, you'll need to contact your account manager or Support to do the following:

  • Ensure you have user accounts provisioned for Customer Center. Each business user should have an individual account name and password. The account name is commonly the user's email address; e.g. janeuser@example.com.

  • Identify someone in your organization to serve as administrator. We then configure the administrator's account accordingly. (There can be more than one administrator.)

  • Create standard reports for your organization. Your account manager or Support will do this and will store the reports in the administrator's Shared folder.

  • Assign data source permissions to all of your user accounts. Your administrator does this.

  • Share standard reports with your users. Your administrator does this.

Logging in

Once you have a Customer Center account, you can log in here:

From the navigation menu, select Reporting, and then Reporting Insights.

Screenshot of the Customer Center home page

You'll see a page similar to the one shown below. Your My Folder will be empty (because you haven't created anything yet), but Shared should have a folder named after your company that contains your standard reports. Your OpenMarket account manager may also have created a starter dashboard for you, in which case you'll see that as well.

A Dashboards & Reporting screenshot showing an SMS Summary Report

Differences in data fields

The data sources available in Reporting and Dashboards are optimised for Global SMS messaging, and in particular uses terms and values linked to our Global SMS API. This means that there are some new field options, some name differences, and different values you might see.

This is a summary of both the SMS Summary and SMS Detailed data source fields that you will need to know about. Note that there are two sets of data that will be different from what you're used to:

  • Delivery Receipt Codes and Descriptions—the numbers and descriptions use our Global set, found in the Global SMS API information.
  • Mobile Operator IDs (a.k.a. Network Codes)—the codes used are in our API Reference. For details on what the mobile operator ID is for each MX network code, see Network Codes (UK SMS).

One last point is that smsid is replaced in these data sources by Ticket ID; e.g. Ticket ID is not a Support ticket ID.

Note: The standard reports normally include all the fields available from a data source. However, when creating custom reports, almost all fields and filters are optional!

Fields and Filters

Description

Accepted Date

Delivered Date

Updated Date

These refer to the time and date (in UTC) when we accepted, delivered, or last updated the status of a MT or MO message.

Account ID

and

Account Name

These are linked account identifiers for your messaging. Account Name will show the account identifier names that you are already familiar with in Partner Center.

API Version

For Partner Center users, this will return the value UKGW.

This is useful in custom reports only if you are currently transitioning to a new OpenMarket API.

Content

Content Encoding

User Data Header

These fields/filters are available in reports using the SMS Detailed data source. They provide you with the message contents of the MT or MO message.

Country Code Alpha-2

and

Country Name

These fields/filters are synonymous data, which enable you to create reports for specific regions. The Country Code Alpha-2 is a two-letter abbreviation for a country.

Delivery Receipt Code

and

Delivery Receipt Description

These fields/filters are synonymous data, which identifies the current or final delivery state of a message.

There are some key differences compared to Partner Center:

  • The numbers and descriptions use our Global set, found in the Global SMS API information. We will endeavor to provide a mapping between the UK SMS API hex codes and these codes in the near future. However, as the Delivery Receipt Description is in plain English, you may still find it convenient to begin troubleshooting messages in Reporting Insights reports and widgets.
  • You can filter reports both the SMS Summary and SMS Detailed data sources for specific delivery receipt codes (or descriptions), and create widgets that focus on the top delivery issues you're having. This means you no longer need to download message logs to create your own filtered detail or summary reports.

Destination Address

Destination address refers to the message recipient. For MT messages this is the end user's phone number; for MO messages it is your message originator.

Failure Rate

and

Success Rate

The Success or Failure rate of your messaging. These fields/filters are available to reports that use the SMS Summary data source.

India - Message Purpose Type

As you are using our MEP or UK SMS APIs, you can ignore this field.

Message Direction

This field/filter refers to whether a message was sent from your account (MT) or from an end user (MO).

Message Originator

This is a generic term, replacing "short code" in Partner Center. It refers to your short code, VMN, alphanumeric string, etc, through which your business sends and receives messages.

Message Originator Type

This refers to the "type of number (TON)" of the message originator. It's a value that our customers can set in our other APIs; however, regardless of the API you use, we will always report on the TON. The options are:

  • 1 — any international-format number, such as a virtual mobile number (long code), landline or toll-free number
  • 3 — short code
  • 5 — alphanumeric string

As you are using our MEP or UK SMS APIs, you can choose to ignore this field; however, some customers find it useful to filter reports by certain types of number (e.g. all alphanumeric strings).

Message Status

A field/filter for 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.

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.

Mobile Operator ID

and

Mobile Operator Name

We use the term "mobile operator" to refer to the networks.

Mobile Operator ID is a similar term to a "Network Code". However, we cannot return the codes you may be familiar with from our APIs and MEP. Instead, this is always a number, such as 348 for T-Mobile. For details on what the mobile operator ID is for each MX network code, see Network Codes (UK SMS).

Mobile Operator Name is the full name for the network, which you may prefer to use in reports and widgets.

 

Note 1

This is for customer's using our Global SMS API only.

Note 2

This is synonymous with note in transaction logs, and is available in the SMS Detailed report.

Parent Ticket ID

As you are using our MEP or UK SMS APIs, you can ignore this field.

Phone Number

This is the mobile phone number of an end user.

Product Name

Product Name is similar to the Type field found in some summary reports in Partner Center, which refers (in part) to the messaging route taken. Product Name differs by being a simplified summary of the routing, with only two values: one-way or two-way. The value in the report is influenced by a few factors:

  • The type of message originator you're using—alphanumeric strings are one-way only, while a short code is two-way
  • Your agreement with OpenMarket as to how your messages are routed internationally

Your OpenMarket account manager can advise you if you are unsure whether you need this value in your reports.

Messages Accepted,

Messages Awaiting Report,

Messages Delivered

and

Messages Failed

These are aggregate fields available in the SMS Summary data source.

Important to note is:

  • Messages Accepted and Messages Delivered include both MT and MO traffic
  • Messages Awaiting Report and Messages Failed refer to only MT traffic

Operator Lookups

and

Operator Lookup Flag

Operator Lookups is a synonym for Network Lookups. Both SMS data sources report on whether OpenMarket has performed an operator lookup on your behalf.

Source Address

Source address refers to the message sender. For MT messages it is your message originator; for MO messages this is the end user's phone number.

Sub Account

This is synonymous with the subaccount in the UK SMS APIs and Partner Center reports. It is available in SMS Detailed and SMS Summary reports.

Ticket ID

This term is synonymous with smsid in the UK SMS APIs.

US - Program ID

As you are using our MEP or UK SMS APIs, you can ignore this field.