Network Experience Analytics API v1

Monitor statistical data to get insight into the quality of your customers’ experience (QoE) when using your network.

Learn more:


Overview

The Network Experience Analytics (NEA) API provides you with statistics that depict the media, web, server, and network content quality of experience (QoE) your users have when accessing content from your network. You can compare your metrics against competitors and other global network operators. NEA bases the competitive in-country and global network operators included in the statistics on your input for measuring QoE traffic. Finally, the statistics include the option to see data for cellular operators, fixed network operators, or fixed and cellular operators.

The QoE scores represent a percentage rating of quality using several media and web Key Performance Indicators (KPIs).

Who should use this API

This API is for network operators and service providers who are looking for insight into their customer’s experience on their networks. Reports provide you with statistics that depict the media, web, server, and network related quality of experience (QoE) users have when accessing content from your network.

Getting started

Before using the NEA API for the first time:

  • Contact your Akamai representative to enable it for your account.

  • Review Get Started for API tools that Akamai provides.

  • Review Authorize Your Client to create your NEA API access credentials and authorizations. As detailed in The API Identity Model, you then access the API using custom hostnames that looks like this: https://akzz-XXXXXXXXXXXXXXXX-XXXXXXXXXXXXXXXX.luna.akamaiapis.net.

Key performance indicators

Key Performance Indicators (KPI) are metrics and dimensions used to evaluate the quality of experience (QoE) for a subscriber of a network operator. The Network Experience Analytics (NEA) API provides KPIs for Media, Web, and Server performance.

Dimensions

Dimensions are elements that can be broken down by statistics to get a more precise view of their performance. For example, some dimensions include the user’s device operating system, city (if you provide IP range information for cities), or device type (e.g., desktop, mobile phone, or tablet).

If you provide a classless inter-domain routing (CIDR) breakdown by other elements, like packet gateway (PGW) location, you can configure up to three custom dimensions.

Filters

Filters enable you to see a subset of values for a given dimension’s KPI by eliminating the data points for other values of that dimension. For example, you may like to view Play With Rebuffers for devices running on Android OS only.

Resources

The following list provides a road map of all the conceptual objects you deal with when interacting with the Network Experience Analytics API, and provides pointers to where you can learn more.

  • Customer: This object contains your Customer ID, which you need for subsequent reporting operations. You also get a list of competitor IDs. See the Customer object type.

  • Report: This object contains the results of a successful report query. See the Report object type.

  • KPI: Key Performance Indicators are metrics that evaluate the quality of experience (QoE) for a subscriber of a network operator. The NEA API provides KPIs for Media, Web, and Server performance.

  • Dimension: Dimensions are elements that you can break down by statistics to get a more precise view of their performance, for example city or operating-system.

    There are two types of Dimensions:

    • Grouped: Report response is series of arrays grouped by the specified dimension. Use the gd# dimension parameters.

    • Ungrouped: Report response is a two-dimensional array. Use the ud# dimension parameters.

  • Filter: Filters enable you to see a subset of values for a given dimension’s KPI by eliminating the data points for other values of that dimension. For example, city=Boston&city=NYC&city=LA or "device-type=Desktop&device-type=MobilePhone. The logical operation between separate filters is AND, while the logical operation between multiple values for the same filter is OR.

API summary

Download the RAML descriptors for this API.

Operation Method Endpoint
Get Current User ID GET /nea/v1/portal-users/current{?gid}
Get Report GET /nea/v1/customers/{customerId}/reports{?startTime,endTime,gid,reportGranularity,useBucketUnits,kpi1,kpi2,kpi3,ud1,gd1,asnum,city,day-part,device-type,format,industry-vertical,network-type,operating-system,reserved-dim–1,reserved-dim–2,reserved-dim–3,network-operator,country,continent,region,cell,latitude,longitude,content-provider-name}

Get current user ID

Retrieves the current user’s information, along with the identifiers of relevant competitors.

GET /nea/v1/portal-users/current{?gid}

Sample: /nea/v1/portal-users/current?gid=42

Parameter Type Sample Description
Required query parameters
gid Integer 42 Your Akamai Group ID. Your Akamai representative provides you with this value.

Status 200 application/json

Response Body:

{
    "customer": {
        "id": 1,
        "adbAsname": "Acme Networks UK",
        "adbCubes": [],
        "competitors": [
            {
                "id": 2,
                "adbAsname": "Cellular Provider USA",
                "adbCubes": [],
                "competitors": [],
                "networkType": "CELLULAR",
                "isServerKpiSupport": false,
                "isCellInfoSupport": false,
                "isPcdMapKpiSupport": false,
                "country": null,
                "reportGranularityInSeconds": 0
            },
            {
                "id": 3,
                "adbAsname": "Cellular Provider Germany",
                "adbCubes": [],
                "competitors": [],
                "networkType": "CELLULAR",
                "isServerKpiSupport": false,
                "isCellInfoSupport": false,
                "isPcdMapKpiSupport": false,
                "country": null,
                "reportGranularityInSeconds": 0
            },
            {
                "id": 10,
                "adbAsname": "Broadband Provider UK",
                "adbCubes": [],
                "competitors": [],
                "networkType": "FIXED",
                "isServerKpiSupport": true,
                "isCellInfoSupport": false,
                "isPcdMapKpiSupport": false,
                "country": null,
                "reportGranularityInSeconds": 0
            },
            {
                "id": 14,
                "adbAsname": "Cellular Provider UK",
                "adbCubes": [],
                "competitors": [],
                "networkType": "CELLULAR",
                "isServerKpiSupport": false,
                "isCellInfoSupport": false,
                "isPcdMapKpiSupport": false,
                "country": null,
                "reportGranularityInSeconds": 0
            },
            {
                "id": 19,
                "adbAsname": "Acme Networks USA",
                "adbCubes": [],
                "competitors": [],
                "networkType": "CELLULAR",
                "isServerKpiSupport": false,
                "isCellInfoSupport": false,
                "isPcdMapKpiSupport": false,
                "country": null,
                "reportGranularityInSeconds": 0
            },
            {
                "id": 22,
                "adbAsname": "Acme Networks Korea",
                "adbCubes": [],
                "competitors": [],
                "networkType": "CELLULAR",
                "isServerKpiSupport": false,
                "isCellInfoSupport": false,
                "isPcdMapKpiSupport": false,
                "country": null,
                "reportGranularityInSeconds": 0
            },
            {
                "id": 23,
                "adbAsname": "Broadband Provider Korea",
                "adbCubes": [],
                "competitors": [],
                "networkType": "FIXED",
                "isServerKpiSupport": false,
                "isCellInfoSupport": false,
                "isPcdMapKpiSupport": false,
                "country": null,
                "reportGranularityInSeconds": 0
            },
            {
                "id": 28,
                "adbAsname": "Cellular Provider France",
                "adbCubes": [],
                "competitors": [],
                "networkType": "CELLULAR",
                "isServerKpiSupport": false,
                "isCellInfoSupport": false,
                "isPcdMapKpiSupport": false,
                "country": null,
                "reportGranularityInSeconds": 0
            }
        ],
        "networkType": "FIXED_AND_CELLULAR",
        "isServerKpiSupport": true,
        "isCellInfoSupport": true,
        "isPcdMapKpiSupport": true,
        "country": {
            "name": "UK",
            "region": "EMEA",
            "latitude": 56.378051,
            "longitude": -3.435973
        },
        "reportGranularityInSeconds": 3600
    },
    "isAkamai": true
}

Get report

Retrieves a network analytics report based on the specified KPI, filters, and dimensions.

GET /nea/v1/customers/{customerId}/reports{?startTime,endTime,gid,reportGranularity,useBucketUnits,kpi1,kpi2,kpi3,ud1,gd1,asnum,city,day-part,device-type,format,industry-vertical,network-type,operating-system,reserved-dim–1,reserved-dim–2,reserved-dim–3,network-operator,country,continent,region,cell,latitude,longitude,content-provider-name}

Sample: /nea/v1/customers/42/reports?startTime=2017-12-07%2005%3A00%3A00&endTime=2017-12-22%2004%3A59%3A59.999000&gid=42&reportGranularity=3600&useBucketUnits=true&kpi1=bitrate&kpi2=bitrate&kpi3=bitrate&ud1=time&gd1=city&asnum=64496&city=London&day-part=1&device-type=Tablet&format=HTTP%20Live%20Streaming&industry-vertical=Media%20%26%20Entertainment&network-type=Cellular&operating-system=Android&reserved-dim–1=custom-value–1&reserved-dim–2=custom-value–2&reserved-dim–3=custom-value–3&network-operator=ABC%20Networks%20UK&country=Canada&continent=Asia&region=EMEA&cell=LTE/1001&latitude=52.53&longitude=–1.12&content-provider-name=Placeholder%20Studios

