Skip to content
v3 API
/
Audit Summary Report
/
Get Audit Summary trends relative to 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

Get Audit Summary data for specified audit run

Request

POST /v3/web-audits/{auditId}/runs/{runId}/reports/audit-summary
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 Audit Summary report

primaryTagsOnlyboolean

(This filter option no longer works due to the response body change on May 2021) 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

curl -i -X POST \
  https://api.observepoint.com/v3/web-audits/107239/runs/33010/reports/audit-summary \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "primaryTagsOnly": true,
    "tagId": 0,
    "tagCategoryId": 0,
    "tagVendorId": 0
  }'

Responses

Audit Summary data

Bodyapplication/json
totalUniquePrimaryTagCountintegerrequired

Total number of tag vendors selected as account primary tags discovered during an audit run

filteredUniquePrimaryTagCountintegerrequired

Number of tag vendors selected as account primary tags passing all applied filters

Response
application/json
{
  "totalUniquePrimaryTagCount": 0,
  "filteredUniquePrimaryTagCount": 0
}

Get Audit Summary trends relative to specified audit run

Request

GET /v3/web-audits/{auditId}/runs/{runId}/reports/audit-summary/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/audit-summary/trends \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Audit Summary trends data

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[].​totalBrokenPageCountintegerrequired

Total number of broken pages

runs[].​totalUniqueTagCountintegerrequired

Total number of unique tag vendors

runs[].​totalBrokenTagCountintegerrequired

Total number of broken tag requests (0, 400+ or 500+ HTTP status code)

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

Get Audit Summary specific trend values relative to current day

Request

GET /v3/web-audits/{auditId}/reports/audit-summary/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""broken_tags""broken_pages"
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/audit-summary/trends/{trendName}?days=1' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Audit Summary 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 Audit Summary all primary tags data for specified audit run

Request

POST /v3/web-audits/{auditId}/runs/{runId}/reports/audit-summary/primary-tags
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 Audit Summary report

primaryTagsOnlyboolean

(This filter option no longer works due to the response body change on May 2021) 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

curl -i -X POST \
  https://api.observepoint.com/v3/web-audits/107239/runs/33010/reports/audit-summary/primary-tags \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "primaryTagsOnly": true,
    "tagId": 0,
    "tagCategoryId": 0,
    "tagVendorId": 0
  }'

Responses

Audit Summary all primary tags data

Bodyapplication/json
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[].​pageCountintegerrequired

Number of pages this tag has been discovered on

Default 0
tags[].​tagAccountCountintegerrequired

Number of distinct accounts of the tag

Default 0
tags[].​tagVersionCountintegerrequired

Number of distinct versions of the tag

Default 0
tags[].​tagLoadTimeAverageintegerrequired

Tag load time, in milliseconds

Default 0
tags[].​statusCodeDistributionobjectrequired

See StatusCodeEnum

tags[].​statusCodeDistribution.​goodintegerrequired

Number of tag requests with "good" status code

Default 0
tags[].​statusCodeDistribution.​redirectintegerrequired

Number of tag requests with "redirect" status code

Default 0
tags[].​statusCodeDistribution.​brokenintegerrequired

Number of tag requests with "broken" status code

Default 0
Response
application/json
{
  "tags": [
    { … }
  ]
}

Get Audit Summary all detected tags data for specified audit run

Request

POST /v3/web-audits/{auditId}/runs/{runId}/reports/audit-summary/tags
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 Audit Summary report

primaryTagsOnlyboolean

(This filter option no longer works due to the response body change on May 2021) 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

curl -i -X POST \
  https://api.observepoint.com/v3/web-audits/107239/runs/33010/reports/audit-summary/tags \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "primaryTagsOnly": true,
    "tagId": 0,
    "tagCategoryId": 0,
    "tagVendorId": 0
  }'

Responses

Audit Summary all detected tags data

Bodyapplication/json
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[].​pageCountintegerrequired

Number of pages this tag has been discovered on

tags[].​pageNotPresentCountintegerrequired

Number of pages this tag has not been discovered on

tags[].​tagLoadTimeAverageintegerrequired

Tag load time, in milliseconds

Default 0
tags[].​tagAccountCountintegerrequired

Number of distinct accounts of the tag

tags[].​uniqueVariableCountintegerrequired

Number of unique variables in the tag

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

