The following shows how to generate the apivolume-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 bytes by endpoint.

Business object: account_id

Data available for: 92 days

Required products: EDGECONTROL

Available metrics

Metric	Description
Data metrics
`bytesPercent`	The percentage of bytes per endpoint.
`bytesTotal`	The total bytes for a given endpoint.

Available filters

Filter	Type	Description
Optional filters
`af_contain`	String	Agent family contains the specified string.
`af_end_with`	String	Agent family ends with the specified string.
`af_exact_match`	String	Agent family is an exact match for the specified string.
`af_match`	String	Agent family matches the specified string.
`af_not_contain`	String	Agent family does not contain the specified string.
`af_not_end_with`	String	Agent family does not end with the specified string.
`af_not_match`	String	Agent family does not match the specified string.
`af_not_start_with`	String	Agent family does not start with the specified string.
`af_start_with`	String	Agent family starts with the specified string.
`contract_type`	String	A contract type ID a given user has access to.
`endpoint`	String	An API configuration registered with Akamai.
`http_method`	Enumeration	A request method indicating the action performed on a resource.
		`head`: Retrieves header information about the target resource, with no message body in the response.
		`other`: Other.
		`post`: Sends information to the server.
		`get`: Retrieves information about the target resource.
		`delete`: Removes all information about the target resource.
		`put`: Replaces existing information about the target resource.
`response_class`	Enumeration	A class of HTTP response status codes, from 0xx through 6xx.
		`0xx`: An aborted action on the client side.
		`1xx`: An informational response, like Continue.
		`2xx`: A successful response.
		`3xx`: Success, but a redirect where the thing you want is somewhere else.
		`4xx`: Error, where there’s some problem with the client request.
		`5xx`: Error, where there’s some problem with how the API server responded to the client request.
		`6xx`: Invalid headers (defined by Akamai).
`response_code`	String	An HTTP response status code, for example, 201.
`response_status`	Enumeration	An indicator of whether the HTTP response resulted in success or an error.
`username`	String	Name of client generating API request.

POST request

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

Sample: /reporting-api/v1/reports/apivolume-by-endpoint/versions/1/report-data?start=2022-05-01T00%3A00%3A00Z&end=2022-06-01T00%3A00%3A00Z

Query parameters

Parameter	Type	Sample	Description
Required
`start`	String	`2020-10-01T00:00:00Z`	Specifies the start of the reported period as an ISO-8601 timestamp with optional time zone. The report includes data that matches the `start` value's timestamp.
`end`	String	`2020-11-01T00:00:00Z`	Specifies the end of the reported period as an ISO-8601 timestamp with optional time zone. The report excludes any data that matches the `end` value's timestamp.

JSON request members

Member	Type	Description
`objectIds`	Array	Specifies unique ID for the `account_id` objectType you want to report on.
`metrics`	Array	The set of desired metrics. If omitted, the report includes all available metrics.
`filters`	Map of arrays	Specifies a set of custom filters, with each filter's name keying an array with each filter's set of values.

Request body:

{
    "objectIds": [
        "account1"
    ],
    "metrics": [
        "bytesPercent",
        "bytesTotal"
    ],
    "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"
        ],
        "http_method": [
            "post",
            "put"
        ],
        "response_class": [
            "0xx",
            "5xx"
        ],
        "response_code": [
            "404",
            "503"
        ],
        "response_status": [
            "success",
            "error"
        ],
        "username": [
            "username1",
            "username2"
        ]
    }
}

GET request

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

Sample: /reporting-api/v1/reports/apivolume-by-endpoint/versions/1/report-data?start=2020-10-01T00%3A00%3A00Z&end=2020-11-01T00%3A00%3A00Z&objectIds=account1&metrics=bytesPercent%2CbytesTotal&filters=af_contain%3Dexampletext1%2Caf_contain%3Dexampletext2%2Caf_end_with%3Dexampletext3%2Caf_end_with%3Dexampletext4

Query parameters

