Skip to content
v3 API
/
Tag Privacy Report
/
Get Tag Privacy compliance for specified audit run

V3 API

This section documents the V3 Reporting API endpoints that provide access to comprehensive audit and journey data from ObservePoint. Use these endpoints to retrieve detailed reports, export data, manage alerts, and analyze web performance metrics from your ObservePoint scans.

Download OpenAPI description
REPORTING-API.openapi.json
REPORTING-API.openapi.yaml
Overview
URL

https://www.observepoint.com/contact-us

Languages
Servers
ObservePoint Production API

https://api.observepoint.com/

Audit Run Data

Retrieve audit run data including pages, cookies, geo-locations, network requests, JS variables and failures for web audit runs

Operations

Page Details Report

Detailed information about specific pages including tags, cookies, request logs, and console logs

Operations

Page Summary Report

Page Summary report endpoints

Operations

Audit Summary Report

Audit Summary report endpoints

Operations

Alert Summary Report

Alert Summary report endpoints

Operations

Rule Summary Report

Rule Summary report endpoints

Operations

Tag Inventory Report

Tag Inventory report endpoints

Operations

Tag Health Report

Tag Health report endpoints

Operations

Tag Duplicates and Multiples Report

Tag Duplicates and Multiples report endpoints

Operations

Variable Inventory Report

Variable Inventory report endpoints

Operations

Browser Logs Report

Browser Logs report endpoints

Operations

File Changes Report

File changes report endpoints

Operations

Tag Privacy Report

Tag privacy report endpoints

Operations

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.

hasBrokenLinksboolean
pageUrlMatchingAuditFilterConfigurationboolean
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(int64)

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"
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
    },
    "finalPageStatusCode": {
      "filterType": "specific",
      "negated": true
    },
    "combinedPageStatusCode": "broken",
    "pageLoadTime": {
      "min": 0,
      "max": 0
    },
    "pageSize": {
      "min": 0,
      "max": 0
    },
    "redirectCount": {
      "min": 0,
      "max": 0
    },
    "hasBrokenLinks": true,
    "pageUrlMatchingAuditFilterConfiguration": 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
application/json
{
  "totalPageCount": 0,
  "filteredPageCount": 0,
  "totalUniqueTagCount": 0,
  "filteredUniqueTagCount": 0,
  "totalApprovedTagCount": 0,
  "filteredApprovedTagCount": 0,
  "totalUnapprovedTagCount": 0,
  "filteredUnapprovedTagCount": 0,
  "filteredPageWithUnapprovedTagCount": 0,
  "runHasNoConsentCategoriesAssigned": true
}

Get Tag Privacy trends relative to specified audit run

Request

GET /v3/web-audits/{auditId}/runs/{runId}/reports/tag-privacy/trends
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
curl -i -X GET \
  https://api.observepoint.com/v3/web-audits/107239/runs/33010/reports/tag-privacy/trends \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Tag Privacy trends data

Bodyapplication/json
runsArray of objects<= 5 itemsrequired
runs[].​runIdinteger(int64)required
Example: 33010
runs[].​completedAtstring(date-time)required

Date-time in RFC3339 profile ISO 8601 format with the following additional restrictions:

  1. An uppercase T must separate the date and time portions.
  2. An uppercase Z must denote that a numeric time zone offset isn't present.

In general, these timestamp requirements are the same in AWS Step Functions - Choice Rules

Example: "2016-08-18T17:33:00Z"
runs[].​totalUniqueTagCountintegerrequired

Total number of unique tag vendors discovered

runs[].​totalApprovedTagCountintegerrequired

Total number of approved tags found in audit run

runs[].​totalUnapprovedTagCountintegerrequired

Total number of unapproved tags found in audit run

Response
application/json
{
  "runs": [
    { … }
  ]
}

Get Tag Privacy specific trend values relative to current day

Request

GET /v3/web-audits/{auditId}/reports/tag-privacy/trends/{trendName}
Security
API_Key
Path
auditIdinteger(int64)required

Unique identification number for web audit

Example: 107239
trendNamestringrequired

name of requested trend

Enum"unique_tags""approved_tags""unapproved_tags"
Query
daysinteger[ 1 .. 390 ]required

Number of days to get trend values for, relative to current time

curl -i -X GET \
  'https://api.observepoint.com/v3/web-audits/107239/reports/tag-privacy/trends/{trendName}?days=1' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Tag Privacy specific trend values

Bodyapplication/json
runsArray of objectsrequired
runs[].​runIdinteger(int64)required
Example: 33010
runs[].​completedAtstring(date-time)required

Date-time in RFC3339 profile ISO 8601 format with the following additional restrictions:

  1. An uppercase T must separate the date and time portions.
  2. An uppercase Z must denote that a numeric time zone offset isn't present.

In general, these timestamp requirements are the same in AWS Step Functions - Choice Rules

