The purge-audit-requests-details-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/audit-requests-details report, based on the Reporting API v2.
The following shows how to generate the purge-audit-requests-details-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
Provides purge requests audit details.
Business object: account_id
Data available for: 45 days
Required products: EDGECONTROL
Available metrics
| Metric | Description |
|---|---|
| Data metrics | |
accountSwitchingEnabled | Account switching enabled. |
apiVersion | API version. |
arlCount | ARL count. |
authorizationClientToken | Authorization Client Token. |
badRequestObject | Bad request object. |
clientId | ID of client generating API request. |
clientName | Client name. |
clientOwner | Username of client owner. |
consumerTokenHostname | Consumer Token Hostname. |
contentLength | Content length. |
contentType | Content type. |
cpcodeCount | CP code count. |
cpcodePurgeEnabled | CP code purge enabled. |
elapsedTime | Elapsed time. |
environment | Environment. |
errorTitle | Error title. |
httpMethod | HTTP method. |
objectCount | Object count. |
requestAction | Request action. |
requestSource | Request source. |
requestType | Request type. |
responseCode | Response code for the API request. |
sourceClientIp | Source Client IP. |
supportId | Support Id. |
tagCount | TAG count. |
tagPurgeEnabled | TAG Purge enabled. |
timestamp | Date and time of API request. |
urlCount | URL count. |
userAgent | User Agent. |
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. | ||
support_id | String | Support Id. |
POST request
POST /reporting-api/v1/reports/purge-audit-requests-details-by-time/versions/2/report-data{?start,end}
Sample: /reporting-api/v1/reports/purge-audit-requests-details-by-time/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 theaccount_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": [
"accountSwitchingEnabled",
"apiVersion",
"arlCount",
"authorizationClientToken",
"badRequestObject",
"clientId",
"clientName",
"clientOwner",
"consumerTokenHostname",
"contentLength",
"contentType",
"cpcodeCount",
"cpcodePurgeEnabled",
"elapsedTime",
"environment",
"errorTitle",
"httpMethod",
"objectCount",
"requestAction",
"requestSource",
"requestType",
"responseCode",
"sourceClientIp",
"supportId",
"tagCount",
"tagPurgeEnabled",
"timestamp",
"urlCount",
"userAgent"
],
"filters": {
"client_id": [
"client3",
"client1"
],
"client_name": [
"name1",
"name5"
],
"client_owner": [
"owner2",
"owner3"
],
"contract_type": [
"1-3CV382"
],
"environment": [
"STAGING",
"PRODUCTION"
],
"request_action": [
"invalidate",
"delete"
],
"request_source": [
"PORTAL",
"EDGEGRID"
],
"request_type": [
"ARL",
"URL"
],
"response_class": [
"5xx",
"1xx"
],
"response_code": [
"503",
"201"
],
"response_status": [
"success",
"error"
],
"support_id": [
"support4",
"support2"
]
}
}
GET request
GET /reporting-api/v1/reports/purge-audit-requests-details-by-time/versions/2/report-data{?start,end,objectIds,metrics,filters}
Sample: /reporting-api/v1/reports/purge-audit-requests-details-by-time/versions/2/report-data?start=2023-05-01T00%3A00%3A00Z&end=2023-06-01T00%3A00%3A00Z&objectIds=1-123A&metrics=accountSwitchingEnabled%2CapiVersion&filters=client_id%3Dclient1%2Cclient_id%3Dclient3%2Cclient_name%3Dname2%2Cclient_name%3Dname1
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 | accountSwitchingEnabled,apiVersion | 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=client1,client_id=client5,client_name=name1,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-audit-requests-details-by-time",
"version": "2",
"outputType": "FLAT",
"start": "2023-05-01T00:00:00Z",
"end": "2023-06-01T00:00:00Z",
"availableDataEnds": null,
"suggestedRetryTime": null,
"rowCount": 4,
"filters": [
{
"name": "client_id",
"values": [
"client4",
"client5"
]
},
{
"name": "client_name",
"values": [
"name4",
"name5"
]
},
{
"name": "client_owner",
"values": [
"owner4",
"owner5"
]
},
{
"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",
"TAG"
]
},
{
"name": "response_class",
"values": [
"0xx",
"3xx"
]
},
{
"name": "response_code",
"values": [
"200",
"404"
]
},
{
"name": "response_status",
"values": [
"success",
"error"
]
},
{
"name": "support_id",
"values": [
"support5",
"support3"
]
}
],
"columns": [
{
"name": "accountSwitchingEnabled",
"label": "Account Switching Enabled"
},
{
"name": "apiVersion",
"label": "API Version"
},
{
"name": "arlCount",
"label": "ARL Count"
},
{
"name": "authorizationClientToken",
"label": "Authorization Client Token"
},
{
"name": "badRequestObject",
"label": "Bad Request Object"
},
{
"name": "clientId",
"label": "Client Id"
},
{
"name": "clientName",
"label": "Client Name"
},
{
"name": "clientOwner",
"label": "Client Owner"
},
{
"name": "consumerTokenHostname",
"label": "Consumer Token Hostname"
},
{
"name": "contentLength",
"label": "Content Length"
},
{
"name": "contentType",
"label": "Content Type"
},
{
"name": "cpcodeCount",
"label": "Cpcode Count"
},
{
"name": "cpcodePurgeEnabled",
"label": "Cpcode Purge Enabled"
},
{
"name": "elapsedTime",
"label": "Elapsed Time"
},
{
"name": "environment",
"label": "Environment"
},
{
"name": "errorTitle",
"label": "Error Title"
},
{
"name": "httpMethod",
"label": "HTTP Method"
},
{
"name": "objectCount",
"label": "Objects"
},
{
"name": "requestAction",
"label": "Request Action"
},
{
"name": "requestSource",
"label": "Request Source"
},
{
"name": "requestType",
"label": "Request Type"
},
{
"name": "responseCode",
"label": "Response Code"
},
{
"name": "sourceClientIp",
"label": "Source Client IP"
},
{
"name": "supportId",
"label": "Support Id"
},
{
"name": "tagCount",
"label": "Tag Count"
},
{
"name": "tagPurgeEnabled",
"label": "Tag Purge Enabled"
},
{
"name": "timestamp",
"label": "Timestamp"
},
{
"name": "urlCount",
"label": "URL Count"
},
{
"name": "userAgent",
"label": "User Agent"
}
],
"objectType": "account_id",
"objectIds": [
"1-123A"
]
},
"data": [
{
"timestamp": "1684266297244",
"supportId": "support2",
"clientOwner": "owner1",
"clientId": "client3",
"sourceClientIp": "2250.250.250.250",
"authorizationClientToken": "token2",
"requestAction": "invalidate",
"requestType": "ARL",
"requestSource": "EDGEGRID",
"environment": "STAGING",
"responseCode": "403",
"errorTitle": "title2",
"clientName": "name4",
"consumerTokenHostname": "www.example.net",
"apiVersion": "v2",
"httpMethod": "PUT",
"userAgent": "curl/7.68.0",
"contentType": "text/html",
"contentLength": "155",
"objectCount": "4558",
"urlCount": "1",
"arlCount": "4121",
"cpcodeCount": "12345",
"tagCount": "1553",
"badRequestObject": "https://www.example.com/about/index.html",
"elapsedTime": "445",
"cpcodePurgeEnabled": "0",
"tagPurgeEnabled": "0",
"accountSwitchingEnabled": "1"
}
],
"summaryStatistics": {}
}
CSV response
Status 200 text/csv
Response Body:
#METADATA_START
name,purge-audit-requests-details-by-time
version,2
source,purge-audit-requests-details-by-time/versions/2
start,2023-05-01T00:00:00Z
end,2023-06-01T00:00:00Z
availableDataEnds,
suggestedRetryTime,
rowCount,4
objectType,account_id
objectIds,1-123A
client_id,client4,client5
client_name,name4,name5
client_owner,owner4,owner5
contract_type,1-3CV382
environment,STAGING,PRODUCTION
request_action,invalidate,delete
request_source,PORTAL,EDGEGRID
request_type,URL,TAG
response_class,0xx,3xx
response_code,200,404
response_status,success,error
support_id,support5,support3
#METADATA_END
#SUMMARYSTATISTICS_START
#SUMMARYSTATISTICS_END
#COLUMNS_START
timestamp,supportId,clientOwner,clientId,sourceClientIp,authorizationClientToken,requestAction,requestType,requestSource,environment,responseCode,errorTitle,clientName,consumerTokenHostname,apiVersion,httpMethod,userAgent,contentType,contentLength,objectCount,urlCount,arlCount,cpcodeCount,tagCount,badRequestObject,elapsedTime,cpcodePurgeEnabled,tagPurgeEnabled,accountSwitchingEnabled
#COLUMNS_END
#DATA_START
1684266297244,support2,owner1,client3,2250.250.250.250,token2,invalidate,text/html,EDGEGRID,STAGING,403,title2,name4,www.example.net,v2,PUT,curl/7.68.0,text/html,155,4558,1,4121,12345,1553,https://www.example.com/about/index.html,445,0,0,1
#DATA_END
Get report details
This sample Get a report type operation gets the same information you need to run the purge-audit-requests-details-by-time report as provided in this reference documentation, but available dynamically to your API client application.
GET /reporting-api/v1/reports/purge-audit-requests-details-by-time/versions/2
Status 200 application/json
Response body:
{
"name": "purge-audit-requests-details-by-time",
"description": "Provides purge requests audit details.",
"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": "timestamp",
"description": "Date and time of API request.",
"label": "Timestamp",
"unit": "MILLISECOND",
"summaryStatistic": false
},
{
"name": "supportId",
"description": "Support Id.",
"label": "Support Id",
"unit": "STRING",
"summaryStatistic": false
},
{
"name": "clientOwner",
"description": "Username of client owner.",
"label": "Client Owner",
"unit": "STRING",
"summaryStatistic": false
},
{
"name": "clientId",
"description": "ID of client generating API request.",
"label": "Client Id",
"unit": "STRING",
"summaryStatistic": false
},
{
"name": "sourceClientIp",
"description": "source client IP.",
"label": "Source Client IP",
"unit": "STRING",
"summaryStatistic": false
},
{
"name": "authorizationClientToken",
"description": "Authorization Client Token.",
"label": "Authorization Client Token",
"unit": "STRING",
"summaryStatistic": false
},
{
"name": "requestAction",
"description": "Request action.",
"label": "Request Action",
"unit": "STRING",
"summaryStatistic": false
},
{
"name": "requestType",
"description": "Request type.",
"label": "Request Type",
"unit": "STRING",
"summaryStatistic": false
},
{
"name": "requestSource",
"description": "Request source.",
"label": "Request Source",
"unit": "STRING",
"summaryStatistic": false
},
{
"name": "environment",
"description": "Environment.",
"label": "Environment",
"unit": "STRING",
"summaryStatistic": false
},
{
"name": "responseCode",
"description": "Response code for the API request.",
"label": "Response Code",
"unit": "STRING",
"summaryStatistic": false
},
{
"name": "errorTitle",
"description": "Error title.",
"label": "Error Title",
"unit": "STRING",
"summaryStatistic": false
},
{
"name": "clientName",
"description": "Client name.",
"label": "Client Name",
"unit": "STRING",
"summaryStatistic": false
},
{
"name": "consumerTokenHostname",
"description": "Consumer Token Hostname.",
"label": "Consumer Token Hostname",
"unit": "STRING",
"summaryStatistic": false
},
{
"name": "apiVersion",
"description": "API version.",
"label": "API Version",
"unit": "STRING",
"summaryStatistic": false
},
{
"name": "httpMethod",
"description": "HTTP method.",
"label": "HTTP Method",
"unit": "STRING",
"summaryStatistic": false
},
{
"name": "userAgent",
"description": "User Agent.",
"label": "User Agent",
"unit": "STRING",
"summaryStatistic": false
},
{
"name": "contentType",
"description": "Content type.",
"label": "Content Type",
"unit": "STRING",
"summaryStatistic": false
},
{
"name": "contentLength",
"description": "Content length.",
"label": "Content Length",
"unit": "STRING",
"summaryStatistic": false
},
{
"name": "objectCount",
"description": "Object count.",
"label": "Objects",
"unit": "COUNT",
"summaryStatistic": false
},
{
"name": "urlCount",
"description": "URL count.",
"label": "URL Count",
"unit": "COUNT",
"summaryStatistic": false
},
{
"name": "arlCount",
"description": "ARL count.",
"label": "ARL Count",
"unit": "COUNT",
"summaryStatistic": false
},
{
"name": "cpcodeCount",
"description": "CP code count.",
"label": "Cpcode Count",
"unit": "COUNT",
"summaryStatistic": false
},
{
"name": "tagCount",
"description": "TAG count.",
"label": "Tag Count",
"unit": "COUNT",
"summaryStatistic": false
},
{
"name": "badRequestObject",
"description": "Bad request object.",
"label": "Bad Request Object",
"unit": "STRING",
"summaryStatistic": false
},
{
"name": "elapsedTime",
"description": "Elapsed time.",
"label": "Elapsed Time",
"unit": "STRING",
"summaryStatistic": false
},
{
"name": "cpcodePurgeEnabled",
"description": "CP code purge enabled.",
"label": "Cpcode Purge Enabled",
"unit": "STRING",
"summaryStatistic": false
},
{
"name": "tagPurgeEnabled",
"description": "TAG Purge enabled.",
"label": "Tag Purge Enabled",
"unit": "STRING",
"summaryStatistic": false
},
{
"name": "accountSwitchingEnabled",
"description": "Account switching enabled.",
"label": "Account Switching Enabled",
"unit": "STRING",
"summaryStatistic": false
}
],
"groupOutlyingValues": {
"enabled": false
},
"filters": [
{
"name": "contract_type",
"type": "string",
"description": "A contract type ID a given user has access to.",
"required": true
},
{
"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": "support_id",
"type": "string",
"description": "Support Id.",
"required": false
},
{
"name": "client_name",
"type": "string",
"description": "Client name.",
"required": false
},
{
"name": "client_owner",
"type": "string",
"description": "Client owner.Y",
"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": "client_id",
"type": "string",
"description": "Client Id.",
"required": false
},
{
"name": "request_action",
"type": "enum",
"description": "Request action.",
"values": [
{
"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
}
],
"intervals": [
"MONTH",
"WEEK",
"DAY",
"HOUR",
"FIVE_MINUTES"
],
"dataRetentionDays": 45,
"limit": 500,
"maxLimit": 25000,
"links": [
{
"rel": "self",
"href": "/reporting-api/v1/reports/purge-audit-requests-details-by-time/versions/2"
},
{
"rel": "versions",
"href": "/reporting-api/v1/reports/purge-audit-requests-details-by-time/versions"
},
{
"rel": "all-reports",
"href": "/reporting-api/v1/reports"
},
{
"rel": "execute-report",
"href": "/reporting-api/v1/reports/purge-audit-requests-details-by-time/versions/2/report-data"
}
]
}