Parameter	Type	Sample	Description
Required
`start`	String	`2022-06-23T13:55:00Z`	Specifies the start of the reported period as an ISO-8601 timestamp with optional time zone. The report includes data that matches the `start` value’s timestamp.
`end`	String	`2022-06-23T14:15:00Z`	Specifies the end of the reported period as an ISO-8601 timestamp with optional time zone. The report excludes any data that matches the `end` value’s timestamp.
Optional
`objectIds`	String	`account1`	Specifies unique ID for the `account_id` objectType you want to report on.
`metrics`	String	`bytesPercent,bytesTotal`	Specifies a comma-separated list of metrics to include in the report, otherwise all metrics if omitted. The set of available metrics depends on the type of report. URL-encode the entire value in the GET request.
`filters`	String	`contract_type=1-3CV382,endpoint=endpoint/1,endpoint=endpoint/2`	Specifies criteria to filter the report's data. The set of available filters depends on the type of report. Separate each filter name and value with an equals (`=`) character, and separate various name/value pairs with commas (`,`). To specify more than one filter value, repeat the filter name. See the accompanying example for guidance. URL-encode the entire value in the GET request.

JSON response

Status 200 application/json

Response body:

{
    "metadata": {
        "name": "apivolume-by-endpoint",
        "version": "1",
        "outputType": "FLAT",
        "groupBy": [
            "endpoint"
        ],
        "start": "2022-05-01T00:00:00Z",
        "end": "2022-06-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": "http_method",
                "values": [
                    "delete",
                    "post"
                ]
            },
            {
                "name": "response_class",
                "values": [
                    "0xx",
                    "5xx"
                ]
            },
            {
                "name": "response_code",
                "values": [
                    "100",
                    "404"
                ]
            },
            {
                "name": "response_status",
                "values": [
                    "success",
                    "error"
                ]
            },
            {
                "name": "username",
                "values": [
                    "username1",
                    "username2"
                ]
            }
        ],
        "columns": [
            {
                "name": "groupBy",
                "label": "endpoint"
            },
            {
                "name": "bytesPercent",
                "label": "Bytes %"
            },
            {
                "name": "bytesTotal",
                "label": "Total Bytes"
            }
        ],
        "objectType": "account_id",
        "objectIds": [
            "account1",
        ]
    },
    "data": [
        {
            "endpoint": "endpoint/4",
            "bytesPercent": "35",
            "bytesTotal": "4096"
        },
        {
            "endpoint": "endpoint/5",
            "bytesPercent": "79",
            "bytesTotal": "331"
        },
        {
            "endpoint": "endpoint/1",
            "bytesPercent": "43",
            "bytesTotal": "436"
        },
        {
            "endpoint": "endpoint/6",
            "bytesPercent": "88",
            "bytesTotal": "4273"
        }
    ],
    "summaryStatistics": {}
}

CSV response

Status 200 text/csv

Response Body:

#METADATA_START
name,apivolume-by-endpoint
version,1
source,apivolume-by-endpoint/versions/1
groupBy,endpoint
start,2022-05-01T00:00:00Z
end,2022-06-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
http_method,delete,post
response_class,0xx,5xx
response_code,100,404
response_status,success,error
username,username1,username2
#METADATA_END

#SUMMARYSTATISTICS_START

#SUMMARYSTATISTICS_END

#COLUMNS_START
endpoint,bytesPercent,bytesTotal
#COLUMNS_END

#DATA_START
endpoint/4,35,4096
endpoint/5,79,331
endpoint/1,43,436
endpoint/6,88,4273
#DATA_END

Get report details

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

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

Status 200 application/json

Response body:

{
    "name": "apivolume-by-endpoint",
    "description": "Provides the number of bytes by endpoint.",
    "businessObjectName": "account_id",
    "version": 1,
    "status": "PUBLISHED",
    "deprecated": false,
    "timeBased": false,
    "supportsPagination": false,
    "outputType": "FLAT",
    "requiredProducts": [
        "EDGECONTROL"
    ],
    "requiredRoles": [
        "IDM: API Clients - Admin Access"
    ],
    "available": true,
    "metrics": [
        {
            "name": "bytesPercent",
            "description": "The percentage of bytes per endpoint.",
            "label": "Bytes %",
            "unit": "RATIO",
            "summaryStatistic": false
        },
        {
            "name": "bytesTotal",
            "description": "The total bytes for a given endpoint.",
            "label": "Total Bytes",
            "unit": "BYTE",
            "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.Y"
                },
                {
                    "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/apivolume-by-endpoint/versions/1"
        },
        {
            "rel": "versions",
            "href": "/reporting-api/v1/reports/apivolume-by-endpoint/versions"
        },
        {
            "rel": "all-reports",
            "href": "/reporting-api/v1/reports"
        },
        {
            "rel": "execute-report",
            "href": "/reporting-api/v1/reports/apivolume-by-endpoint/versions/1/report-data"
        }
    ]
}