apiusage-by-time

The following shows how to generate the apiusage-by-time 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

The API usage report allows you to audit which users are using APIs and which APIs are most frequently used.

This report allows you to configure the aggregation interval for each data record. Available interval values are: MONTH, WEEK, DAY, HOUR.

Business object: account_id

Data available for: 92 days

Required products: EDGECONTROL

Available metrics

MetricDescription
Data metrics
bytesThe bandwidth used during the request for the associated URL.
requestsRequests.
Summary metrics
bytesTotalThe total bandwidth used for requests.
requestsTotalTotal requests for a given time frame.

Available filters

FilterTypeDescription
Optional filters
contract_typeStringThe list of accounts and contract type IDs a given user has access to.
endpointStringAn API configuration registered with Akamai.
response_classEnumerationA 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 that indicates a problem with the client's request.
5xx: Error that indicates a problem with the server's response.
6xx: Invalid headers, defined by Akamai.
response_codeStringAn HTTP response status code, for example, 201.
response_statusEnumerationAn indicator of whether the HTTP response resulted in success or an error.
success: Successful HTTP response status.
error: Error HTTP response status.
usernameStringName of client generating API request.

POST request

POST /reporting-api/v1/reports/apiusage-by-time/versions/1/report-data{?start,​end,​interval}

Sample: /reporting-api/v1/reports/apiusage-by-time/versions/1/report-data?start​=2021-07-05T10%3A00%3A00Z​&end​=2021-07-05T14%3A00%3A00Z​&interval​=HOUR

For other granularity, you need to adjust start and end dates:

Sample with longer interval: /reporting-api/v1/reports/apiusage-by-time/versions/1/report-data?start=2021-03-01&end=2021-07-01&interval=MONTH

Query parameters

ParameterTypeSampleDescription
Required
startString2021-07-05T10:00:00ZSpecifies the start of the reported period as an ISO-8601 timestamp with an optional time zone. The report includes data that matches the start value's timestamp.
endString2021-07-05T14:00:00ZSpecifies 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.
intervalEnumerationHOURThe duration of each data record. Available values: MONTH, WEEK, DAY, HOUR.
objectIdsArray1-1234K, T-ES-123455Specifies the set of account_id values you want to report on.
objectIdsEnumeration1-1234K, T-ES-123455As an alternative to an array of ID values, specify all as a string for unfiltered data. Either way, objectIds is required.

JSON request members

MemberTypeDescription
metricsArrayThe set of desired metrics. If omitted, the report includes all available metrics.
filtersMap of arraysSpecifies a set of custom filters, with each filter's name keying an array with each filter's set of values.

Request body:

{
    "objectIds": [
        "1-1234",
        "1-ABCDE",
        "1-ABC123"
    ],
    "metrics": [
        "bytes",
        "bytesTotal",
        "requests",
        "requestsTotal"
    ],
    "filters": {
        "contract_type": [
            "1-3CV382",
            "1-6T5ZND"
        ],
        "endpoint": [
            "endpoint/1",
            "endpoint/2"
        ],
        "response_class": [
            "4xx",
            "0xx"
        ],
        "response_code": [
            "500",
            "503"
        ],
        "response_status": [
            "success",
            "error"
        ],
        "username": [
            "username1",
            "username2"
        ]
    }
}

GET request

GET /reporting-api/v1/reports/apiusage-by-time/versions/1/report-data{?start,​end,​interval,​objectIds,​allObjectIds,​metrics,​filters}

Sample: /reporting-api/v1/reports/apiusage-by-time/versions/1/report-data?start​=2021-07-05T10%3A00%3A00Z​&end​=2021-07-05T14%3A00%3A00Z​&interval​=HOUR​&objectIds​=1-1234,​1-ABCDE,1-ABC123​&metrics​=bytes%2CbytesTotal​&filters​=contract_type%3D1-3CV382%2Ccontract_type%3D1-6T5ZND%2Cendpoint%3Dendpoint%2F1%2Cendpoint%3Dendpoint%2F2

Query parameters