Example: "2016-08-18T17:33:00Z"
runs[].​trendValuenumberrequired
Response
application/json
{
  "runs": [
    { … }
  ]
}

Get Tag Privacy compliance for specified audit run

Request

POST /v3/web-audits/{auditId}/runs/{runId}/reports/tag-privacy/compliance
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
Query
pageinteger>= 0

Number of results page of an endpoint with paginated results

Default 0
sizeinteger[ 100 .. 1000 ]
Default 100
sortBystring
Enum"compliance_status""page_count""tag_name""consent_category_name"
sortDescboolean

Controls sorting order

Default false
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.

hasBrokenLinksboolean
pageUrlMatchingAuditFilterConfigurationboolean
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(int64)

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"
curl -i -X POST \
  'https://api.observepoint.com/v3/web-audits/107239/runs/33010/reports/tag-privacy/compliance?page=0&size=100&sortBy=compliance_status&sortDesc=false' \
  -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
    },
    "finalPageStatusCode": {
      "filterType": "specific",
      "negated": true
    },
    "combinedPageStatusCode": "broken",
    "pageLoadTime": {
      "min": 0,
      "max": 0
    },
    "pageSize": {
      "min": 0,
      "max": 0
    },
    "redirectCount": {
      "min": 0,
      "max": 0
    },
    "hasBrokenLinks": true,
    "pageUrlMatchingAuditFilterConfiguration": true,
    "primaryTagsOnly": true,
    "tagId": 0,
    "tagCategoryId": 0,
    "tagVendorId": 0,
    "tagAccount": "string",
    "consentCategoryId": 3301,
    "consentCategorySnapshotId": 33010,
    "consentCategoryComplianceStatus": "approved"
  }'

Responses

Tag Privacy compliance data

Bodyapplication/json
metadataobjectrequired

Common metadata for iterable

metadata.​paginationobjectrequired
metadata.​pagination.​totalCountintegerrequired

Total number of items available from all result pages combined

metadata.​pagination.​totalPageCountintegerrequired

Total number of pages available

metadata.​pagination.​pageSizeintegerrequired

Page size - number of items per result page configured by size query parameter or default page size

metadata.​pagination.​currentPageSizeintegerrequired

Number of items in current result page

metadata.​pagination.​currentPageNumberintegerrequired

Current page number/ordinal

tagsArray of objectsrequired
tags[].​tagIdintegerrequired

Tag ID

tags[].​tagNamestringrequired

Tag name

tags[].​tagCategoryIdintegerrequired

Tag category ID

tags[].​tagCategoryNamestringrequired

Name of a category of a tag

tags[].​tagAccountstringrequired

Tag account

tags[].​consentCategoryComplianceStatusstringrequired
Enum"approved""unapproved"
tags[].​consentCategorySnapshotIdinteger(int64)

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

Example: 33010
tags[].​consentCategoryNamestring

Name of consent category item (tag, cookie, domain, geo) belongs to

tags[].​filteredPageCountintegerrequired
Response
application/json
{
  "metadata": {
    "pagination": { … }
  },
  "tags": [
    { … }
  ]
}

Get Tag Privacy pages data for specified audit run

Request

POST /v3/web-audits/{auditId}/runs/{runId}/reports/tag-privacy/pages
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
Query
pageinteger>= 0

Number of results page of an endpoint with paginated results

Default 0
sizeinteger[ 50 .. 1000 ]
Default 50
sortBystring
Enum"page_url""final_page_url""page_load_time""page_status_code""final_page_status_code""tag_count"
sortDescboolean

Controls sorting order

Default false
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.

hasBrokenLinksboolean
pageUrlMatchingAuditFilterConfigurationboolean
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(int64)

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"
curl -i -X POST \
  'https://api.observepoint.com/v3/web-audits/107239/runs/33010/reports/tag-privacy/pages?page=0&size=50&sortBy=page_url&sortDesc=false' \
  -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
    },
    "finalPageStatusCode": {
      "filterType": "specific",
      "negated": true
    },
    "combinedPageStatusCode": "broken",
    "pageLoadTime": {
      "min": 0,
      "max": 0
    },
    "pageSize": {
      "min": 0,
      "max": 0
    },
    "redirectCount": {
      "min": 0,
      "max": 0
    },
    "hasBrokenLinks": true,
    "pageUrlMatchingAuditFilterConfiguration": true,
    "primaryTagsOnly": true,
    "tagId": 0,
    "tagCategoryId": 0,
    "tagVendorId": 0,
    "tagAccount": "string",
    "consentCategoryId": 3301,
    "consentCategorySnapshotId": 33010,
    "consentCategoryComplianceStatus": "approved"
  }'

Responses

Tag Privacy pages data

Bodyapplication/json
metadataobjectrequired

Common metadata for iterable

