The purge-usage-by-time report is being discontinued
This report is deprecated and will be deactivated on July 1, 2025. As an alternative, use the new delivery/purge/usage report, based on the Reporting API v2.
The following shows how to generate the purge-usage-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
Details of purge requests and objects by time.
This report allows you to configure the aggregation interval for each data record. Available interval values are: MONTH, WEEK, DAY, HOUR, FIVE_MINUTES.
Business object: account_id
Data available for: 45 days
Required products: EDGECONTROL
Available metrics
| Metric | Description |
|---|---|
| Data metrics | |
objectCount | Object count. |
requestCount | Total traffic by segments. |
| Summary metrics | |
objectCountTotal | Object count total. |
requestCountTotal | The number of HTTP transactions per second delivered through the edge platform to your end users. |
Available filters
| Filter | Type | Description |
|---|---|---|
| Required filters | ||
contract_type | String | A contract type ID a given user has access to. |
| Optional filters | ||
client_id | String | Client Id. |
client_name | String | Client name. |
client_owner | String | Client owner. |
environment | Enumeration | Environment. |
STAGING: Staging. | ||
PRODUCTION: Production. | ||
request_action | Enumeration | Request action. |
invalidate: Invalidate. | ||
delete: Delete. | ||
request_source | Enumeration | Request source. |
EDGEGRID: Edgegrid. | ||
PORTAL: Portal. | ||
request_type | Enumeration | Request type. |
CPCODE: CP code | ||
VCD: VCD | ||
ARL: ARL | ||
TAG: TAG | ||
URL: URL | ||
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. |
success: Successful HTTP response status. | ||
error: Error HTTP response status. |
POST request
POST /reporting-api/v1/reports/purge-usage-by-time/versions/2/report-data{?start,end,interval}
Sample: /reporting-api/v1/reports/purge-usage-by-time/versions/2/report-data?start=2023-06-27T13%3A55%3A00Z&end=2023-06-27T14%3A15%3A00Z&interval=FIVE_MINUTES
For other granularity, you need to adjust start and end dates:
Sample with longer interval: /reporting-api/v1/reports/purge-usage-by-time/versions/2/report-data?start=2023-02-01&end=2023-06-01&interval=MONTH
Query parameters
| Parameter | Type | Sample | Description |
|---|---|---|---|
| Required | |||
start | String | 2023-06-27T13: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 | 2023-06-27T14: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. |
interval | Enumeration | FIVE_MINUTES | The duration of each data record. Available values: MONTH, WEEK, DAY, HOUR, FIVE_MINUTES. |
JSON request members
| Member | Type | Description |
|---|---|---|
objectIds | Array | Specifies the account_id value 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": [
"1-123A"
],
"metrics": [
"objectCount",
"objectCountTotal",
"requestCount",
"requestCountTotal"
],
"filters": {
"client_id": [
"client2",
"client4"
],
"client_name": [
"name4",
"name2"
],
"client_owner": [
"owner1",
"owner4"
],
"contract_type": [
"1-3CV382"
],
"environment": [
"STAGING",
"PRODUCTION"
],
"request_action": [
"invalidate",
"delete"
],
"request_source": [
"PORTAL",
"EDGEGRID"
],
"request_type": [
"TAG",
"URL"
],
"response_class": [
"2xx",
"3xx"
],
"response_code": [
"500",
"503"
],
"response_status": [
"success",
"error"
]
}
}
GET request
GET /reporting-api/v1/reports/purge-usage-by-time/versions/2/report-data{?start,end,interval,objectIds,metrics,filters}
Sample: /reporting-api/v1/reports/purge-usage-by-time/versions/2/report-data?start=2023-06-27T13%3A55%3A00Z&end=2023-06-27T14%3A15%3A00Z&interval=FIVE_MINUTES&objectIds=1-123A&metrics=objectCount%2CobjectCountTotal&filters=client_id%3Dclient3%2Cclient_id%3Dclient1%2Cclient_name%3Dname2%2Cclient_name%3Dname5
Query parameters
| Parameter | Type | Sample | Description |
|---|---|---|---|
| Required | |||
start | String | 2023-06-27T13: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 | 2023-06-27T14: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. |
interval | Enumeration | FIVE_MINUTES | The duration of each data record. Available values: MONTH, WEEK, DAY, HOUR, FIVE_MINUTES. |
objectIds | String | 1-123A | Specifies the account_id value you want to report on. |
| Optional | |||
metrics | String | objectCount,objectCountTotal | 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 | client_id=client3,client_id=client1,client_name=name2,client_name=name5 | 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": "purge-usage-by-time",
"version": "2",
"outputType": "FLAT",
"groupBy": [
"startdatetime"
],
"interval": "FIVE_MINUTES",
"start": "2023-06-27T13:55:00Z",
"end": "2023-06-27T14:15:00Z",
"availableDataEnds": null,
"suggestedRetryTime": null,
"rowCount": 4,
"filters": [
{
"name": "client_id",
"values": [
"client1",
"client5"
]
},
{
"name": "client_name",
"values": [
"name5",
"name4"
]
},
{
"name": "client_owner",
"values": [
"owner3",
"owner1"
]
},
{
"name": "contract_type",
"values": [
"1-3CV382"
]
},
{
"name": "environment",
"values": [
"STAGING",
"PRODUCTION"
]
},
{
"name": "request_action",
"values": [
"invalidate",
"delete"
]
},
{
"name": "request_source",
"values": [
"PORTAL",
"EDGEGRID"
]
},
{
"name": "request_type",
"values": [
"URL",
"ARL"
]
},
{
"name": "response_class",
"values": [
"1xx",
"5xx"
]
},
{
"name": "response_code",
"values": [
"201",
"200"
]
},
{
"name": "response_status",
"values": [
"success",
"error"
]
}
],
"columns": [
{
"name": "groupBy",
"label": "startdatetime"
},
{
"name": "objectCount",
"label": "Objects"
},
{
"name": "requestCount",
"label": "Requests"
}
],
"objectType": "account_id",
"objectIds": [
"1-123A"
]
},
"data": [
{
"startdatetime": "2023-06-27T13:55:00Z",
"objectCount": "641",
"requestCount": "4566"
},
{
"startdatetime": "2023-06-27T14:00:00Z",
"objectCount": "1153",
"requestCount": "1413"
},
{
"startdatetime": "2023-06-27T14:05:00Z",
"objectCount": "1384",
"requestCount": "928"
},
{
"startdatetime": "2023-06-27T14:10:00Z",
"objectCount": "2472",
"requestCount": "180"
}
],
"summaryStatistics": {
"objectCountTotal": {
"value": "840",
"details": {}
},
"requestCountTotal": {
"value": "3698",
"details": {}
}
}
}
CSV response
Status 200 text/csv
Response Body:
#METADATA_START
name,purge-usage-by-time
version,2
source,purge-usage-by-time/versions/2
groupBy,startdatetime
start,2023-06-27T13:55:00Z
end,2023-06-27T14:15:00Z
interval,`FIVE_MINUTES`
availableDataEnds,
suggestedRetryTime,
rowCount,4
objectType,account_id
objectIds,1-123A
client_id,client1,client5
client_name,name5,name4
client_owner,owner3,owner1
contract_type,1-3CV382
environment,STAGING,PRODUCTION
request_action,invalidate,delete
request_source,PORTAL,EDGEGRID
request_type,URL,ARL
response_class,1xx,5xx
response_code,201,200
response_status,success,error
#METADATA_END
#SUMMARYSTATISTICS_START
objectCountTotal,840
requestCountTotal,3698
#SUMMARYSTATISTICS_END
#COLUMNS_START
startdatetime,objectCount,requestCount
#COLUMNS_END
#DATA_START
2023-06-27T13:55:00Z,641,4566
2023-06-27T14:00:00Z,1153,1413
2023-06-27T14:05:00Z,1384,928
2023-06-27T14:10:00Z,2472,180
#DATA_END
Get report details
This sample Get a report type operation gets the same information you need to run the purge-usage-by-time report as provided in this reference documentation, but available dynamically to your API client application.
GET /reporting-api/v1/reports/purge-usage-by-time/versions/2
Status 200 application/json
Response body:
{
"name": "purge-usage-by-time",
"description": "Details of purge requests and objects by time.",
"businessObjectName": "account_id",
"version": 2,
"status": "DEPRECATED",
"deprecated": true,
"timeBased": true,
"supportsPagination": false,
"outputType": "FLAT",
"requiredProducts": [
"EDGECONTROL"
],
"requiredRoles": [
"IDM: API Clients - Admin Access"
],
"available": true,
"metrics": [
{
"name": "requestCount",
"description": "Total traffic by segments.",
"label": "Requests",
"unit": "COUNT",
"summaryStatistic": false
},
{
"name": "objectCount",
"description": "Object count.",
"label": "Objects",
"unit": "COUNT",
"summaryStatistic": false
},
{
"name": "requestCountTotal",
"description": "The number of HTTP transactions per second delivered through the edge platform to your end users.",
"label": "Requests Total",
"unit": "COUNT",
"summaryStatistic": true
},
{
"name": "objectCountTotal",
"description": "Object count total.",
"label": "Objects Total",
"unit": "COUNT",
"summaryStatistic": true
}
],
"groupOutlyingValues": {
"enabled": false
},
"groupBy": [
"startdatetime"
],
"filters": [
{
"name": "client_owner",
"type": "string",
"description": "Client owner.",
"required": false
},
{
"name": "response_code",
"type": "string",
"description": "An HTTP response status code, for example, 201.",
"required": false
},
{
"name": "environment",
"type": "enum",
"description": "Environment.",
"values": [
{
"value": "STAGING",
"description": "Staging."
},
{
"value": "PRODUCTION",
"description": "Production."
}
],
"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": "contract_type",
"type": "string",
"description": "A contract type ID a given user has access to.",
"required": true
},
{
"name": "client_id",
"type": "string",
"description": "Client Id.",
"required": false
},
{
"name": "request_action",
"type": "enum",
"description": "Request action.",
"values": [
{
"value": "invalidate",
"description": "Invalidate."
},
{
"value": "delete",
"description": "Delete."
}
],
"required": false
},
{
"name": "request_source",
"type": "enum",
"description": "Request source.",
"values": [
{
"value": "EDGEGRID",
"description": "Edgegrid."
},
{
"value": "PORTAL",
"description": "Portal."
}
],
"required": false
},
{
"name": "client_name",
"type": "string",
"description": "Client name.",
"required": false
},
{
"name": "request_type",
"type": "enum",
"description": "Request type.",
"values": [
{
"value": "CPCODE",
"description": "CP code"
},
{
"value": "VCD",
"description": "VCD"
},
{
"value": "ARL",
"description": "ARL"
},
{
"value": "TAG",
"description": "TAG"
},
{
"value": "URL",
"description": "URL"
}
],
"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
}
],
"intervals": [
"MONTH",
"WEEK",
"DAY",
"HOUR",
"FIVE_MINUTES"
],
"dataRetentionDays": 45,
"links": [
{
"rel": "self",
"href": "/reporting-api/v1/reports/purge-usage-by-time/versions/2"
},
{
"rel": "versions",
"href": "/reporting-api/v1/reports/purge-usage-by-time/versions"
},
{
"rel": "all-reports",
"href": "/reporting-api/v1/reports"
},
{
"rel": "execute-report",
"href": "/reporting-api/v1/reports/purge-usage-by-time/versions/2/report-data"
}
]
}