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

Returns traffic data by Canadian province.

Business object: cpcode

Data available for: 92 days

Available metrics

Metric	Description
Data metrics
`edgeBytes`	The volume for the traffic delivered from Akamai to the end user.
`edgeHits`	The request count delivered from Akamai edge servers to the end user.
`province`	Province.

Available filters

Filter	Type	Description
Optional filters
`delivery_type`	Enumeration	Distinguishes secure from non-secure traffic.
		`secure`: Secure traffic.
		`non_secure`: Non-secure traffic.
`http_version`	Enumeration	HTTP version.
		`https1.1`: https1.1
		`http2`: http2
		`http3`: http3
		`http1.1`: http1.1

POST request

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

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

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",
        "edgeHits",
        "province"
    ],
    "filters": {
        "delivery_type": [
            "secure",
            "non-secure"
        ],
        "http_version": [
            "https1.1",
            "http2"
        ]
    }
}

GET request

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

Sample: /reporting-api/v1/reports/enhancedtraffic-by-province/versions/1/report-data?start=2020-05-01T00%3A00%3A00Z&end=2020-06-01T00%3A00%3A00Z&objectIds=55232,23433,32433&metrics=edgeBytes%2CedgeHits&filters=delivery_type%3Dsecure%2Cdelivery_type%3Dnon-secure

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
`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,edgeHits`	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	`delivery_type=secure,delivery_type=non-secure`	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": "enhancedtraffic-by-province",
        "version": "1",
        "outputType": "FLAT",
        "groupBy": [
            "geoid"
        ],
        "start": "2022-05-01T00:00:00Z",
        "end": "2022-06-01T00:00:00Z",
        "availableDataEnds": null,
        "suggestedRetryTime": null,
        "rowCount": 4,
        "filters": [
            {
                "name": "delivery_type",
                "values": [
                    "secure",
                    "non-secure"
                ]
            },
            {
                "name": "http_version",
                "values": [
                    "https1.1",
                    "http2"
                ]
            }
        ],
        "columns": [
            {
                "name": "groupBy",
                "label": "geoid"
            },
            {
                "name": "edgeBytes",
                "label": "Edge Bytes"
            },
            {
                "name": "edgeHits",
                "label": "Edge Hits"
            },
            {
                "name": "province",
                "label": "Province"
            }
        ],
        "objectType": "cpcode",
        "objectIds": [
            "55232",
            "23433",
            "32433"
        ]
    },
    "data": [
        {
            "geoid": "BR",
            "edgeBytes": "1074",
            "edgeHits": "3496",
            "province": "NL"
        },
        {
            "geoid": "ES",
            "edgeBytes": "3554",
            "edgeHits": "3435",
            "province": "YT"
        },
        {
            "geoid": "CH",
            "edgeBytes": "2944",
            "edgeHits": "3993",
            "province": "Other"
        },
        {
            "geoid": "JP",
            "edgeBytes": "1087",
            "edgeHits": "3360",
            "province": "NS"
        }
    ],
    "summaryStatistics": {}
}

CSV response

Status 200 text/csv

Response Body:

#METADATA_START
name,enhancedtraffic-by-province
version,1
source,enhancedtraffic-by-province/versions/1
groupBy,geoid
start,2022-05-01T00:00:00Z
end,2022-06-01T00:00:00Z
availableDataEnds,
suggestedRetryTime,
rowCount,4
objectType,cpcode
objectIds,55232,23433,32433
delivery_type,secure,non-secure
http_version,https1.1,http2
#METADATA_END

#SUMMARYSTATISTICS_START

#SUMMARYSTATISTICS_END

#COLUMNS_START
geoid,edgeBytes,edgeHits,province
#COLUMNS_END

#DATA_START
BR,1074,3496,NL
ES,3554,3435,YT
CH,2944,3993,Other
JP,1087,3360,NS
#DATA_END

Get report details

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

GET /reporting-api/v1/reports/enhancedtraffic-by-province/versions/1

Status 200 application/json

Response body:

{
    "name": "enhancedtraffic-by-province",
    "description": "Returns traffic data by Canadian province.",
    "businessObjectName": "cpcode",
    "version": 1,
    "status": "PUBLISHED",
    "deprecated": false,
    "timeBased": false,
    "supportsPagination": false,
    "outputType": "FLAT",
    "requiredProducts": [
        "Basic Traffic Reports"
    ],
    "requiredRoles": [
        "Reports - All privileges",
        "Reports - View only",
        "OTA App User"
    ],
    "available": true,
    "metrics": [
        {
            "name": "edgeBytes",
            "description": "The volume for the traffic delivered from Akamai to the end user.",
            "label": "Edge Bytes",
            "unit": "BYTE",
            "summaryStatistic": false
        },
        {
            "name": "edgeHits",
            "description": "The request count delivered from Akamai edge servers to the end user.",
            "label": "Edge Hits",
            "unit": "COUNT",
            "summaryStatistic": false
        },
        {
            "name": "province",
            "description": "Province.",
            "label": "Province",
            "unit": "STRING",
            "summaryStatistic": false
        }
    ],
    "groupOutlyingValues": {
        "enabled": false
    },
    "groupBy": [
        "geoid"
    ],
    "filters": [
        {
            "name": "http_version",
            "type": "enum",
            "description": "HTTP version. ",
            "values": [
                {
                    "value": "https1.1",
                    "description": "https1.1"
                },
                {
                    "value": "http2",
                    "description": "http2"
                },
                {
                    "value": "http3",
                    "description": "http3"
                },
                {
                    "value": "http1.1",
                    "description": "http1.1"
                }
            ],
            "required": false
        },
        {
            "name": "delivery_type",
            "type": "enum",
            "description": "Distinguishes secure from non-secure traffic.",
            "values": [
                {
                    "value": "secure",
                    "description": "Secure traffic.  "
                },
                {
                    "value": "non_secure",
                    "description": "Non-secure traffic. "
                }
            ],
            "required": false
        }
    ],
    "intervals": [
        "MONTH",
        "WEEK",
        "DAY"
    ],
    "dataRetentionDays": 92,
    "links": [
        {
            "rel": "self",
            "href": "/reporting-api/v1/reports/enhancedtraffic-by-province/versions/1"
        },
        {
            "rel": "versions",
            "href": "/reporting-api/v1/reports/enhancedtraffic-by-province/versions"
        },
        {
            "rel": "all-reports",
            "href": "/reporting-api/v1/reports"
        },
        {
            "rel": "execute-report",
            "href": "/reporting-api/v1/reports/enhancedtraffic-by-province/versions/1/report-data"
        }
    ]
}