metadata.​paginationobjectrequired
metadata.​pagination.​totalCountintegerrequired

Total number of items available from all result pages combined

metadata.​pagination.​totalPageCountintegerrequired

Total number of pages available

metadata.​pagination.​pageSizeintegerrequired

Page size - number of items per result page configured by size query parameter or default page size

metadata.​pagination.​currentPageSizeintegerrequired

Number of items in current result page

metadata.​pagination.​currentPageNumberintegerrequired

Current page number/ordinal

pagesArray of objectsrequired
pages[].​pageIdstringrequired
Example: "f9d32cc7cc2046d6decb145a80289287f5226323"
pages[].​pageUrlstring(url)required
Example: "https://example.com/about"
pages[].​pageLoadTimeintegerrequired

Time page took to load, in milliseconds

pages[].​pageStatusCodeintegerrequired

Page HTTP status code

pages[].​finalPageUrlstring(url)
Example: "https://example.com/about"
pages[].​finalPageStatusCodeinteger

Page HTTP status code

pages[].​tagRequestCountintegerrequired

Number of tag requests on a page

Response
application/json
{
  "metadata": {
    "pagination": { … }
  },
  "pages": [
    { … }
  ]
}

Get Tag Privacy pages data for specific tag in specified audit run

Request

POST /v3/web-audits/{auditId}/runs/{runId}/reports/tag-privacy/tag-pages
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
Query
pageinteger>= 0

Number of results page of an endpoint with paginated results

Default 0
sizeinteger[ 50 .. 1000 ]
Default 50
sortBystring
Enum"page_url""final_page_url""page_load_time""page_status_code""final_page_status_code""tag_count"
sortDescboolean

Controls sorting order

Default false
Bodyapplication/jsonrequired

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.

hasBrokenLinksboolean
pageUrlMatchingAuditFilterConfigurationboolean
tagIdintegerrequired

Tag ID

tagAccountstringrequired

Tag account

curl -i -X POST \
  'https://api.observepoint.com/v3/web-audits/107239/runs/33010/reports/tag-privacy/tag-pages?page=0&size=50&sortBy=page_url&sortDesc=false' \
  -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
    },
    "finalPageStatusCode": {
      "filterType": "specific",
      "negated": true
    },
    "combinedPageStatusCode": "broken",
    "pageLoadTime": {
      "min": 0,
      "max": 0
    },
    "pageSize": {
      "min": 0,
      "max": 0
    },
    "redirectCount": {
      "min": 0,
      "max": 0
    },
    "hasBrokenLinks": true,
    "pageUrlMatchingAuditFilterConfiguration": true,
    "tagId": 0,
    "tagAccount": "string"
  }'

Responses

Tag Privacy pages data

Bodyapplication/json
metadataobjectrequired

Common metadata for iterable

metadata.​paginationobjectrequired
metadata.​pagination.​totalCountintegerrequired

Total number of items available from all result pages combined

metadata.​pagination.​totalPageCountintegerrequired

Total number of pages available

metadata.​pagination.​pageSizeintegerrequired

Page size - number of items per result page configured by size query parameter or default page size

metadata.​pagination.​currentPageSizeintegerrequired

Number of items in current result page

metadata.​pagination.​currentPageNumberintegerrequired

Current page number/ordinal

pagesArray of objectsrequired
pages[].​pageIdstringrequired
Example: "f9d32cc7cc2046d6decb145a80289287f5226323"
pages[].​pageUrlstring(url)required
Example: "https://example.com/about"
pages[].​pageLoadTimeintegerrequired

Time page took to load, in milliseconds

pages[].​pageStatusCodeintegerrequired

Page HTTP status code

pages[].​finalPageUrlstring(url)
Example: "https://example.com/about"
pages[].​finalPageStatusCodeinteger

Page HTTP status code

pages[].​tagRequestCountintegerrequired

Number of tag requests on a page

Response
application/json
{
  "metadata": {
    "pagination": { … }
  },
  "pages": [
    { … }
  ]
}

Request Privacy Report

Request Privacy report endpoints

Operations

Exports Center

Access requested exports status/information

Operations

Scheduled Exports

Manage scheduled grid report data exports

Operations

Audit Run Export

Export audit run data

Operations

Web Journey Run Export

Export web journey run data

Operations

Manual Journey Run Export

Export manual journey run data

Operations

Alerts

Alert management and configuration

Operations

Account's Triggered Alerts

Account-level triggered alerts

Operations

Alert Export

Export alert data

Operations

Account Usage

Account usage data

Operations

Account Usage Alerts

Alerts related to account usage

Operations

Account Usage Export

Export account usage data

Operations

Notification Center

Find and manage email subscriptions

Operations

Email Inbox Messages

Get Email Inbox message details

Operations

Email Inbox Message Alerts

Email inbox message alerts

Operations