EdgeNext Documentation

API Endpoint

Request URL: stat/originErrRatio (GET)

API Request Domain: cdn.api.edgenext.com
API Version: v2

API Description

This API is used to query origin error rate statistics for accelerated domains.

The origin error rate is calculated as the ratio of origin response status codes 4xx and 5xx to the total number of origin response status codes.

The default data aggregation interval is 1 minute. The API request rate limit can be found in the response headers (Response Header).

Request Parameters

Common Parameters

The user's authentication token is required. Please contact the on-call support team to obtain a valid token.

GET Request Parameters

Request parameters should be added to the query string of the URL.

Example:

?key1=value1&key2=value2

Parameter Name	Data Type	Required	Description
domains	string	Yes	Specifies the accelerated domains to query. A maximum of 10 accelerated domains can be queried in a single request. When multiple accelerated domains are specified, the API returns aggregated statistics for all specified accelerated domains.
start_time	string	Yes	Specifies the start time of the query range. Examples: 2020-06-01 10:00, 2020-06-01 If only a date is provided (2020-06-01), the start time is automatically set to 2020-06-01 00:00:00. The returned data includes records greater than or equal to the specified start time. Based on the selected aggregation interval, the time will be rounded down to the nearest interval. Example: When querying 2020-06-01 10:03 with a 5-minute interval, the first returned data point corresponds to 2020-06-01 10:00. The interval between start_time and end_time must not exceed 1 day.
end_time	string	Yes	Specifies the end time of the query range. Examples: 2020-06-02 10:00, 2020-06-02 If only a date is provided (2020-06-02), the end time is automatically set to 2020-06-02 23:59:59. The returned data includes records less than or equal to the specified end time. Based on the selected aggregation interval, the time will be rounded down to the nearest interval. Example: When querying 2020-06-02 10:17 with a 5-minute interval, the first returned data point corresponds to 2020-06-02 10:15:00. The interval between start_time and end_time must not exceed 1 day.

Request Example

# The request URL must be URL encoded.

curl -X GET "https://cdn.api.edgenext.com/v2/stat/originErrRatio?token=xxx\
&domains=example.com,example2.com\
&start_time=2020-06-01%2012:16\
&end_time=2020-06-01%2014:00"

Response Example

JSON format

Successful Response

{
    "code": 0, // code is 0 when the response is successful.
    "data": [
        [
            1590984900, // Timestamp, sorted in ascending order.
            {
                "4xx": 0.0038, // Ratio of 4xx status codes.
                "5xx": 0      // Ratio of 5xx status codes.
            }
        ],
        [
            1590985200,
            {
                "4xx": 0.0032,
                "5xx": 0
            }
        ],
        [
            1590985500,
            {
                "4xx": 0.0033,
                "5xx": 0
            }
        ],
        ...
    ]
}

Error Response

{
    "code": 400101,
    "message": "domain(life.com) is invalid"
}

Response Headers

Example:

HTTP/1.0 200 OK

Api-Id:                1039
Content-Type:          application/json; charset=utf-8
X-Ratelimit-Grad:      minute  // Rate limit granularity (minute/hour/day).
X-Ratelimit-Limit:     100     // Maximum number of requests allowed within the current rate limit period.
X-Ratelimit-Remaining: 99      // Remaining number of requests available within the current rate limit period.
X-Retry-After:         56      // Number of seconds until the current rate limit period is reset.

HTTP Status Code Description

HTTP Status Code	Description
404	The requested URL is invalid.
401	Authentication failed. The token is invalid or the API permission has not been enabled.
400	Invalid request parameters.
200	Request completed successfully and the requested data is returned.
5xx	Server-side error. Please contact the on-call support team.