Get Audit Summary scores for specified audit run

Request

GET /v3/web-audits/{auditId}/runs/{runId}/reports/audit-summary/scores
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/audit-summary/scores \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Audit Summary scores data

Bodyapplication/json
totalobjectrequired
total.​scorenumber(float)required

Amount of points obtained in given score category. Rounded to one digit after dot

total.​maxintegerrequired

Max points for given score category, inclusive

tagPresenceobjectrequired
tagPresence.​scorenumber(float)required

Amount of points obtained in given score category. Rounded to one digit after dot

tagPresence.​maxintegerrequired

Max points for given score category, inclusive

tagPerformanceobjectrequired
tagPerformance.​scorenumber(float)required

Amount of points obtained in given score category. Rounded to one digit after dot

tagPerformance.​maxintegerrequired

Max points for given score category, inclusive

rulesobjectrequired
rules.​scorenumber(float)required

Amount of points obtained in given score category. Rounded to one digit after dot

rules.​maxintegerrequired

Max points for given score category, inclusive

pagePerformanceobjectrequired
pagePerformance.​scorenumber(float)required

Amount of points obtained in given score category. Rounded to one digit after dot

pagePerformance.​maxintegerrequired

Max points for given score category, inclusive

cookiesobjectrequired
cookies.​scorenumber(float)required

Amount of points obtained in given score category. Rounded to one digit after dot

cookies.​maxintegerrequired

Max points for given score category, inclusive

Response
application/json
{
  "total": {
    "score": 0.1,
    "max": 0
  },
  "tagPresence": {
    "score": 0.1,
    "max": 0
  },
  "tagPerformance": {
    "score": 0.1,
    "max": 0
  },
  "rules": {
    "score": 0.1,
    "max": 0
  },
  "pagePerformance": {
    "score": 0.1,
    "max": 0
  },
  "cookies": {
    "score": 0.1,
    "max": 0
  }
}

Get Audit Summary scores trends relative to specified audit run

Request

GET /v3/web-audits/{auditId}/runs/{runId}/reports/audit-summary/scores/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/audit-summary/scores/trends \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Audit Summary all scores trends data

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[].​scoresobjectrequired
runs[].​scores.​totalobjectrequired
runs[].​scores.​total.​scorenumber(float)required

Amount of points obtained in given score category. Rounded to one digit after dot

runs[].​scores.​total.​maxintegerrequired

Max points for given score category, inclusive

runs[].​scores.​tagPresenceobjectrequired
runs[].​scores.​tagPresence.​scorenumber(float)required

Amount of points obtained in given score category. Rounded to one digit after dot

runs[].​scores.​tagPresence.​maxintegerrequired

Max points for given score category, inclusive

runs[].​scores.​tagPerformanceobjectrequired
runs[].​scores.​tagPerformance.​scorenumber(float)required

Amount of points obtained in given score category. Rounded to one digit after dot

runs[].​scores.​tagPerformance.​maxintegerrequired

Max points for given score category, inclusive

runs[].​scores.​rulesobjectrequired
runs[].​scores.​rules.​scorenumber(float)required

Amount of points obtained in given score category. Rounded to one digit after dot

runs[].​scores.​rules.​maxintegerrequired

Max points for given score category, inclusive

runs[].​scores.​pagePerformanceobjectrequired
runs[].​scores.​pagePerformance.​scorenumber(float)required

Amount of points obtained in given score category. Rounded to one digit after dot

runs[].​scores.​pagePerformance.​maxintegerrequired

Max points for given score category, inclusive

runs[].​scores.​cookiesobjectrequired
runs[].​scores.​cookies.​scorenumber(float)required

Amount of points obtained in given score category. Rounded to one digit after dot

runs[].​scores.​cookies.​maxintegerrequired

Max points for given score category, inclusive

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

Get Audit Summary specific score trend values relative to current time

Request

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

Unique identification number for web audit

Example: 107239
trendNamestringrequired

name of requested trend

Enum"total""tag_presence""tag_performance""rules""page_performance""cookies"
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/audit-summary/scores/trends/{trendName}?days=1' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Audit Score 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[].​scoreobjectrequired
runs[].​score.​scorenumber(float)required

Amount of points obtained in given score category. Rounded to one digit after dot

runs[].​score.​maxintegerrequired

Max points for given score category, inclusive

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

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

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