Technical Details

The Network Performance Monitoring (NPM) API enables device-specific (User Endpoint) RAN (Radio Access Network) performance metrics to be made available to developers and applications from AT&T customers. The current deployment supports five (5) Key Performance Indicators (KPIs), each of which is per-IMSI and the average value over a 5-minute interval.

Applications may use NPM data to:

  • Study the UE’s performance on the AT&T network.
  • Understand and track usage patterns of different UEs for various planning purposes.
  • Take remedial actions for betterment of device connectivity (e.g., invoke QoS on Demand).
  • Make decisions about automated UE actions, e.g., notification pushes or firmware updates.

The NPM API is available to Internet of Things (IOT) customers, including hyperscalers, SaaS partners, and systems integrators across AT&T's 4G, 5G non-standalone, and 5G standalone mobility networks. This will allow these customers to enhance 5G & LTE applications with near real-time device network performance and guidance.

AuthN/AuthZ

The API is enabled with JSON Web Token (JWT) token security policy and follows the steps below:

  1. Request a JWT token by passing in client application credentials. The acquired JWT token is valid for 3 hours.
  2. Pass the acquired JWT token with-in the HTTP header to request performance measurement data.

For additional details of above steps, please see Generating a JWT.

Entitlement Checks

Besides the JWT security policy mentioned above, the client application is checked for entitlement of the requested device data. If the entitlement check passes, the NPM API returns performance measurement data, otherwise the NPM API returns error code 453 with an error message indicating that the entitlement check failed.

The purpose of entitlement check is to avoid unintended data usage, for example Firstnet data should only be used by Firstnet clients.

API Details

This API is exposed to both AT&T internal customers and external partners. For additional details about internal and external URLs, see Environments and URLs.

In the initial release, this API will support GET operation on the two resources shown below. For required and optional request parameters, see Input Parameters.

  • performanceMeasurement - returns the performance measurement data
  • performanceIndicatorSpecification - returns the a list of indicator specification, for example measurement unit, calculation algorithm etc.

For API error codes and descriptions, see Error Codes.

Further Reading

For more information on the Network Performance Management API, take a look at the following reference document: TMF628 Performance Management API REST Specification.