Parameter Type Sample Description
URL parameters
customerId Integer 42 A unique identifier for a customer or competitor, returned in the id property of the Customer object.
Required query parameters
endTime String 2017-12-22 04:59:59.999000 The end date and time string for the requested report in ISO–8601 format.
gid Integer 42 Your Akamai Group ID. Your Akamai representative provides you with this value.
startTime String 2017-12-07 05:00:00 The start date and time string of the requested report in ISO–8601 format.
Optional query parameters
asnum Integer 64496 Autonomous system number (ASN) to filter by.
cell String LTE/1001 Cell ID to filter by.
city String London City to filter by.
content-provider-name String Placeholder Studios Content provider name to filter by.
continent String Asia Continent to filter by.
country String Canada Country to filter by.
day-part Integer 1 Day part to filter by. Values are in the range 1–4, where each value refers to the corresponding 6-hour period of a 24-hour day.
device-type String Tablet Device type to filter by.
format String HTTP Live Streaming Media format to filter by.
gd1 String city The first grouping dimension. See Dimension Values for details on each.
industry-vertical String Media & Entertainment Industry vertical to filter by.
kpi1 String bitrate The first KPI. See KPI Values for details on each.
kpi2 String bitrate The second KPI. See KPI Values for details on each.
kpi3 String bitrate The third KPI. See KPI Values for details on each.
latitude Number 52.53 Latitude to filter by.
longitude Number -1.12 Longitude to filter by.
network-operator String ABC Networks UK Network operator to filter by.
network-type String Cellular Network type to filter by. Either Fixed, Cellular, or both.
operating-system String Android Operating system to filter by.
region String EMEA Region to filter by.
reportGranularity Integer 3600 Granularity of the requested report, in seconds.
reserved-dim-1 String custom-value-1 First custom dimension to filter by. Custom dimensions vary from customer to customer. You can only access your own custom dimensions, not your competitors‘. | | reserved-dim-2 | String | custom-value-2 | Second custom dimension to filter by. Custom dimensions vary from customer to customer. You can only access your own custom dimensions, not your competitors’.
reserved-dim-3 String custom-value-3 Third custom dimension to filter by. Custom dimensions vary from customer to customer. You can only access your own custom dimensions, not your competitors’.
ud1 String time The first ungrouped dimension. See Dimension Values for details on each.
useBucketUnits Boolean true Set to true if you use bucketed dimensions.

Status 200 application/json

Response Body:

{
    "kpis": [
        "Bitrate"
    ],
    "series": [
        {
            "dimensions": [],
            "data": [
                [
                    "2017-09-13T04:00:00.000Z",
                    1331.81
                ],
                [
                    "2017-09-13T05:00:00.000Z",
                    1558.76
                ]
            ],
            "maxDate": "2017-09-23T07:00:00.000Z",
            "minDate": "2017-09-17T03:00:00.000Z",
            "avg": 1563.667514124293,
            "min": 904.11,
            "max": 2119.93,
            "percentile2": 1148.625,
            "percentile50": 1576.75,
            "percentile98": 1925.9442
        }
    ]
}
  1. Run the Get Portal User ID operation and store the id from the customer object. Use the id value for the customerId URL parameter.

  2. Determine the startTime and endTime for the report.

  3. Set the gid query parameter to the number provided by your Akamai representative.

  4. Optionally, set the reportGranularity in seconds. The default value is 86400 (24 hours).

  5. If you use bucketed dimensions, set the useBucketUnits query parameter to true. Otherwise you can omit this parameter or set to false.

  6. Determine the value for a minimum of one and up to nine KPIs. Use the kpi1, kpi2, and kpi3 query parameters to set these values. See KPI Values for the set of possible values.

  7. Optionally, determine the value of the dimensions using the ud1 or gd1 query parameters. See Dimension Values for the set of possible values.

  8. Optionally, determine any filters you would like to place on the report data. You can use any non-bucketed dimension from the table above to filter report data. For example: "city": "Boston".

  9. Make a GET request to /nea/v1/customers/{customerId}/reports{?startTime,endTime,gid,reportGranularity,useBucketUnits,kpi1,kpi2,kpi3,ud1,gd1,asnum,city,day-part,device-type,format,industry-vertical,network-type,operating-system,reserved-dim–1,reserved-dim–2,reserved-dim–3,network-operator,country,continent,region,cell,latitude,longitude,content-provider-name}.

  10. The response provides a Report object.

