The 5G Mobile Edge Compute (MEC) Performance API

This API returns  the most recent data for different KPI e.g. network availability, MEC hostnames, An estimate of the Downlink data throughput, An estimate of the Uplink data throughput,E-Utran New Radio Dual Connectivity Duration is the rate of data which data was sent on a connected 5G gNB node,Downlink retransmission rate of the packets that were resent, Uplink retransmission rate of the packets that were resent,Downlink retransmission volume is a count of the packets that were resent,Uplink retransmission volume is a count of the packets that were resent,Server Round Trip Time is a measurement of the latency during TCP handshake in MS sent from the SGW (Serving Gateway) to the MEC Host,Client Round Trip Time is a measurement of the latency during TCP handshake in MS sent from the UE (User Equipment) to the SGW (Serving Gateway),Total Round Trip Time is the measurement of the latency during TCP handshake in MS from the UE (User Equipment) to the MEC Host.

Query for the latest network performance information

Query the most recent data for Key Performance Indicators (KPIs) like network availability, MEC hostnames and more.

HTTP Request

 

POST https://5gedge.verizon.com/api/mec/performance/device/network/metrics
 

 

HEADER PARAMETERS: application/json

For more information about getting these tokens, please refer to the page: "Getting Tokens for the Performance API".

The request header must contain the following:

  • Header
    required
    schema

    Content-Type: application/json

    Authorization: Bearer BEARER_TOKEN (Thingspace oauth token From Step 1)

    VZ-M2M-Token: M2MToken (UWS token from step 2)

QUERY PARAMETERS: application/json

Query performance KPIs

  • Example request
    schema
    curl --location --request POST 'https://5gedge.verizon.com/api/mec/performance/device/network/metrics' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer {token}' \
    --header 'VZ-M2M-Token: {M2Mtoken}'
    --header ‘Cookie: mdp-ingress-route-staging={ID number for cookie}’ \
    --data-raw ‘{
       “IMEI”: "15-digit string"   
       “MSISDN”: "12-digit string",
    }
    ‘
    
    
    
    

PATH PARAMETERS: application/json

None

 

REQUEST BODY: application/json

{
  "IMEI": "440246108109673",
  "MSISDN": "10691876598"
}
Request Parameters
 
Parameter Description
IMEI The 15-digit International Mobile Equipment Identifier.
MSISDN The 12-digit Mobile Station International Subscriber Directory Number.

Responses

Note: For cases where user input exceeds the boundary values an additional "data" key will be returned with a relevant description. The error response returns an additional data key value beyond the error values listed here. 

 

RESPONSE BODY SCHEMA: application/json

  • Success response
    object
    {
       "QueryStatus": "Success",
       "Start": "2021-04-23T12:45:00",
       "End": "2021-04-23T13:00:00",
       "QueryResult": [
          {
             "name": "MecHosts",
             "data": [
                [
                   "ANJTMDAH-MEC-AWS-EC2-1"
                ],
                null,
                null
             ]
          },
          {
             "name": "NetworkAvailability",
             "data": [
                100,
                %,
                "High"
             ]
          },
          {
             "name": "RateOfDataOnConnected5GnbNode",
             "data": [
                "75",
                %,
                "high"
             ]
          },
          {
             "name": "EstimatedDownlinkThroughput",
             "data": [
                "653.9173553719007",
                "mbps",
                "poor"
             ]
          },
          {
             "name": "EstimatedUplinkThroughput",
             "data": [
                "1084.814625896979",
                "mbps",
                "poor"
             ]
          },
          {
             "name": "DownlinkPacketRetransmissionRate",
             "data": [
                "0.021755519655358106",
                "%",
                "poor"
             ]
          },
          {
             "name": "UplinkPacketRetransmissionRate",
             "data": [
                "1.0",
                "%",
                "poor"
             ]
          },
          {
             "name": "DownlinkPacketRetransmissionCount",
             "data": [
                "202.0",
                "megabits",
                poor
             ]
          },
          {
             "name": "UplinkPacketRetransmissionCount",
             "data": [
                "26394.0",
                "megabits",
                poor
             ]
          },
          {
             "name": "ClientRoundTripLatencyTCP",
             "data": [
                "40.333333333333336",
                "msec",
                "fair"
             ]
          },
          {
             "name": "ServerRoundTripLatencyTCP",
             "data": [
                "63.666666666666664",
                "msec",
                "fair"
             ]
          },
          {
             "name": "TotalRoundTripLatencyTCP",
             "data": [
                "104.0",
                "msec",
                "fair"
             ]
          }
       ]
    }
    
Response Parameters

Parameter

good

(Green)

fair

(Yellow)

poor

(Red)

Unit

QueryStatus

Success

N/A

Failed

N/A

Start

N/A

N/A

N/A

Timestamp of the query's start

format:
mm/dd/yyyy

hr:min:sec

End

N/A

N/A

N/A

Timestamp of the query's end

format:
mm/dd/yyyy

hr:min:sec

mecnames

N/A

N/A

N/A

Name of the 5G MEC host that was polled

Network Availability >90 N/A <90 percent

EstimatedUplinkThroughput

>5000

N/A

<5000

Megabits per second

EstimatedDownlinkThroughput

>20000

N/A

<20000

Megabits per second

RateOfDataOnConnected5GnbNode

< 85

N/A

> 85

percent

UplinkPacketRetransmissionRate

< 2

N/A

> 2

percent

DownlinkPacketRetransmissionRate

< 2

N/A

> 2

percent

UplinkPacketRetransmissionCount

N/A

N/A

N/A

megabits

DownlinkPacketRetransmissionCount

N/A

N/A

N/A

megabits

ServerRoundTripLatencyTCP

< 30

> 30 & 

< 100

> 100

milliseconds

ClientRoundTripLatencyTCP

< 30

> 30 & 

< 100

> 100

milliseconds

TotalRoundTripLatencyTCP

< 60

> 60 & 

< 200

> 200

milliseconds

RESPONSE BODY SCHEMA: application/json

  • status
    string

    HTTP status code

  • message
    string

    Error details

RESPONSE BODY SCHEMA: application/json

  • status
    string

    HTTP status code

  • message
    string

    Error details

RESPONSE BODY SCHEMA: application/json

  • status
    string

    HTTP status code

  • message
    string

    Error details

RESPONSE BODY SCHEMA: application/json

  • status
    string

    HTTP status code

  • message
    string

    Error details

RESPONSE BODY SCHEMA: application/json

  • status
    string

    HTTP status code

  • message
    string

    Error details