🚧

The apirequests-by-endpoint report is being discontinued

This report is deprecated and will be deactivated on July 1, 2025. As an alternative, use the new common/apis/usage report, based on the Reporting API v2.

The following shows how to generate the apirequests-by-endpoint report using either the Reporting API's Generate a report POST operation or the Get a cacheable report GET operation. Details about each report's supported products, metrics, filters, and available data intervals are also available dynamically by running the API's Get a report type operation, also shown below. See also other available reports.

Report definition

Provides the number of requests by endpoint.

Business object: account_id

Data available for: 92 days

Required products: EDGECONTROL

Available metrics

Available filters

POST request

POST /reporting-api/v1/reports/apirequests-by-endpoint/versions/1/report-data{?start,​end}

Sample: /reporting-api/v1/reports/apirequests-by-endpoint/versions/1/report-data?start​=2020-10-01T00%3A00%3A00Z​&end​=2020-11-01T00%3A00%3A00Z

Query parameters

JSON request members

Request body:

{
    "objectIds": [
        "account1"
    ],
    "metrics": [
        "requestsPercent",
        "requestsTotal"
    ],
    "filters": {
        "af_contain": [
            "exampletext1"
        ],
        "af_end_with": [
            "exampletext2"
        ],
        "af_exact_match": [
            "exampletext3"
        ],
        "af_match": [
            "exampletext4"
        ],
        "af_not_contain": [
            "exampletext5"
        ],
        "af_not_end_with": [
            "exampletext6"
        ],
        "af_not_match": [
            "exampletext7"
        ],
        "af_not_start_with": [
            "exampletext8"
        ],
        "af_start_with": [
            "exampletext9"
        ],
        "contract_type": [
            "1-3CV382"
        ],
        "endpoint": [
            "endpoint/1",
            "endpoint/2"
        ],
        "response_class": [
            "0xx",
            "4xx"
        ],
        "response_code": [
            "403",
            "201"
        ],
        "response_status": [
            "success",
            "error"
        ],
        "username": [
            "username1",
            "username2"
        ]
    }
}

GET request

GET /reporting-api/v1/reports/apirequests-by-endpoint/versions/1/report-data{?start,​end,​objectIds,​metrics,​filters}

Sample: /reporting-api/v1/reports/apirequests-by-endpoint/versions/1/report-data?start​=2020-10-01T00%3A00%3A00Z​&end​=2020-11-01T00%3A00%3A00Z​&objectIds​=account1​&metrics​=requestsPercent%2CrequestsTotal​&filters​=contract_type%3D1-3CV382%2Cendpoint%3Dendpoint%2F1%2Cendpoint%3Dendpoint%2F2

Query parameters

JSON response

Status 200 application/json

Response body:

{
    "metadata": {
        "name": "apirequests-by-endpoint",
        "version": "1",
        "outputType": "FLAT",
        "groupBy": [
            "endpoint"
        ],
        "start": "2020-10-01T00:00:00Z",
        "end": "2020-11-01T00:00:00Z",
        "availableDataEnds": null,
        "suggestedRetryTime": null,
        "rowCount": 4,
        "filters": [       
            {
                "name": "af_contain",
                "values": [
                    "exampletext1"
                ]
            },
            {
                "name": "af_end_with",
                "values": [
                    "exampletext2"
                ]
            },
            {
                "name": "af_exact_match",
                "values": [
                    "exampletext3"
                ]
            },
            {
                "name": "af_match",
                "values": [
                    "exampletext4"
                ]
            },
            {
                "name": "af_not_contain",
                "values": [
                    "exampletext5"
                ]
            },
            {
                "name": "af_not_end_with",
                "values": [
                    "exampletext6"
                ]
            },
            {
                "name": "af_not_match",
                "values": [
                    "exampletext7"
                ]
            },
            {
                "name": "af_not_start_with",
                "values": [
                    "exampletext8"
                ]
            },
            {
                "name": "af_start_with",
                "values": [
                    "exampletext9"
                ]
            },
            {
                "name": "contract_type",
                "values": [
                    "1-3CV382"                ]
            },
            {
                "name": "endpoint",
                "values": [
                    "endpoint/1",
                    "endpoint/2"
                ]
            },
            {
                "name": "response_class",
                "values": [
                    "4xx",
                    "5xx"
                ]
            },
            {
                "name": "response_code",
                "values": [
                    "200",
                    "500"
                ]
            },
            {
                "name": "response_status",
                "values": [
                    "success",
                    "error"
                ]
            },
            {
                "name": "username",
                "values": [
                    "username1",
                    "username2"
                ]
            }
        ],
        "columns": [
            {
                "name": "groupBy",
                "label": "endpoint"
            },
            {
                "name": "requestsPercent",
                "label": "Requests %"
            },
            {
                "name": "requestsTotal",
                "label": "Total Requests"
            }
        ],
        "objectType": "account_id",
        "objectIds": [
            "account1",
        ]
    },
    "data": [
        {
            "endpoint": "endpoint/6",
            "requestsPercent": "67",
            "requestsTotal": "3933"
        },
        {
            "endpoint": "endpoint/5",
            "requestsPercent": "3",
            "requestsTotal": "16"
        },
        {
            "endpoint": "endpoint/2",
            "requestsPercent": "60",
            "requestsTotal": "4513"
        },
        {
            "endpoint": "endpoint/4",
            "requestsPercent": "2",
            "requestsTotal": "2236"
        }
    ],
    "summaryStatistics": {}
}

CSV response

Status 200 text/csv

Response Body:

#METADATA_START
name,​apirequests-by-endpoint
version,​1
source,​apirequests-by-endpoint/versions/1
groupBy,​endpoint
start,​2020-10-01T00:00:00Z
end,​2020-11-01T00:00:00Z
availableDataEnds,
suggestedRetryTime,
rowCount,​4
objectType,​account_id
objectIds,​account1
af_contain,exampletext1
af_end_with,exampletext2
af_exact_match,exampletext3
af_match,exampletext4
af_not_contain,exampletext5
af_not_end_with,exampletext6
af_not_match,exampletext7
af_not_start_with,exampletext8
af_start_with,exampletext9
contract_type,​1-3CV382
endpoint,​endpoint/1,​endpoint/2
response_class,​4xx,​5xx
response_code,​200,​500
response_status,​success,​error
username,​username1,​username2
#METADATA_END

#SUMMARYSTATISTICS_START

#SUMMARYSTATISTICS_END

#COLUMNS_START
endpoint,​requestsPercent,​requestsTotal
#COLUMNS_END

#DATA_START
endpoint/6,​67,​3933
endpoint/5,​3,16
endpoint/2,​60,​4513
endpoint/4,​2,2236
#DATA_END

Get report details

This sample Get a report type operation gets the same information you need to run the apirequests-by-endpoint report as provided in this reference documentation, but available dynamically to your API client application.

GET /reporting-api/v1/reports/apirequests-by-endpoint/versions/1

Status 200 application/json

Response body:

{
    "name": "apirequests-by-endpoint",
    "description": "Provides the number of requests by endpoint.",
    "businessObjectName": "account_id",
    "version": 1,
    "status": "DEPRECATED",
    "deprecated": true,
    "timeBased": false,
    "supportsPagination": false,
    "outputType": "FLAT",
    "requiredProducts": [
        "EDGECONTROL"
    ],
    "requiredRoles": [
        "IDM: API Clients - Admin Access"
    ],
    "available": true,
    "metrics": [
        {
            "name": "requestsPercent",
            "description": "The percentage of requests per endpoint.",
            "label": "Requests %",
            "unit": "RATIO",
            "summaryStatistic": false
        },
        {
            "name": "requestsTotal",
            "description": "Total requests for a given endpoint.",
            "label": "Total Requests",
            "unit": "COUNT",
            "summaryStatistic": false
        }
    ],
    "groupOutlyingValues": {
        "enabled": false
    },
    "groupBy": [
        "endpoint"
    ],
    "filters": [
        {
            "name": "endpoint",
            "type": "string",
            "description": "An API configuration registered with Akamai.",
            "required": false
        },
        {
            "name": "http_method",
            "type": "enum",
            "description": "A request method indicating the action performed on a resource.",
            "values": [
                {
                    "value": "head",
                    "description": "Retrieves header information about the target resource, with no message body in the response."
                },
                {
                    "value": "other",
                    "description": "Other"
                },
                {
                    "value": "post",
                    "description": "Sends information to the server."
                },
                {
                    "value": "get",
                    "description": "Retrieves information about the target resource."
                },
                {
                    "value": "delete",
                    "description": "Removes all information about the target resource."
                },
                {
                    "value": "put",
                    "description": "Replaces existing information about the target resource."
                }
            ],
            "required": false
        },
        {
            "name": "contract_type",
            "type": "string",
            "description": "A contract type ID a given user has access to.",
            "required": false
        },
        {
            "name": "af_not_match",
            "type": "string",
            "description": "Agent family does not match the specified string.",
            "required": false
        },
        {
            "name": "af_match",
            "type": "string",
            "description": "Agent family matches the specified string.",
            "required": false
        },
        {
            "name": "af_not_start_with",
            "type": "string",
            "description": "Agent family does not start with the specified string.",
            "required": false
        },
        {
            "name": "af_start_with",
            "type": "string",
            "description": "Agent family starts with the specified string.",
            "required": false
        },
        {
            "name": "response_status",
            "type": "enum",
            "description": "An indicator of whether the HTTP response resulted in success or an error.",
            "values": [
                {
                    "value": "success",
                    "description": "Successful HTTP response status. "
                },
                {
                    "value": "error",
                    "description": "Error HTTP response status."
                }
            ],
            "required": false
        },
        {
            "name": "af_exact_match",
            "type": "string",
            "description": "Agent family is an exact match for the specified string.",
            "required": false
        },
        {
            "name": "username",
            "type": "string",
            "description": "Name of client generating API request.",
            "required": false
        },
        {
            "name": "af_not_end_with",
            "type": "string",
            "description": "Agent family does not end with the specified string.",
            "required": false
        },
        {
            "name": "response_code",
            "type": "string",
            "description": "An HTTP response status code, for example, 201.",
            "required": false
        },
        {
            "name": "af_end_with",
            "type": "string",
            "description": "Agent family ends with the specified string.",
            "required": false
        },
        {
            "name": "af_not_contain",
            "type": "string",
            "description": "Agent family does not contain the specified string.",
            "required": false
        },
        {
            "name": "response_class",
            "type": "enum",
            "description": "A class of HTTP response status codes, from 0xx through 6xx.",
            "values": [
                {
                    "value": "0xx",
                    "description": "An aborted action on the client side."
                },
                {
                    "value": "1xx",
                    "description": "An informational response, like Continue."
                },
                {
                    "value": "2xx",
                    "description": "A successful response. "
                },
                {
                    "value": "3xx",
                    "description": "Success, but a redirect where the thing you want is somewhere else."
                },
                {
                    "value": "4xx",
                    "description": "Error, where there’s some problem with the client request."
                },
                {
                    "value": "5xx",
                    "description": "Error, where there’s some problem with how the API server responded to the client request."
                },
                {
                    "value": "6xx",
                    "description": "Invalid headers (defined by Akamai)."
                }
            ],
            "required": false
        },
        {
            "name": "af_contain",
            "type": "string",
            "description": "Agent family contains the specified string.",
            "required": false
        }
    ],
    "intervals": [
        "MONTH",
        "WEEK",
        "DAY",
        "HOUR"
    ],
    "dataRetentionDays": 92,
    "limit": 5000,
    "maxLimit": 25000,
    "links": [
        {
            "rel": "self",
            "href": "/reporting-api/v1/reports/apirequests-by-endpoint/versions/1"
        },
        {
            "rel": "versions",
            "href": "/reporting-api/v1/reports/apirequests-by-endpoint/versions"
        },
        {
            "rel": "all-reports",
            "href": "/reporting-api/v1/reports"
        },
        {
            "rel": "execute-report",
            "href": "/reporting-api/v1/reports/apirequests-by-endpoint/versions/1/report-data"
        }
    ]
}