purge-audit-objects-details-by-time

The following shows how to generate the purge-audit-objects-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 objects audit details.

Business object: account_id

Data available for: 45 days

Required products: EDGECONTROL

Available metrics

MetricDescription
Data metrics
authorization‚ÄčClient‚ÄčTokenAuthorization Client Token.
clientIdID of client generating API request.
clientNameClient name.
clientOwnerUsername of client owner.
consumerToken‚ÄčHostnameConsumer Token Hostname.
cpcodeCP code.
environmentEnvironment.
flexibleCache‚ÄčId‚ÄčEnabledFlexible Cache Id Enabled.
requestActionRequest action.
requestObjectRequest Object.
requestSourceRequest source.
requestTypeRequest type.
responseCodeResponse code for the API request.
supportIdSupport Id.
timestampDate and time of API request.

Available filters

FilterTypeDescription
Required filters
contract_typeStringA contract type ID a given user has access to.
Optional filters
client_idStringClient Id.
client_nameStringClient name.
client_ownerStringClient owner.
cpcodeStringContent Provider (CP) codes let you segment your delivered content for tracking and reporting purposes. All CP codes are tied to one or more services, which are then tracked and reported under that CP code.
environmentEnumerationEnvironment.
STAGING: Staging.
PRODUCTION: Production.
purge_object_‚Äčexact_‚ÄčmatchStringPurge object exact match.
purge_object_‚ÄčmatchStringPurge object match.
purge_object_‚Äčstarts_‚ÄčwithStringPurge object starts with.
request_actionEnumerationRequest action.
invalidate: Invalidate.
delete: Delete.
request_sourceEnumerationRequest source.
EDGEGRID: Edgegrid.
PORTAL: Portal.
request_typeEnumerationRequest type.
CPCODE: CP code
VCD: VCD
ARL: ARL
TAG: TAG
URL: URL
response_classEnumerationA 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_codeStringAn HTTP response status code, for example, 201.
response_statusEnumerationAn indicator of whether the HTTP response resulted in success or an error.
success: Successful HTTP response status.
error: Error HTTP response status.
support_idStringSupport Id.

POST request

POST /reporting-api/v1/reports/purge-audit-objects-details-by-time/versions/2/report-data{?start,end}

Sample: /reporting-api/v1/reports/purge-audit-objects-details-by-time/versions/2/report-data?start=2023-05-01T00%3A00%3A00Z&end=2023-06-01T00%3A00%3A00Z

Query parameters

ParameterTypeSampleDescription
Required
startString2023-05-01T00:00:00ZSpecifies 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.
endString2023-06-01T00:00:00ZSpecifies 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

MemberTypeDescription
objectIdsArraySpecifies the account_id value you want to report on.
metricsArrayThe set of desired metrics. If omitted, the report includes all available metrics.
filtersMap of ArraysSpecifies 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": [
        "authorizationClientToken",
        "clientId",
        "clientName",
        "clientOwner",
        "consumerTokenHostname",
        "cpcode",
        "environment",
        "flexibleCacheIdEnabled",
        "requestAction",
        "requestObject",
        "requestSource",
        "requestType",
        "responseCode",
        "supportId",
        "timestamp"
    ],
    "filters": {
        "client_id": [
            "client3",
            "client2"
        ],
        "client_name": [
            "name4",
            "name3"
        ],
        "client_owner": [
            "owner5",
            "owner1"
        ],
        "contract_type": [
            "1-3CV382"
        ],
        "cpcode": [
            "12345",
            "23451"
        ],
        "environment": [
            "STAGING",
            "PRODUCTION"
        ],
        "purge_object_exact_match": [
            "https://www.example.com/shop/index.html",
            "https://www.example.com/about/index.html"
        ],
        "purge_object_match": [
            "https://www.example.com/shop",
            "https://www.example.com/about"
        ],
        "purge_object_starts_with": [
            "http:",
            "https:"
        ],
        "request_action": [
            "invalidate",
            "delete"
        ],
        "request_source": [
            "EDGEGRID",
            "PORTAL"
        ],
        "request_type": [
            "URL",
            "ARL"
        ],
        "response_class": [
            "3xx",
            "4xx"
        ],
        "response_code": [
            "200",
            "500"
        ],
        "response_status": [
            "success",
            "error"
        ],
        "support_id": [
            "support1",
            "support3"
        ]
    }
}

