AT&T Network Performance API

The Network Performance Monitoring API enables device-specific (User Endpoint) RAN (Radio Access Network) performance metrics to be made available to developers and applications from AT&T customers.

To read more about the API, please visit the product documentation.

Please note that this API is not currently publicly available. If you wish to get access, please contact our sales or support team using this form.

Download OpenAPI Specification
Available Operations

List or find PerformanceMeasurement objects

This operation will list or find PerformanceMeasurement entities.

gethttps://networkperformance.gw.cloud.att.com/api/1.0/performanceMeasurement

Query Parameters

fields
string

Comma-separated properties to be provided in the response.

offset
integer

Requested index for start of resources to be provided in the response.

limit
integer

Requested number of resources to be provided in the response.

Responses
Content Type
application/json

Successful operation

Header Parameters
X-Total-Count
integer
Total number of items matching criteria.
X-Result-Count
integer
Actual number of items returned in the response body.
array
id
string

Unique identifier.

href
string

Hyperlink reference.

description
string

A free-text description of the performance measurement.

indicatorCategory
string

A category of the measurement. (e.g. different SDOs may be using different categories)

indicatorName
string

A word, term, or phrase by which a measurement is known and distinguished from other performance measurements.

indicatorType
string

This attribute indicates different forms in which the measurement data can be captured. (please see details below)

indicatorUnit
string

The unit of the measurement. (e.g. second, bytes, Celsius, etc.)

observedValue
string

The measurement value.

measurementCollectionJob
object
id
string
Required

Unique identifier.

href
string

Hyperlink reference.

name
string

Name of the related entity.

@baseType
string

When sub-classing, this defines the super-class.

@schemaLocation
string

A URI to a JSON-Schema file that defines additional attributes and relationships.

@type
string

When sub-classing, this defines the sub-class extensible name.

@referredType
string

The actual type of the target instance when needed for disambiguation.

performanceIndicatorSpecification
object

PerformanceIndicatorSpecification reference is a detailed description of a tangible or intangible object made available externally in the form of a PerformanceIndicatorSpecification to customers or other parties playing a party role.

id
string
Required

Unique identifier.

href
string

Hyperlink reference.

name
string

Name of the related entity.

version
string

Version of the performance indicator specification.

@baseType
string

When sub-classing, this defines the super-class.

@schemaLocation
string

A URI to a JSON-Schema file that defines additional attributes and relationships.

@type
string

When sub-classing, this defines the sub-class extensible name.

@referredType
string

The actual type of the target instance when needed for disambiguation.

reportingSystem
object
id
string
Required

Unique identifier.

href
string

Hyperlink reference.

name
string

Name of the related entity.

@baseType
string

When sub-classing, this defines the super-class.

@schemaLocation
string

A URI to a JSON-Schema file that defines additional attributes and relationships.

@type
string

When sub-classing, this defines the sub-class extensible name.

@referredType
string

The actual type of the target instance when needed for disambiguation.

sourceSystem
object
id
string
Required

Unique identifier.

href
string

Hyperlink reference.

name
string

Name of the related entity.

@baseType
string

When sub-classing, this defines the super-class.

@schemaLocation
string

A URI to a JSON-Schema file that defines additional attributes and relationships.

@type
string

When sub-classing, this defines the sub-class extensible name.

@referredType
string

The actual type of the target instance when needed for disambiguation.

validFor
object

A period of time, either as a deadline (endDateTime only), a startDateTime only, or both.

endDateTime
string(date-time)
example{ "strict": false, "value": "1985-04-12T23:20:50.52Z" }

End of the time period, using IETF RFC3339 format.

startDateTime
string(date-time)
example{ "strict": false, "value": "1985-04-12T23:20:50.52Z" }

Start of the time period, using IETF RFC3339 format.

@baseType
string

When sub-classing, this defines the super-class.

@schemaLocation
string

A URI to a JSON-Schema file that defines additional attributes and relationships.

@type
string

When sub-classing, this defines the sub-class extensible name.

Example Response

[
   {
      "id": "string",
      "href": "string",
      "description": "string",
      "indicatorCategory": "string",
      "indicatorName": "string",
      "indicatorType": "string",
      "indicatorUnit": "string",
      "observedValue": "string",
      "measurementCollectionJob": {
         "id": "string",
         "href": "string",
         "name": "string",
         "@baseType": "string",
         "@schemaLocation": "string",
         "@type": "string",
         "@referredType": "string"
      },
      "performanceIndicatorSpecification": {
         "id": "string",
         "href": "string",
         "name": "string",
         "version": "string",
         "@baseType": "string",
         "@schemaLocation": "string",
         "@type": "string",
         "@referredType": "string"
      },
      "reportingSystem": {
         "id": "string",
         "href": "string",
         "name": "string",
         "@baseType": "string",
         "@schemaLocation": "string",
         "@type": "string",
         "@referredType": "string"
      },
      "sourceSystem": {
         "id": "string",
         "href": "string",
         "name": "string",
         "@baseType": "string",
         "@schemaLocation": "string",
         "@type": "string",
         "@referredType": "string"
      },
      "validFor": {
         "endDateTime": {
            "strict": false,
            "value": "1985-04-12T23:20:50.52Z"
         },
         "startDateTime": {
            "strict": false,
            "value": "1985-04-12T23:20:50.52Z"
         }
      },
      "@baseType": "string",
      "@schemaLocation": "string",
      "@type": "string"
   }
]