Dimension values

When running the Get Report operation, optionally set the ud1 or gd1 query parameters with any of these values:

Parameter Description
asnum The registered Autonomous System Number for the Internet Service Provider (ISP).
bitrate-bucket The number of bits, after compression, used per unit of playback time. In the case of adaptive bitrate streaming, it represents the weighted average of the individual bitrates used in streaming.
cell The location or ID of the cell on the cellular tower involved with transmission of the content over the network.
city City of the geographic location.
continent Continent of the geographic location.
country Country of the geographic location.
day-part Day part to filter by. Values are in the range 1–4, where each value refers to the corresponding 6-hour period of a 24-hour day.
device-type The kind of device that data was consumed on. Options include Desktop (all computers, including laptops), MobilePhone, and Tablet.
dns-lookup-time-bucket Average time the DNS resolver takes to resolve the IP address of the host.
first-paint-time-bucket Average time for the browser to render the first pixel on the screen.
format The style of content delivery. Options may include HTTP streaming, Flash HD, or Progressive Downloads.
hd-sd The resolution of media streams. Either HD or SD.
industry-vertical Specialized market-types such as media and entertainment, retail, etc.
latitude Latitude of the geographic location.
longitude Longitude of the geographic location.
network-operator The name of the network operator. Use the adbAsname parameter value found in a customer object for this parameter.
network-type The kind of system that data was consumed on, either FIXED, CELLULAR, or FIXED_AND_CELLULAR.
operating-system The software that supports the device’s functionality. Options may include Android OS, iPhone OS, Linux, Mac OS X, RIM OS, RIM Tablet OS, Windows NT, and Windows Phone OS.
page-load-time-bucket the total time for the page to finish loading and rendering.
rebuffer-time-per-minute-bucket Average time spent on rebuffering per play. Computes as a ratio of rebuffer time by number of plays started in the specified time frame of the report.
rebuffers-per-minute-bucket Average amount of time spent rebuffering per minute of playback.
region Region of the geographic location.
reserved-dim-1 First custom dimension, if defined for your account.
reserved-dim-2 Second custom dimension, if defined for your account.
reserved-dim-3 Third custom dimension, if defined for your account.
round-trip-time-bucket Average time it takes for for a packet of data to get from the user or client to the edge server and back.
startup-time-bucket Average time between the initial play attempt and the first rendered frame, in seconds.
tcp-connection-time-bucket Average time to establish the TCP/IP connection between the user and the edge server.
time Timestamp indicating the date and time of a data point.

KPI values

When running the Get Report operation, optionally set the kp1, kp2, or kp3 query parameters with any of these values:

