Skip to content

Get Request Privacy summary for specified audit run

Request

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

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""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 \
  -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 summary data

Bodyapplication/json
totalPageCountintegerrequired

Total number of pages audited

filteredPageCountintegerrequired

Number of pages passing all applied filters

totalRequestCountintegerrequired

Total number of network requests discovered

filteredRequestCountintegerrequired

Number of network request passing all applied filters

filteredUniqueRequestDomainCountintegerrequired

Number of unique network request domains passing all applied filters

filteredUniqueRequestGeoCountintegerrequired

Number of unique network request geolocations passing all applied filters

totalUniqueApprovedRequestDomainCountintegerrequired

Total number of unique approved request domains discovered

filteredUniqueApprovedRequestDomainCountintegerrequired

Number of unique approved request domains passing all applied filters

totalUniqueUnapprovedRequestDomainCountintegerrequired

Total number of unique unapproved domains discovered

filteredUniqueUnapprovedRequestDomainCountintegerrequired

Number of unique unapproved domains passing all applied filters

filteredPageWithUnapprovedRequestCountintegerrequired

Number of pages with unapproved domains or geos passing all applied filters

totalPendingRequestDomainCountinteger

Total number of unique pending request domains discovered

filteredPendingRequestDomainCountinteger

Number of unique pending request domains passing all applied filters

totalPageWithPendingRequestDomainCountinteger

Total number of pages with pending request domains

filteredPageWithPendingRequestDomainCountinteger

Number of pages with pending request domains passing all applied filters

totalUncategorizedRequestDomainCountinteger

Total number of unique uncategorized request domains discovered

filteredUncategorizedRequestDomainCountinteger

Number of unique uncategorized request domains passing all applied filters

totalPageWithUncategorizedRequestDomainCountinteger

Total number of pages with uncategorized request domains

filteredPageWithUncategorizedRequestDomainCountinteger

Number of pages with uncategorized request domains passing all applied filters

runHasNoConsentCategoriesAssignedbooleanrequired

When TRUE, run did not have any consent categories assigned. When NOT specified or FALSE, it had at least one.

totalApprovedRequestCountintegerrequireddeprecated

Total number of approved domain+geo pairs discovered

filteredApprovedRequestCountintegerrequireddeprecated

Number of approved domain+geo pairs passing all applied filters

totalUnapprovedRequestCountintegerrequireddeprecated

Total number of unapproved domain+geo pairs discovered

filteredUnapprovedRequestCountintegerrequireddeprecated

Number of unapproved domain+geo pairs passing all applied filters

Response
{ "totalPageCount": 0, "filteredPageCount": 0, "totalRequestCount": 0, "filteredRequestCount": 0, "filteredUniqueRequestDomainCount": 0, "filteredUniqueRequestGeoCount": 0, "totalApprovedRequestCount": 0, "totalUniqueApprovedRequestDomainCount": 0, "filteredApprovedRequestCount": 0, "filteredUniqueApprovedRequestDomainCount": 0, "totalUnapprovedRequestCount": 0, "totalUniqueUnapprovedRequestDomainCount": 0, "filteredUnapprovedRequestCount": 0, "filteredUniqueUnapprovedRequestDomainCount": 0, "filteredPageWithUnapprovedRequestCount": 0, "totalPendingRequestDomainCount": 0, "filteredPendingRequestDomainCount": 0, "totalPageWithPendingRequestDomainCount": 0, "filteredPageWithPendingRequestDomainCount": 0, "totalUncategorizedRequestDomainCount": 0, "filteredUncategorizedRequestDomainCount": 0, "totalPageWithUncategorizedRequestDomainCount": 0, "filteredPageWithUncategorizedRequestDomainCount": 0, "runHasNoConsentCategoriesAssigned": true }