ParameterTypeSampleDescription
Required
startString2021-07-05T10:00:00ZSpecifies the start of the reported period as an ISO-8601 timestamp with optional time zone.
endString2021-07-05T14:00:00ZSpecifies 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.
intervalEnumerationHOURThe duration of each data record. Available values: MONTH, WEEK, DAY, HOUR.
Optional
allObjectIdsBooleantrueAs an alternative to objectIds, enabling this generates a report that includes all IDs available for the account_id object type. This parameter is ignored if the request also specifies a set of objectIds.
objectIdsString1-1234,​1-ABCDE,1-ABC123As an alternative to allObjectIds, specifies the set of unique IDs for the account_id object type you want to report on, formatted as a comma-delimited list.
metricsStringbytes,​bytesTotalSpecifies 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.
filtersStringcontract_type=​1-3CV382,​contract_type=​1-6T5ZND,endpoint=​endpoint/1,​endpoint=​endpoint/2Specifies 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": "apiusage-by-time",
        "version": "1",
        "outputType": "FLAT",
        "groupBy": [
            "startdatetime"
        ],
        "interval": "HOUR",
        "start": "2021-07-05T10:00:00Z",
        "end": "2021-07-05T14:00:00Z",
        "availableDataEnds": null,
        "suggestedRetryTime": null,
        "rowCount": 4,
        "filters": [
            {
                "name": "contract_type",
                "values": [
                    "1-3CV382",
                    "1-6T5ZND"
                ]
            },
            {
                "name": "endpoint",
                "values": [
                    "endpoint/1",
                    "endpoint/2"
                ]
            },
            {
                "name": "response_class",
                "values": [
                    "0xx",
                    "4xx"
                ]
            },
            {
                "name": "response_code",
                "values": [
                    "403",
                    "404"
                ]
            },
            {
                "name": "response_status",
                "values": [
                    "success",
                    "error"
                ]
            },
            {
                "name": "username",
                "values": [
                    "username1",
                    "username2"
                ]
            }
        ],
        "columns": [
            {
                "name": "groupBy",
                "label": "startdatetime"
            },
            {
                "name": "bytes",
                "label": "Bytes"
            },
            {
                "name": "requests",
                "label": "Requests"
            }
        ],
        "objectType": "account_id",
        "objectIds": [
            "1-1234",
            "1-ABCDE",
            "1-ABC123"
        ]
    },
    "data": [
        {
            "startdatetime": "2021-07-05T10:00:00Z",
            "bytes": "2523",
            "requests": "1780"
        },
        {
            "startdatetime": "2021-07-05T11:00:00Z",
            "bytes": "3380",
            "requests": "3875"
        },
        {
            "startdatetime": "2021-07-05T12:00:00Z",
            "bytes": "669",
            "requests": "4001"
        },
        {
            "startdatetime": "2021-07-05T13:00:00Z",
            "bytes": "419",
            "requests": "290"
        }
    ],
    "summaryStatistics": {
        "bytesTotal": {
            "value": "2924",
            "details": {}
        },
        "requestsTotal": {
            "value": "148",
            "details": {}
        }
    }
}

CSV response

Status 200 text/csv

Response Body:

#METADATA_START
name,​apiusage-by-time
version,​1
source,​apiusage-by-time/versions/1
groupBy,​startdatetime
start,​2021-07-05T10:00:00Z
end,​2021-07-05T14:00:00Z
interval,`HOUR`
availableDataEnds,
suggestedRetryTime,
rowCount,​4
objectType,​account_id
objectIds,​1-1234,​1-ABCDE,1-ABC123
contract_type,​1-3CV382,​1-6T5ZND
endpoint,​endpoint/1,​endpoint/2
response_class,​0xx,​4xx
response_code,​403,​404
response_status,​success,​error
username,​username1,​username2
#METADATA_END

#SUMMARYSTATISTICS_START
bytesTotal,​2924
requestsTotal,​148
#SUMMARYSTATISTICS_END

#COLUMNS_START
startdatetime,​bytes,​requests
#COLUMNS_END

#DATA_START
2021-07-05T10:00:00Z,2523,​1780
2021-07-05T11:00:00Z,3380,​3875
2021-07-05T12:00:00Z,669,​4001
2021-07-05T13:00:00Z,419,​290
#DATA_END

Get report details

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

GET /reporting-api/v1/reports/apiusage-by-time/versions/1

Status 200 application/json

Response body:

{
    "name": "apiusage-by-time",
    "description": "The API usage report allows users to audit which users are using APIs and which APIs are most frequently/heavily used",
    "businessObjectName": "account_id",
    "version": 1,
    "status": "PUBLISHED",
    "deprecated": false,
    "timeBased": true,
    "supportsPagination": false,
    "outputType": "FLAT",
    "requiredProducts": [
        "EDGECONTROL"
    ],
    "requiredRoles": [
        "IDM: API Clients - Admin Access"
    ],
    "available": true,
    "metrics": [
        {
            "name": "bytes",
            "description": "The bandwidth used during the request for the associated URL.",
            "label": "Bytes",
            "unit": "BYTE",
            "summaryStatistic": false
        },
        {
            "name": "bytesTotal",
            "description": "The total bandwidth used for requests.",
            "label": "Total Bytes",
            "unit": "BYTE",
            "summaryStatistic": true
        },
        {
            "name": "requests",
            "description": "Requests.",
            "label": "Requests",
            "unit": "COUNT",
            "summaryStatistic": false
        },
        {
            "name": "requestsTotal",
            "description": "Total requests for a given time frame.",
            "label": "Total Requests",
            "unit": "COUNT",
            "summaryStatistic": true
        }
    ],
    "groupOutlyingValues": {
        "enabled": false
    },
    "groupBy": [
        "startdatetime"
    ],
    "filters": [
        {
            "name": "endpoint",
            "type": "string",
            "description": "An API configuration registered with Akamai.",
            "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": "Bad 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": "response_code",
            "type": "string",
            "description": "An HTTP response status code, for example, 201.",
            "required": false
        },
        {
            "name": "contract_type",
            "type": "string",
            "description": "The list of accounts and contract type IDs a given user has access to.",
            "required": false
        },
        {
            "name": "username",
            "type": "string",
            "description": "Name of client generating API request.",
            "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
        }
    ],
    "intervals": [
        "MONTH",
        "WEEK",
        "DAY",
        "HOUR"
    ],
    "dataRetentionDays": 92,
    "links": [
        {
            "rel": "self",
            "href": "/reporting-api/v1/reports/apiusage-by-time/versions/1"
        },
        {
            "rel": "versions",
            "href": "/reporting-api/v1/reports/apiusage-by-time/versions"
        },
        {
            "rel": "all-reports",
            "href": "/reporting-api/v1/reports"
        },
        {
            "rel": "execute-report",
            "href": "/reporting-api/v1/reports/apiusage-by-time/versions/1/report-data"
        }
    ]
}