GET request

GET /reporting-api/v1/reports/purge-audit-objects-details-by-time/versions/2/report-data{?start,end,objectIds,metrics,filters}

Sample: /reporting-api/v1/reports/purge-audit-objects-details-by-time/versions/2/report-data?start=2023-05-01T00%3A00%3A00Z&end=2023-06-01T00%3A00%3A00Z&objectIds=1-123A&metrics=authorizationClientToken%2CclientId&filters=client_id%3Dclient1%2Cclient_id%3Dclient5%2Cclient_name%3Dname5%2Cclient_name%3Dname2

Query parameters

ParameterTypeSampleDescription
Required
startString2023-05-01T00:00:00ZSpecifies 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.
endString2023-06-01T00:00:00ZSpecifies 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.
objectIdsString1-123ASpecifies the unique ID for the account_id objectType you want to report on.
Optional
metricsStringauthorization‚ÄčClient‚ÄčToken,‚Äčclient‚ÄčIdSpecifies 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.
filtersStringclient_id=client5,‚Äčclient_‚Äčid=‚Äčclient4,‚Äčclient_‚Äčname=‚Äčname5,‚Äčclient_‚Äčname=‚Äčname2Specifies 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-objects-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": [
                    "client2",
                    "client4"
                ]
            },
            {
                "name": "client_name",
                "values": [
                    "name5",
                    "name1"
                ]
            },
            {
                "name": "client_owner",
                "values": [
                    "owner5",
                    "owner3"
                ]
            },
            {
                "name": "contract_type",
                "values": [
                    "1-3CV382"
                ]
            },
            {
                "name": "cpcode",
                "values": [
                    "12345",
                    "45123"
                ]
            },
            {
                "name": "environment",
                "values": [
                    "STAGING",
                    "PRODUCTION"
                ]
            },
            {
                "name": "purge_object_exact_match",
                "values": [
                    "https://www.example.com/shop/index.html",
                    "https://www.example.com/about/index.html"
                ]
            },
            {
                "name": "purge_object_match",
                "values": [
                    "https://www.example.com/shop",
                    "https://www.example.com/about"
                ]
            },
            {
                "name": "purge_object_starts_with",
                "values": [
                    "http:",
                    "https:"
                ]
            },
            {
                "name": "request_action",
                "values": [
                    "delete",
                    "invalidate"
                ]
            },
            {
                "name": "request_source",
                "values": [
                    "PORTAL",
                    "EDGEGRID"
                ]
            },
            {
                "name": "request_type",
                "values": [
                    "TAG",
                    "ARL"
                ]
            },
            {
                "name": "response_class",
                "values": [
                    "3xx",
                    "0xx"
                ]
            },
            {
                "name": "response_code",
                "values": [
                    "201",
                    "403"
                ]
            },
            {
                "name": "response_status",
                "values": [
                    "success",
                    "error"
                ]
            },
            {
                "name": "support_id",
                "values": [
                    "support3",
                    "support2"
                ]
            }
        ],
        "columns": [
            {
                "name": "authorizationClientToken",
                "label": "Authorization Client Token"
            },
            {
                "name": "clientId",
                "label": "Client Id"
            },
            {
                "name": "clientName",
                "label": "Client Name"
            },
            {
                "name": "clientOwner",
                "label": "Client Owner"
            },
            {
                "name": "consumerTokenHostname",
                "label": "Consumer Token Hostname"
            },
            {
                "name": "cpcode",
                "label": "Cpcode"
            },
            {
                "name": "environment",
                "label": "Environment"
            },
            {
                "name": "flexibleCacheIdEnabled",
                "label": "Flexible Cache Id Enabled"
            },
            {
                "name": "requestAction",
                "label": "Request Action"
            },
            {
                "name": "requestObject",
                "label": "Request Object"
            },
            {
                "name": "requestSource",
                "label": "Request Source"
            },
            {
                "name": "requestType",
                "label": "Request Type"
            },
            {
                "name": "responseCode",
                "label": "Response Code"
            },
            {
                "name": "supportId",
                "label": "Support Id"
            },
            {
                "name": "timestamp",
                "label": "Timestamp"
            }
        ],
        "objectType": "account_id",
        "objectIds": [
            "1-123A"
        ]
    },
    "data": [
        {
            "timestamp": "1684266297244",
            "supportId": "support1",
            "requestObject": "https://www.example.com/about/index.html",
            "cpcode": "34512",
            "consumerTokenHostname": "xyz.example.net",
            "flexibleCacheIdEnabled": "1",
            "clientOwner": "owner3",
            "clientId": "client4",
            "clientName": "name3",
            "authorizationClientToken": "token1",
            "requestAction": "delete",
            "requestType": "VCD",
            "requestSource": "PORTAL",
            "environment": "STAGING",
            "responseCode": "500"
        }
    ],
    "summaryStatistics": {}
}