Parameter Unit Description
avg-bitrate Kbps Average amount of encoded bits per second (bitrate) for media streams served from the edge servers.
avg-rebuffer-time-per-play Seconds Average time spent on rebuffering per play. Computes as a ratio of rebuffer time by number of plays started in the selected time frame.
avg-throughput Kbps Average rate of successful delivery of bytes from the edge server, calculated as the total bytes delivered divided by the total time it takes the network to serve the request.
bandwidth Gbps The total bandwidth usage at the edge servers, including all HTTP response codes.
bitrate Kbps Bit rate of an encoded file.
bytes GB The total Bytes served by the edge servers, including all HTTP response codes.
client-first-byte-time Milliseconds Average time taken for the client to receive the first byte from the server.
client-throughput Bits per second The rate of data measured on the client itself.
dns-lookup-time Milliseconds Average time the DNS resolver takes to resolve the IP address of the host.
downshifts-per-play Number Average number of times users experienced a bit rate downshift per session.
first-paint-time Milliseconds Average time for the browser to render the first pixel on the screen.
hits Number The count of HTTP requests issued to web servers.
ma-hits Number The count of HTTP requests issued to media servers.
media-qoe Number (Percentage) The overall quality of experience for media content consumed through all device types (desktop computers, mobile phones, and tablets). The algorithms take into account the user impact of metrics in this table.
overall-qoe The overall quality of experience for media and web content consumed through all device types (desktop computers, mobile phones, and tablets). The algorithms take into account the user impact of metrics in this table.
page-load-time Milliseconds Average amount of time the browser takes to return the onload event, indicating that any additional application logic is complete. Scripts may be set to run at the return of the onload event or continuously.
play-duration
plays-with-rebuffers Percentage The percentage of total plays that included rebuffering.
rebuffer-time-per-minute Number Average count of rebuffers per minute of playback, expressed as a ratio of rebuffers across all plays by total play duration in the selected time period.
rebuffers-per-minute Seconds Average amount of time spent rebuffering per minute of playback.
round-trip-time Milliseconds Average time it takes for for a packet of data to get from the user to the edge server and back.
signal-strength Gbps The total bandwidth usage at the edge servers, including all HTTP response codes.
startup-abandonment-rate Percentage The percentage of plays requested and abandoned before the play started.
startup-time Seconds Average time between the initial play attempt and the first rendered frame, in seconds.
tcp-connection-time Milliseconds Average time to establish the TCP/IP connection between the user and the edge server. Computes the difference between the TCP connectStart and TCP connectEnd metrics.
upshifts-per-play Number Average number of times users experienced a bit rate upshift per session.
web-qoe Number The overall quality of experience for web content consumed through all device types (desktop computers, mobile phones, and tablets). The algorithms take into account the user impact of metrics in this table.

Data

This section provides you with the data model for the NEA API.

JSON data follows these overall conventions:

  • Customer responses contain your customer configuration information, along with a list of competitors information.

  • Report responses contain the specified KPIs, along with a list of series objects, containing an array of the specified dimensions and data of the report results.

Download the JSON schemas for this API.

Customer

Encapsulates the identifying information for the current portal user and their competitors.

Download schema: customer.json

Sample GET:

{
    "customer": {
        "id": 1,
        "adbAsname": "Acme Networks UK",
        "adbCubes": [],
        "competitors": [
            {
                "id": 2,
                "adbAsname": "Cellular Provider USA",
                "adbCubes": [],
                "competitors": [],
                "networkType": "CELLULAR",
                "isServerKpiSupport": false,
                "isCellInfoSupport": false,
                "isPcdMapKpiSupport": false,
                "country": null,
                "reportGranularityInSeconds": 0
            },
            {
                "id": 3,
                "adbAsname": "Cellular Provider Germany",
                "adbCubes": [],
                "competitors": [],
                "networkType": "CELLULAR",
                "isServerKpiSupport": false,
                "isCellInfoSupport": false,
                "isPcdMapKpiSupport": false,
                "country": null,
                "reportGranularityInSeconds": 0
            },
            {
                "id": 10,
                "adbAsname": "Broadband Provider UK",
                "adbCubes": [],
                "competitors": [],
                "networkType": "FIXED",
                "isServerKpiSupport": true,
                "isCellInfoSupport": false,
                "isPcdMapKpiSupport": false,
                "country": null,
                "reportGranularityInSeconds": 0
            },
            {
                "id": 14,
                "adbAsname": "Cellular Provider UK",
                "adbCubes": [],
                "competitors": [],
                "networkType": "CELLULAR",
                "isServerKpiSupport": false,
                "isCellInfoSupport": false,
                "isPcdMapKpiSupport": false,
                "country": null,
                "reportGranularityInSeconds": 0
            },
            {
                "id": 19,
                "adbAsname": "Acme Networks USA",
                "adbCubes": [],
                "competitors": [],
                "networkType": "CELLULAR",
                "isServerKpiSupport": false,
                "isCellInfoSupport": false,
                "isPcdMapKpiSupport": false,
                "country": null,
                "reportGranularityInSeconds": 0
            },
            {
                "id": 22,
                "adbAsname": "Acme Networks Korea",
                "adbCubes": [],
                "competitors": [],
                "networkType": "CELLULAR",
                "isServerKpiSupport": false,
                "isCellInfoSupport": false,
                "isPcdMapKpiSupport": false,
                "country": null,
                "reportGranularityInSeconds": 0
            },
            {
                "id": 23,
                "adbAsname": "Broadband Provider Korea",
                "adbCubes": [],
                "competitors": [],
                "networkType": "FIXED",
                "isServerKpiSupport": false,
                "isCellInfoSupport": false,
                "isPcdMapKpiSupport": false,
                "country": null,
                "reportGranularityInSeconds": 0
            },
            {
                "id": 28,
                "adbAsname": "Cellular Provider France",
                "adbCubes": [],
                "competitors": [],
                "networkType": "CELLULAR",
                "isServerKpiSupport": false,
                "isCellInfoSupport": false,
                "isPcdMapKpiSupport": false,
                "country": null,
                "reportGranularityInSeconds": 0
            }
        ],
        "networkType": "FIXED_AND_CELLULAR",
        "isServerKpiSupport": true,
        "isCellInfoSupport": true,
        "isPcdMapKpiSupport": true,
        "country": {
            "name": "UK",
            "region": "EMEA",
            "latitude": 56.378051,
            "longitude": -3.435973
        },
        "reportGranularityInSeconds": 3600
    },
    "isAkamai": true
}

