The purge-usage-by-source 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-source 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 by source.
Business object: account_id
Data available for: 45 days
Required products: EDGECONTROL
Available metrics
| Metric | Description |
|---|---|
| Data metrics | |
requestCount | Total traffic by segments. |
requestPercent | Request percent. |
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-source/versions/2/report-data{?start,end}
Sample: /reporting-api/v1/reports/purge-usage-by-source/versions/2/report-data?start=2023-05-01T00%3A00%3A00Z&end=2023-06-01T00%3A00%3A00Z
Query parameters
| Parameter | Type | Sample | Description |
|---|---|---|---|
| Required | |||
start | String | 2023-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 | 2023-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 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": [
"requestCount",
"requestPercent"
],
"filters": {
"client_id": [
"client3",
"client5"
],
"client_name": [
"name5",
"name4"
],
"client_owner": [
"owner3",
"owner5"
],
"contract_type": [
"1-3CV382"
],
"environment": [
"STAGING",
"PRODUCTION"
],
"request_action": [
"invalidate",
"delete"
],
"request_source": [
"EDGEGRID",
"PORTAL"
],
"request_type": [
"TAG",
"VCD"
],
"response_class": [
"1xx",
"3xx"
],
"response_code": [
"404",
"503"
],
"response_status": [
"success",
"error"
]
}
}
GET request
GET /reporting-api/v1/reports/purge-usage-by-source/versions/2/report-data{?start,end,objectIds,metrics,filters}
Sample: /reporting-api/v1/reports/purge-usage-by-source/versions/2/report-data?start=2023-05-01T00%3A00%3A00Z&end=2023-06-01T00%3A00%3A00Z&objectIds=1-123A&metrics=requestCount%2CrequestPercent&filters=client_id%3Dclient2%2Cclient_id%3Dclient4%2Cclient_name%3Dname4%2Cclient_name%3Dname3
Query parameters
| Parameter | Type | Sample | Description |
|---|---|---|---|
| Required | |||
start | String | 2023-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 | 2023-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. |
objectIds | String | 1-123A | Specifies the account_id value you want to report on. |
| Optional | |||
metrics | String | requestCount,requestPercent | 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=client2,client_id=client4,client_name=name4,client_name=name3 | 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-source",
"version": "2",
"outputType": "FLAT",
"groupBy": [
"source"
],
"start": "2023-05-01T00:00:00Z",
"end": "2023-06-01T00:00:00Z",
"availableDataEnds": null,
"suggestedRetryTime": null,
"rowCount": 4,
"filters": [
{
"name": "client_id",
"values": [
"client1",
"client3"
]
},
{
"name": "client_name",
"values": [
"name3",
"name4"
]
},
{
"name": "client_owner",
"values": [
"owner4",
"owner1"
]
},
{
"name": "contract_type",
"values": [
"1-3CV382"
]
},
{
"name": "environment",
"values": [
"STAGING",
"PRODUCTION"
]
},
{
"name": "request_action",
"values": [
"delete",
"invalidate"
]
},
{
"name": "request_source",
"values": [
"PORTAL",
"EDGEGRID"
]
},
{
"name": "request_type",
"values": [
"TAG",
"ARL"
]
},
{
"name": "response_class",
"values": [
"3xx",
"4xx"
]
},
{
"name": "response_code",
"values": [
"100",
"403"
]
},
{
"name": "response_status",
"values": [
"success",
"error"
]
}
],
"columns": [
{
"name": "groupBy",
"label": "source"
},
{
"name": "requestCount",
"label": "Requests"
},
{
"name": "requestPercent",
"label": "Requests %"
}
],
"objectType": "account_id",
"objectIds": [
"1-123A"
]
},
"data": [
{
"source": "Other",
"requestCount": "2919",
"requestPercent": "47"
},
{
"source": "PORTAL",
"requestCount": "845",
"requestPercent": "60"
}
],
"summaryStatistics": {}
}
CSV response
Status 200 text/csv
Response Body:
#METADATA_START
name,purge-usage-by-source
version,2
source,purge-usage-by-source/versions/2
groupBy,source
start,2023-05-01T00:00:00Z
end,2023-06-01T00:00:00Z
availableDataEnds,
suggestedRetryTime,
rowCount,4
objectType,account_id
objectIds,1-123A
client_id,client1,client3
client_name,name3,name4
client_owner,owner4,owner1
contract_type,1-3CV382
environment,STAGING,PRODUCTION
request_action,delete,invalidate
request_source,PORTAL,EDGEGRID
request_type,TAG,ARL
response_class,3xx,4xx
response_code,100,403
response_status,success,error
#METADATA_END
#SUMMARYSTATISTICS_START
#SUMMARYSTATISTICS_END
#COLUMNS_START
source,requestCount,requestPercent
#COLUMNS_END
#DATA_START
EDGEGRID,2919,47
PORTAL,845,60
#DATA_END
Get report details
This sample Get a report type operation gets the same information you need to run the purge-usage-by-source report as provided in this reference documentation, but available dynamically to your API client application.
GET /reporting-api/v1/reports/purge-usage-by-source/versions/2
Status 200 application/json
Response body:
{
"name": "purge-usage-by-source",
"description": "Details of purge requests by source.",
"businessObjectName": "account_id",
"version": 2,
"status": "DEPRECATED",
"deprecated": true,
"timeBased": false,
"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": "requestPercent",
"description": "Request percent.",
"label": "Requests %",
"unit": "RATIO",
"summaryStatistic": false
}
],
"groupOutlyingValues": {
"enabled": false
},
"groupBy": [
"source"
],
"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": "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
},
{
"name": "client_name",
"type": "string",
"description": "Client name.",
"required": false
}
],
"intervals": [
"MONTH",
"WEEK",
"DAY",
"HOUR",
"FIVE_MINUTES"
],
"dataRetentionDays": 45,
"links": [
{
"rel": "self",
"href": "/reporting-api/v1/reports/purge-usage-by-source/versions/2"
},
{
"rel": "versions",
"href": "/reporting-api/v1/reports/purge-usage-by-source/versions"
},
{
"rel": "all-reports",
"href": "/reporting-api/v1/reports"
},
{
"rel": "execute-report",
"href": "/reporting-api/v1/reports/purge-usage-by-source/versions/2/report-data"
}
]
}