CSV response

Status 200 text/csv

Response Body:

#METADATA_START
name,purge-audit-objects-details-by-time
version,2
source,purge-audit-objects-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,client2,client4
client_name,name5,name1
client_owner,owner5,owner3
contract_type,1-3CV382
cpcode,12345,45123
environment,STAGING,PRODUCTION
purge_object_exact_match,https://www.example.com/shop/index.html,https://www.example.com/about/index.html
purge_object_match,https://www.example.com/shop,https://www.example.com/about
purge_object_starts_with,http:,https:
request_action,delete,invalidate
request_source,EDGEGRID,PORTAL
request_type,TAG,ARL
response_class,3xx,0xx
response_code,201,403
response_status,success,error
support_id,support3,support2
#METADATA_END

#SUMMARYSTATISTICS_START

#SUMMARYSTATISTICS_END

#COLUMNS_START
timestamp,supportId,requestObject,cpcode,consumerTokenHostname,flexibleCacheIdEnabled,clientOwner,clientId,clientName,authorizationClientToken,requestAction,requestType,requestSource,environment,responseCode
#COLUMNS_END

#DATA_START
1684266297244,support1,https://www.example.com/about/index.html,34512,xyz.example.net,1,owner3,client4,name3,token1,delete,VCD,PORTAL,STAGING,500
#DATA_END

Get report details

This sample Get a report type operation gets the same information you need to run the purge-audit-objects-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-objects-details-by-time/versions/2

Status 200 application/json

Response body:

{
    "name": "purge-audit-objects-details-by-time",
    "description": "Provides purge objects audit details.",
    "businessObjectName": "account_id",
    "version": 2,
    "status": "PUBLISHED",
    "deprecated": false,
    "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": "requestObject",
            "description": "Request Object.",
            "label": "Request Object",
            "unit": "STRING",
            "summaryStatistic": false
        },
        {
            "name": "cpcode",
            "description": "CP code",
            "label": "Cpcode",
            "unit": "STRING",
            "summaryStatistic": false
        },
        {
            "name": "consumerTokenHostname",
            "description": "Consumer Token Hostname.",
            "label": "Consumer Token Hostname",
            "unit": "STRING",
            "summaryStatistic": false
        },
        {
            "name": "flexibleCacheIdEnabled",
            "description": "Flexible Cache Id Enabled.",
            "label": "Flexible Cache Id Enabled",
            "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": "clientName",
            "description": "Client name.",
            "label": "Client Name",
            "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
        }
    ],
    "groupOutlyingValues": {
        "enabled": false
    },
    "filters": [
        {
            "name": "purge_object_match",
            "type": "string",
            "description": "Purge object match.",
            "required": false
        },
        {
            "name": "purge_object_starts_with",
            "type": "string",
            "description": "Purge object starts with.",
            "required": false
        },
        {
            "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.",
            "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": "purge_object_exact_match",
            "type": "string",
            "description": "Purge object exact match.",
            "required": false
        },
        {
            "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": "cpcode",
            "type": "string",
            "description": "Content Provider (CP) codes let you segment your delivered content for tracking and reporting purposes. All CP codes are tied to one or more services, which are then tracked and reported under that CP code.",
            "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-objects-details-by-time/versions/2"
        },
        {
            "rel": "versions",
            "href": "/reporting-api/v1/reports/purge-audit-objects-details-by-time/versions"
        },
        {
            "rel": "all-reports",
            "href": "/reporting-api/v1/reports"
        },
        {
            "rel": "execute-report",
            "href": "/reporting-api/v1/reports/purge-audit-objects-details-by-time/versions/2/report-data"
        }
    ]
}