Customer members

Member Type Description
customer Customer.customer Encapsulates configuration parameters for the current user.
isAkamai Boolean Indicates whether the current user is on an Akamai internal account.
Customer.customer: Encapsulates configuration parameters for the current user.
adbAsname String The name of the network operator.
adbCubes Object Database tables descriptors that store customer-specific analytics data.
competitors Object An array of customer objects containing competitors identifying information.
country Customer.customer.country The country of the current customer.
id Number The customer ID of the current user.
isCellInfoSupport Boolean Indicates whether you have cell tower level data reporting enabled on your account.
isPcdMapKpiSupport Boolean Indicates whether you have PCD/MAP KPI data reporting enabled on your account.
isServerKpiSupport Boolean Indicates whether you have server KPIs data reporting enabled on your account.
networkType String The network type of the current user. Values are FIXED, CELLULAR, or FIXED_AND_CELLULAR.
reportGranularityInSeconds Integer The shortest gap between report samples allowed for the current customer, in seconds.
Customer.customer.country: The country of the current customer.
latitude Number The latitude of the country.
longitude Number The longitude of the country.
name String The name of the country.
region String The geographical region of the country. Values are N.America, Lat.America, Asia-Pac., EMEA, or Other.

Report

Encapsulates the response data for a network analytics report.

Download schema: reports-get-response.json

Sample GET:

{
    "kpis": [
        "Bitrate"
    ],
    "series": [
        {
            "dimensions": [],
            "data": [
                [
                    "2017-09-13T04:00:00.000Z",
                    1331.81
                ],
                [
                    "2017-09-13T05:00:00.000Z",
                    1558.76
                ]
            ],
            "maxDate": "2017-09-23T07:00:00.000Z",
            "minDate": "2017-09-17T03:00:00.000Z",
            "avg": 1563.667514124293,
            "min": 904.11,
            "max": 2119.93,
            "percentile2": 1148.625,
            "percentile50": 1576.75,
            "percentile98": 1925.9442
        }
    ]
}

Report members

Member Type Description
kpis Array A list of the specified reporting KPIs.
series Report.series[] An array of dimensions and data objects for each report result.
Report.series[]: An array of dimensions and data objects for each report result.
avg Number The average value of the report data.
data Array Lists the report data for a specified set of dimensions and filters.
dimensions Array A list of the specified report dimensions.
max Number The maximum value of the report data.
maxDate String The latest date in ISO 8601 format of the report data.
min Number The minimum value of the report data.
minDate String The earliest date in ISO 8601 format of the report data.
percentile2 Number The 2nd percentile of the report data points.
percentile50 Number The 50th percentile of the report data points.
percentile98 Number The 98th percentile of the report data points.

Errors

This section provides details on the data object that reflects the API’s common response to error cases, and lists the API’s range of response status codes for both error and success cases.

Error responses

The API responds with HTTP Problem error objects that provide details useful for debugging. For example:

{
    "type": "https://problems.omni.akamaiapis.net/http/forbidden",
    "title": "Forbidden",
    "detail": "Insufficient permissions. Code-01",
    "status": 403,
    "instance": "3e3f11da-e205-409a-be77-24e459f29fa8"
}

HTTP status codes

The API produces the following set of HTTP status codes for both success and failure scenarios:

Code Description
200 The operation was successful.
400 Bad Request.
403 Access is forbidden.
404 Resource not found.
422 Unable to process Entity
500 Internal server error.

Last modified: 2/9/2018