endpoint-hits-by-apikey report

The following shows how to generate the endpoint-hits-by-apikey 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 hits data for your API endpoints by the API keys included in the incoming API requests.

Business object: cpcode

Data available for: 90 days

Required products: API Gateway

Available metrics

Metric Description
Data metrics
edgeBytes The volume for the amount of API traffic that left the Akamai network.
edgeHits The request count.
midgressBytes The volume for the amount of internal API traffic exchanged between Akamai edge servers.
Summary metrics
edgeBytesMax The highest volume for the amount of API traffic that left the Akamai network.
edgeBytesMin The lowest volume for the amount of API traffic that left the Akamai network.
edgeBytesTotal The total volume of edge traffic for given objects and filters.
edgeHitsMax The highest number of requests.
edgeHitsMin The lowest number of requests.
edgeHitsTotal The total number of edge requests for given objects and filters.
midgressBytesMax The highest volume for the amount of internal API traffic exchanged between Akamai edge servers.
midgressBytesMin The lowest volume for the amount of internal API traffic exchanged between Akamai edge servers.
midgressBytesTotal The total volume for the amount of internal API traffic exchanged between Akamai edge servers.

Available filters

Filter Type Description
Optional filters
api_key Integer A unique identifier of an API consumer.
endpoint_id Integer The ID of an API configuration registered with Akamai.

Sample report

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

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

Object type: Query

Download schema: report-request-schema.json

Query parameters

Parameter Type Sample Description
Required
start String 2020-05-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-06-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 the set of cpcode values you want to report on.
objectIds Enumeration As an alternative to an array of ID values, specify all as a string for unfiltered data. Either way, objectIds is required.
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": [
        "55232",
        "23433",
        "32433"
    ],
    "metrics": [
        "edgeBytes",
        "edgeBytesMax",
        "edgeBytesMin",
        "edgeBytesTotal",
        "edgeHits",
        "edgeHitsMax",
        "edgeHitsMin",
        "edgeHitsTotal",
        "midgressBytes",
        "midgressBytesMax",
        "midgressBytesMin",
        "midgressBytesTotal"
    ],
    "filters": {
        "api_key": [
            "577596",
            "577595"
        ],
        "endpoint_id": [
            "577596",
            "577598"
        ]
    }
}

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

Sample: /reporting-api/v1/reports/endpoint-hits-by-apikey/versions/1/report-data?start=2020-05-01T00%3A00%3A00Z&end=2020-06-01T00%3A00%3A00Z&objectIds=55232,23433,32433&metrics=edgeBytes%2CedgeBytesMax&filters=api_key%3D577598%2Capi_key%3D577595%2Cendpoint_id%3D577596%2Cendpoint_id%3D577595

Query parameters

Parameter Type Sample Description
Required
start String 2020-05-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.
end String 2020-06-01T00:00:00Z Specifies if unavailable reports should be shown.
Optional
allObjectIds Boolean true As an alternative to objectIds, enabling this generates a report that includes all IDs available for the cpcode objectType. This parameter is ignored if the request also specifies a set of objectIds.
objectIds String 55232,23433,32433 As an alternative to allObjectIds, specifies the set of unique IDs for the cpcode objectType you want to report on, formatted as a comma-delimited list.
metrics String edgeBytes,edgeBytesMax 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 api_key=577598,api_key=577595,endpoint_id=577596,endpoint_id=577595 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.

Status 200 application/json

Object type: Report

Download schema: report-response-schema.json

Response body:

