The 5G MEC Performance API

5G Mobile Edge Compute (MEC) Performance API

This API returns the most recent data for different KPIs.

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
ParameterIMEI	DescriptionThe 15-digit International Mobile Equipment Identifier.
ParameterMSISDN	DescriptionThe 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
Parameter QueryStatus	good (Green) Success	fair (Yellow) N/A	poor (Red) Failed	Unit N/A
Parameter Start	good (Green) N/A	fair (Yellow) N/A	poor (Red) N/A	Unit Timestamp of the query's start format: mm/dd/yyyy hr:min:sec
Parameter End	good (Green) N/A	fair (Yellow) N/A	poor (Red) N/A	Unit Timestamp of the query's end format: mm/dd/yyyy hr:min:sec
Parameter mecnames	good (Green) N/A	fair (Yellow) N/A	poor (Red) N/A	Unit Name of the 5G MEC host that was polled
ParameterNetwork Availability	good (Green)>90	fair (Yellow)N/A	poor (Red)<90	Unitpercent
Parameter EstimatedUplinkThroughput	good (Green) >5000	fair (Yellow) N/A	poor (Red) <5000	Unit Megabits per second
Parameter EstimatedDownlinkThroughput	good (Green) >20000	fair (Yellow) N/A	poor (Red) <20000	Unit Megabits per second
Parameter RateOfDataOnConnected5GnbNode	good (Green) < 85	fair (Yellow) N/A	poor (Red) > 85	Unit percent
Parameter UplinkPacketRetransmissionRate	good (Green) < 2	fair (Yellow) N/A	poor (Red) > 2	Unit percent
Parameter DownlinkPacketRetransmissionRate	good (Green) < 2	fair (Yellow) N/A	poor (Red) > 2	Unit percent
Parameter UplinkPacketRetransmissionCount	good (Green) N/A	fair (Yellow) N/A	poor (Red) N/A	Unit megabits
Parameter DownlinkPacketRetransmissionCount	good (Green) N/A	fair (Yellow) N/A	poor (Red) N/A	Unit megabits
Parameter ServerRoundTripLatencyTCP	good (Green) < 30	fair (Yellow) > 30 & < 100	poor (Red) > 100	Unit milliseconds
Parameter ClientRoundTripLatencyTCP	good (Green) < 30	fair (Yellow) > 30 & < 100	poor (Red) > 100	Unit milliseconds
Parameter TotalRoundTripLatencyTCP	good (Green) < 60	fair (Yellow) > 60 & < 200	poor (Red) > 200	Unit 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