Return page cookie information

v3 API/

Return page cookie information

Request

GET /v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/cookies

Get cookies from specified audit run on a given page, getting summary insight is optional

Security

API_Key

Path

auditIdinteger, (int64)required

Unique identification number for web audit

Example:107239

runIdinteger, (int64)required

Unique identification number for web audit or journey run

Example:33010

pageIdstringrequired

Unique identification number for web audit run-page, it is different from dcUUID

Example:f9d32cc7cc2046d6decb145a80289287f5226323

Query

getInsightsboolean

Example:getInsights=true

getOriginsboolean

If true then origin story will be returned for each cookie

Example:getOrigins=true

hidePreAuditActionOnlyCookiesboolean

If true then cookies which were only changed during pre-audit actions will be hidden

Default:false

Example:hidePreAuditActionOnlyCookies=true

GET

/v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/cookies

curl -i -X GET \
  'https://api.observepoint.com/v3/web-audits/107239/runs/33010/pages/f9d32cc7cc2046d6decb145a80289287f5226323/cookies?getInsights=true&getOrigins=true&hidePreAuditActionOnlyCookies=true' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK, return cookies found on a page

Bodyapplication/json

insightsobjectrequired

cookiesArray of objectsrequired

Response

{
  "insights": {
    "noOfUniqueCookies": 0,
    "noOfUniqueDomains": 0,
    "noOf3rdPartyCookies": 0
  },
  "cookies": [
    { … }
  ]
}