{
    "metadata": {
        "name": "endpoint-hits-by-apikey",
        "version": "1",
        "outputType": "FLAT",
        "groupBy": [
            "endpoint_id",
            "api_key"
        ],
        "start": "2020-05-01T00:00:00Z",
        "end": "2020-06-01T00:00:00Z",
        "availableDataEnds": null,
        "suggestedRetryTime": null,
        "rowCount": 4,
        "filters": [
            {
                "name": "api_key",
                "values": [
                    "577597",
                    "577598"
                ]
            },
            {
                "name": "endpoint_id",
                "values": [
                    "577596",
                    "577597"
                ]
            }
        ],
        "columns": [
            {
                "name": "groupBy",
                "label": "endpoint_id"
            },
            {
                "name": "groupBy",
                "label": "api_key"
            },
            {
                "name": "edgeBytes",
                "label": "Edge Bytes"
            },
            {
                "name": "edgeHits",
                "label": "Edge Bytes"
            },
            {
                "name": "midgressBytes",
                "label": "Midgress Bytes"
            }
        ],
        "objectType": "cpcode",
        "objectIds": [
            "55232",
            "23433",
            "32433"
        ]
    },
    "data": [
        {
            "endpoint_id": "577598",
            "api_key": "577595",
            "edgeBytes": "1473",
            "edgeHits": "2206",
            "midgressBytes": "3962"
        },
        {
            "endpoint_id": "577597",
            "api_key": "577596",
            "edgeBytes": "3339",
            "edgeHits": "3800",
            "midgressBytes": "34"
        },
        {
            "endpoint_id": "577599",
            "api_key": "577599",
            "edgeBytes": "1720",
            "edgeHits": "3927",
            "midgressBytes": "1380"
        },
        {
            "endpoint_id": "577595",
            "api_key": "577598",
            "edgeBytes": "125",
            "edgeHits": "619",
            "midgressBytes": "3525"
        }
    ],
    "summaryStatistics": {
        "edgeBytesMax": {
            "value": "3784",
            "details": {}
        },
        "edgeBytesMin": {
            "value": "1071",
            "details": {}
        },
        "edgeBytesTotal": {
            "value": "3608",
            "details": {}
        },
        "edgeHitsMax": {
            "value": "2142",
            "details": {}
        },
        "edgeHitsMin": {
            "value": "945",
            "details": {}
        },
        "edgeHitsTotal": {
            "value": "1617",
            "details": {}
        },
        "midgressBytesMax": {
            "value": "3897",
            "details": {}
        },
        "midgressBytesMin": {
            "value": "1689",
            "details": {}
        },
        "midgressBytesTotal": {
            "value": "2666",
            "details": {}
        }
    }
}

Status 200 text/csv

Response Body:

#METADATA_START
name,endpoint-hits-by-apikey
version,1
source,endpoint-hits-by-apikey/versions/1
groupBy,endpoint_id,api_key
start,2020-05-01T00:00:00Z
end,2020-06-01T00:00:00Z
availableDataEnds,
suggestedRetryTime,
rowCount,4
objectType,cpcode
objectIds,55232,23433,32433
api_key,577597,577598
endpoint_id,577596,577597
#METADATA_END

#SUMMARYSTATISTICS_START
edgeBytesMax,3784
edgeBytesMin,1071
edgeBytesTotal,3608
edgeHitsMax,2142
edgeHitsMin,945
edgeHitsTotal,1617
midgressBytesMax,3897
midgressBytesMin,1689
midgressBytesTotal,2666
#SUMMARYSTATISTICS_END

#COLUMNS_START
endpoint_id,api_key,edgeBytes,edgeHits,midgressBytes
#COLUMNS_END

#DATA_START
577598,577595,1473,2206,3962
577597,577596,3339,3800,34
577599,577599,1720,3927,1380
577595,577598,125,619,3525
#DATA_END

Get report details

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

GET /reporting-api/v1/reports/endpoint-hits-by-apikey/versions/1

Status 200 application/json

Object type: ReportType

Download schema: data-row-schema.json

Response body:

{
    "name": "endpoint-hits-by-apikey",
    "description": "Provides hits data for your API endpoints by the API keys included in the incoming API requests.",
    "businessObjectName": "cpcode",
    "version": 1,
    "status": "PUBLISHED",
    "deprecated": false,
    "timeBased": false,
    "outputType": "FLAT",
    "requiredProducts": [
        "API Gateway"
    ],
    "requiredRoles": [
        "API Gateway Viewer",
        "API Gateway Administrator"
    ],
    "available": true,
    "metrics": [
        {
            "name": "edgeBytes",
            "description": "The volume for the amount of API traffic that left the Akamai network.",
            "label": "Edge Bytes",
            "unit": "BYTE",
            "summaryStatistic": false
        },
        {
            "name": "edgeBytesMax",
            "description": "The highest volume for the amount of API traffic that left the Akamai network.",
            "label": "Edge Bytes Max",
            "unit": "BYTE",
            "summaryStatistic": true
        },
        {
            "name": "edgeBytesMin",
            "description": "The lowest volume for the amount of API traffic that left the Akamai network.",
            "label": "Edge Bytes Min",
            "unit": "BYTE",
            "summaryStatistic": true
        },
        {
            "name": "edgeBytesTotal",
            "description": "The total volume of edge traffic for given objects and filters.",
            "label": "Total Edge Bytes",
            "unit": "BYTE",
            "summaryStatistic": true
        },
        {
            "name": "edgeHits",
            "description": "The request count.",
            "label": "Edge Bytes",
            "unit": "COUNT",
            "summaryStatistic": false
        },
        {
            "name": "edgeHitsMax",
            "description": "The highest number of requests.",
            "label": "Edge Hits Max",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "edgeHitsMin",
            "description": "The lowest number of requests.",
            "label": "Edge Hits Min",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "edgeHitsTotal",
            "description": "The total number of edge requests for given objects and filters.",
            "label": "Total Edge Hits",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "midgressBytes",
            "description": "The volume for the amount of internal API traffic exchanged between Akamai edge servers.",
            "label": "Midgress Bytes",
            "unit": "BYTE",
            "summaryStatistic": false
        },
        {
            "name": "midgressBytesMax",
            "description": "The highest volume for the amount of internal API traffic exchanged between Akamai edge servers.",
            "label": "Midgress Bytes Max",
            "unit": "BYTE",
            "summaryStatistic": true
        },
        {
            "name": "midgressBytesMin",
            "description": "The lowest volume for the amount of internal API traffic exchanged between Akamai edge servers.",
            "label": "Midgress Bytes Min",
            "unit": "BYTE",
            "summaryStatistic": true
        },
        {
            "name": "midgressBytesTotal",
            "description": "The total volume for the amount of internal API traffic exchanged between Akamai edge servers.",
            "label": "Total Midgress Bytes",
            "unit": "BYTE",
            "summaryStatistic": true
        }
    ],
    "groupOutlyingValues": {
        "enabled": false
    },
    "groupBy": [
        "endpoint_id",
        "api_key"
    ],
    "filters": [
        {
            "name": "api_key",
            "type": "int",
            "description": "A unique identifier of an API consumer.",
            "required": false
        },
        {
            "name": "endpoint_id",
            "type": "int",
            "description": "The ID of an API configuration registered with Akamai.",
            "required": false
        }
    ],
    "intervals": [
        "MONTH",
        "WEEK",
        "DAY",
        "HOUR",
        "FIVE_MINUTES"
    ],
    "dataRetentionDays": 90,
    "links": [
        {
            "rel": "self",
            "href": "/reporting-reports-executor-api/v1/reports/endpoint-hits-by-apikey/versions/1"
        },
        {
            "rel": "versions",
            "href": "/reporting-reports-executor-api/v1/reports/endpoint-hits-by-apikey/versions"
        },
        {
            "rel": "all-reports",
            "href": "/reporting-reports-executor-api/v1/reports"
        },
        {
            "rel": "execute-report",
            "href": "/reporting-reports-executor-api/v1/reports/endpoint-hits-by-apikey/versions/1/report-data"
        }
    ]
}