Skip to content
/Tag Privacy Report

Get Tag Privacy summary for specified audit run

Request

POST /v3/web-audits/{auditId}/runs/{runId}/reports/tag-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 Tag 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.

primaryTagsOnlyboolean

If true then return only pages/tags with primary tags else return all pages/tags

tagIdinteger

Tag ID

tagCategoryIdinteger

Tag category ID

tagVendorIdinteger

Tag vendor ID

tagAccountstring

Tag account

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"
POST
/v3/web-audits/{auditId}/runs/{runId}/reports/tag-privacy
curl -i -X POST \
  https://api.observepoint.com/v3/web-audits/107239/runs/33010/reports/tag-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,
    "primaryTagsOnly": true,
    "tagId": 0,
    "tagCategoryId": 0,
    "tagVendorId": 0,
    "tagAccount": "string",
    "consentCategoryId": 3301,
    "consentCategorySnapshotId": 33010,
    "consentCategoryComplianceStatus": "approved"
  }'

Responses

Tag Privacy summary data

Bodyapplication/json
totalPageCountintegerrequired

Total number of pages audited

filteredPageCountintegerrequired

Number of pages passing all applied filters

totalUniqueTagCountintegerrequired

Total number of unique tag vendors discovered

filteredUniqueTagCountintegerrequired

Number of unique tag vendors passing all applied filters

totalApprovedTagCountintegerrequired

Total number of approved tag vendors discovered

filteredApprovedTagCountintegerrequired

Number of approved tags passing all applied filters

totalUnapprovedTagCountintegerrequired

Total number of unapproved tag vendors discovered

filteredUnapprovedTagCountintegerrequired

Number of unapproved tags passing all applied filters

filteredPageWithUnapprovedTagCountintegerrequired

Number of pages with unapproved tags 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.

Response
{
  "totalPageCount": 0,
  "filteredPageCount": 0,
  "totalUniqueTagCount": 0,
  "filteredUniqueTagCount": 0,
  "totalApprovedTagCount": 0,
  "filteredApprovedTagCount": 0,
  "totalUnapprovedTagCount": 0,
  "filteredUnapprovedTagCount": 0,
  "filteredPageWithUnapprovedTagCount": 0,
  "runHasNoConsentCategoriesAssigned": true
}