v3 API//
- Get Cookie Inventory page list for specific cookie in specified audit run
Get Cookie Inventory summary for specified audit run
Get Cookie Inventory trends relative to specified audit run
Get Cookie Inventory specific trend values relative to current time
Get Cookie Inventory cookie list for specified audit run
Get Cookie Inventory page list for specified audit run
Get Cookie Domains list in specified audit run
Get Cookie Inventory page...
POST /v3/web-audits/{auditId}/runs/{runId}/reports/cookie-inventory/cookie-pages
Security
API_Key
Filters applicable to Cookie Inventory report + specific cookie to check out its pages
broken- initial or final URL arebroken,good- initial URL isgoodorredirectand final URL isgood
Enum:"broken""good"
Page load time in milliseconds. Should have min and/or max properties defined. min is inclusive and max is exclusive. min should be less than max.
Page size in bytes. Should have min and/or max properties defined. min is inclusive and max is exclusive. min should be less than max.
Number of redirects for a page. Should have min and/or max properties defined. min is inclusive and max is exclusive. min should be less than max.
exclude_pre_audit_action_only_cookies- exclude cookies which were only changed during pre-audit actions
Value:"exclude_pre_audit_action_only_cookies"
partitionKeyis absent — property is ignored for backward compatibility,partitionKeyis present andpartitionKey.valueis absent — cookies in old runs without partition key and new runs with partition key set to null,partitionKeyis present andpartitionKey.valueis present — cookies in new runs with requested partition key
Cookie size in bytes. Should have min and/or max properties defined. min is inclusive and max is exclusive
- ObservePoint Production APIhttps://api.observepoint.com/v3/web-audits/{auditId}/runs/{runId}/reports/cookie-inventory/cookie-pages
curl -i -X POST \
'https://api.observepoint.com/v3/web-audits/107239/runs/33010/reports/cookie-inventory/cookie-pages?page=0&size=50&sortBy=page_url&sortDesc=false' \
-H 'Authorization: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"pageUrl": {
"filterType": "contains",
"filterValue": "string",
"negated": false
},
"finalPageUrl": {
"filterType": "contains",
"filterValue": "string",
"negated": false
},
"pageTitle": {
"filterType": "contains",
"filterValue": "ObserveP"
},
"initialPageStatusCode": {
"filterType": "specific",
"negated": true,
"filterValue": 0
},
"finalPageStatusCode": {
"filterType": "specific",
"negated": true,
"filterValue": 0
},
"combinedPageStatusCode": "broken",
"pageLoadTime": {
"min": 0,
"max": 0
},
"pageSize": {
"min": 0,
"max": 0
},
"redirectCount": {
"min": 0,
"max": 0
},
"hasBrokenLinks": true,
"cookieOriginInclusion": "exclude_pre_audit_action_only_cookies",
"cookie": {
"name": "string",
"domain": "string",
"partyType": "1st_party",
"expirationType": "session",
"sameSite": "None",
"secure": true,
"httpOnly": true,
"partitionKey": {
"value": "string"
}
},
"cookieSize": {
"min": 0,
"max": 0
},
"initiatorUrl": {
"filterType": "contains",
"filterValue": "string"
},
"initiatorUrlDomain": {
"filterType": "contains",
"filterValue": "string"
},
"anyRelatedTag": true,
"tagId": 0,
"tagCategoryId": 0,
"tagVendorId": 0
}'Response
{ "metadata": { "pagination": { … } }, "pages": [ { … } ] }