List or find PerformanceIndicatorSpecification objects.

This operation will list or find PerformanceIndicatorSpecification entities.

gethttps://networkperformance.gw.cloud.att.com/api/1.0/performanceIndicatorSpecification

Query Parameters

fields
string

Comma-separated properties to be provided in response.

offset
integer

Requested index for start of resources to be provided in response.

limit
integer

Requested number of resources to be provided in response.

Responses
Content Type
application/json

Success

Header Parameters
X-Total-Count
integer
Total number of items matching criteria.
X-Result-Count
integer
Actual number of items returned in the response body.
array
id
string

A unique identifier for the PerformanceIndicatorSpecification.

href
string

Hyperlink reference.

derivationAlgorithm
string

A step-by-step procedure used to calculate the value of PerformanceIndicator.

derivationMethod
string

For simple calculations, the method used to calculate the value of a PerformanceIndicator, such as average, minimum, maximum, sum and so forth.

description
string

A narrative that explains in detail what the PerformanceIndicatorSpecification is.

indicatorCategory
string

A grouping or set of PerformanceIndicatorSpecifications that are classified together because of common characteristics, such as technology specific, service specific, or technology/service independent.

indicatorUnit
string

The unit by which the indicator is measured. For example, seconds, KBs, rate per second, etc.

name
string

A word, term, or phrase by which a PerformanceIndicatorSpecification is known and distinguished from other PerformanceIndicatorSpecifications.

perspective
string

The point of view for the PerformanceIndicatorSpecification, such as a single user instance or aggregation.

collectionType
string

This is enumeration for CollectionType state.

Must be one of:cumulativedeltadiscrete_eventgaugestatus_inspection
indicatorType
string

This is enumeration for Indicator type.

Must be one of:stringintfloatdouble
performanceIndicatorSpecRelationship
array
id
string

Unique identifier of the target specification.

href
string

Hyperlink reference to the target specification.

name
string

Name of the targetcharacteristic

relationshipType
string
Required
role
string

The association role for this service specification.

validFor
object
Required

A period of time, either as a deadline (endDateTime only), a startDateTime only, or both.

endDateTime
string(date-time)
example{ "strict": false, "value": "1985-04-12T23:20:50.52Z" }

End of the time period, using IETF RFC3339 format.

startDateTime
string(date-time)
example{ "strict": false, "value": "1985-04-12T23:20:50.52Z" }

Start of the time period, using IETF RFC3339 format.

@baseType
string

When sub-classing, this defines the super-class.

@schemaLocation
string

A URI to a JSON-Schema file that defines additional attributes and relationships.

@type
string

When sub-classing, this defines the sub-class extensible name.

validFor
object

A period of time, either as a deadline (endDateTime only), a startDateTime only, or both.

endDateTime
string(date-time)
example{ "strict": false, "value": "1985-04-12T23:20:50.52Z" }

End of the time period, using IETF RFC3339 format.

startDateTime
string(date-time)
example{ "strict": false, "value": "1985-04-12T23:20:50.52Z" }

Start of the time period, using IETF RFC3339 format.

@baseType
string

When sub-classing, this defines the super-class.

@schemaLocation
string

A URI to a JSON-Schema file that defines additional attributes and relationships.

@type
string

When sub-classing, this defines the sub-class extensible name.

Example Response

[
   {
      "id": "string",
      "href": "string",
      "derivationAlgorithm": "string",
      "derivationMethod": "string",
      "description": "string",
      "indicatorCategory": "string",
      "indicatorUnit": "string",
      "name": "string",
      "perspective": "string",
      "collectionType": "cumulative",
      "indicatorType": "string",
      "performanceIndicatorSpecRelationship": [
         {
            "id": "string",
            "href": "string",
            "name": "string",
            "relationshipType": "string",
            "role": "string",
            "validFor": {
               "endDateTime": {
                  "strict": false,
                  "value": "1985-04-12T23:20:50.52Z"
               },
               "startDateTime": {
                  "strict": false,
                  "value": "1985-04-12T23:20:50.52Z"
               }
            },
            "@baseType": "string",
            "@schemaLocation": "string",
            "@type": "string"
         }
      ],
      "validFor": {
         "endDateTime": {
            "strict": false,
            "value": "1985-04-12T23:20:50.52Z"
         },
         "startDateTime": {
            "strict": false,
            "value": "1985-04-12T23:20:50.52Z"
         }
      },
      "@baseType": "string",
      "@schemaLocation": "string",
      "@type": "string"
   }
]