Skip to content
v3 API/
/
Get Request Privacy locat...

Get Request Privacy locations for specified audit run

Request

POST /v3/web-audits/{auditId}/runs/{runId}/reports/request-privacy/locations
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
Bodyapplication/json

Filters applicable to Request Privacy report. countryCode filter is not abided by this endpoint.

pageUrlobject
finalPageUrlobject
pageTitleobject
initialPageStatusCodeobject
finalPageStatusCodeobject
combinedPageStatusCodestring
  • broken - initial or final URL are broken,
  • good - initial URL is good or redirect and final URL is good
Enum:"broken""good"
pageLoadTimeobject

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.

pageSizeobject

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.

redirectCountobject

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.

requestDomainstring

Network request URL domain

Example:"example.com"
consentCategoryIdinteger

ID of consent category

Example:3301
consentCategorySnapshotIdinteger, (int64)

Use in filtering purposes is DEPRECATED in favour of ConsentCategoryId! Snapshot Id of consent category attached to this run

Example:33010
consentCategoryComplianceStatusstring
Enum:"approved""unapproved"
countryCodestring

ISO 3166-1 (Alpha-2) country code

Example:"US"
POST
/v3/web-audits/{auditId}/runs/{runId}/reports/request-privacy/locations
curl -i -X POST \
  https://api.observepoint.com/v3/web-audits/107239/runs/33010/reports/request-privacy/locations \
  -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,
    "requestDomain": "example.com",
    "consentCategoryId": 3301,
    "consentCategorySnapshotId": 33010,
    "consentCategoryComplianceStatus": "approved",
    "countryCode": "US"
  }'

Responses

Request Privacy locations data

Bodyapplication/json
locationsArray of objectsrequired

Same requestGeo.country may be repeated in different array elements and may have different statuses with different consent categories

Response
{
  "locations": [
    { … }
  ]
}