Get Request Privacy locations for specified audit run

v3 API/

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.

hasBrokenLinksboolean

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""pending""uncategorized"

consentCategoryConflictsOnlyboolean

If true then return only items matched by two or more consent categories with at least two distinct compliance statuses. An item not matched by any consent category is never a conflict. A conflicted item resolves to its worst compliance status (unapproved, then pending, then uncategorized, then approved), so combining this filter with consentCategoryComplianceStatus=approved returns an empty result. Only compliance statuses that the report returns for the account count as distinct statuses; matches by categories with any other status are ignored. Combines with consentCategoryId, consentCategorySnapshotId and consentCategoryComplianceStatus by AND. If absent or false then no filtering is applied.

countryCodestring

ISO 3166-1 (Alpha-2) country code

Example:"US"

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",
    "consentCategoryConflictsOnly": true,
    "countryCode": "US"
  }'

Responses

Request Privacy locations data

Bodyapplication/json

locationsArray of objectsrequired

One element per country and resolved compliance status. Same requestGeo.country may be repeated in different array elements when different request domains in that country resolve to different statuses; each request instance is counted in at most one element — requests with an unresolved geo or an unresolvable compliance status are omitted

Response

{
  "locations": [
    { … }
  ]
}