Skip to content
v3 API
/
Account Usage

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

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

Get brief usage overview for account

Request

GET /v3/usage/overview
Security
API_Key
curl -i -X GET \
  https://api.observepoint.com/v3/usage/overview \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Usage overview

Bodyapplication/json
auditUsageobjectrequired

usagePercentage and usageLimit can be omitted if there is no limit. overLimitPrice is only visible to account admins.

auditUsage.​usageCountinteger(integer)required

Number of pages scanned (for audits) or runs completed (for web journeys) to date

auditUsage.​usageLimitinteger(integer)

Limit of pages scanned (for audits) or runs completed (for web journeys) for the current contract term

auditUsage.​limitNoteTypestring
Enum"UNLIMITED""LIMIT_UNDETERMINED"
auditUsage.​usagePercentagenumber(float)

Percentage of usage relative to contract term limit

auditUsage.​overLimitPriceobject

Price of a page scan (for audits) or a run (for web journeys) over the limit

auditUsage.​currentContractTermobjectrequired

Contract start and end dates

auditUsage.​currentContractTerm.​startDateInclusivestring(date)required

Date in ISO 8601 format, in UTC timezone

auditUsage.​currentContractTerm.​endDateInclusivestring(date)required

Date in ISO 8601 format, in UTC timezone

webJourneyUsageobject

usagePercentage and usageLimit can be omitted if there is no limit. overLimitPrice is only visible to account admins.

allowOveragesbooleanrequired

When TRUE, account is allowed to go over the limit and will be charged for overages. When FALSE, account will be blocked from running audits and web journeys that will go over the limit.

Response
application/json
{
  "auditUsage": {
    "usageCount": 0,
    "usageLimit": 0,
    "limitNoteType": "UNLIMITED",
    "usagePercentage": 0.1,
    "overLimitPrice": { … },
    "currentContractTerm": { … }
  },
  "webJourneyUsage": {
    "usageCount": 0,
    "usageLimit": 0,
    "limitNoteType": "UNLIMITED",
    "usagePercentage": 0.1,
    "overLimitPrice": { … },
    "currentContractTerm": { … }
  },
  "allowOverages": true
}

Get not filterable usage summary for account

Request

GET /v3/usage/summary
Security
API_Key
curl -i -X GET \
  https://api.observepoint.com/v3/usage/summary \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Basic usage summary

Bodyapplication/json
usersUsageobjectrequired
usersUsage.​totalUsersintegerrequired

Number of users in account

usersUsage.​usersLoggedInLast30DaysArray of integersrequired

List of user IDs that logged in last 30 days

Example: [123]
contactsArray of objects>= 0 itemsrequired

List of people to contact for support

contacts[].​typestringrequired

AE - Account Executive CSM - Customer Success Manager

Enum"AE""CSM"
contacts[].​namestringrequired

Name of the person to contact

contacts[].​emailstringrequired
allowOveragesbooleanrequired

When TRUE, account is allowed to go over the limit and will be charged for overages. When FALSE, account will be blocked from running audits and web journeys that will go over the limit.

Response
application/json
{
  "usersUsage": {
    "totalUsers": 0,
    "usersLoggedInLast30Days": [ … ]
  },
  "contacts": [
    { … }
  ],
  "allowOverages": true
}

Get filterable specific item type usage summary for account. If web journeys are not included in contract, 404 status code will be returned

Request

POST /v3/usage/{itemType}/summary
Security
API_Key
Path
itemTypestringrequired
Enum"AUDIT""WEB_JOURNEY"
Bodyapplication/json
dataSourcesArray of integers(int64)non-empty

Non-empty array of data sources. Usage for selected data sources only will be shown

Example: [107239]
dataSourceCreatorsArray of integersnon-empty

Non-empty array of user IDs. Matches data sources that have been created by any of the specified users

Example: [123]
dataSourceFoldersArray of objectsnon-empty

non-empty array of folders with domains (subfolders), items from which will be included in response

dataSourceLabelsArray of integers(int64)non-empty

Non-empty array of labels present on an item. Matches data sources that have all specified labels

runFrequenciesArray of stringsnon-empty

Non-empty array of frequency names. Matches data sources that have any of the specified frequencies

Items Enum"paused""once""15 minutes""1 hour""6 hours""12 hours""daily""weekly""biweekly""monthly"
contractTermobject

Select specific contract term. Current term will be shown if omitted

curl -i -X POST \
  'https://api.observepoint.com/v3/usage/{itemType}/summary' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "dataSources": [
      107239
    ],
    "dataSourceCreators": [
      123
    ],
    "dataSourceFolders": [
      {
        "folderId": 123,
        "domains": [
          123
        ]
      }
    ],
    "dataSourceLabels": [
      0
    ],
    "runFrequencies": [
      "paused"
    ],
    "contractTerm": {
      "startDateInclusive": "2019-08-24",
      "endDateInclusive": "2019-08-24"
    }
  }'

Responses

Specific item type usage summary

Bodyapplication/json
currentContractTermobjectrequired

Contract start and end dates

currentContractTerm.​startDateInclusivestring(date)required

Date in ISO 8601 format, in UTC timezone

currentContractTerm.​endDateInclusivestring(date)required

Date in ISO 8601 format, in UTC timezone

contractTermsArray of objects>= 0 itemsrequired

Dates of contracts

contractTerms[].​startDateInclusivestring(date)required

Date in ISO 8601 format, in UTC timezone

contractTerms[].​endDateInclusivestring(date)required

Date in ISO 8601 format, in UTC timezone

usageobjectrequired

Subtypes:

  • AccountUsageV2_SpecificItemTypeSummary_AuditUsage
  • AccountUsageV2_SpecificItemTypeSummary_WebJourneyUsage

cumulativeTotal - number of pages scanned (for audits) or runs completed (for web journeys) to date. termLimit, cumulativePacing - can be omitted if there is no limit. overLimitPrice is only visible to account admins.

usage.​itemTypestringrequired
Enum"AUDIT""WEB_JOURNEY"
Discriminator
usage.​cumulativeTotalobjectrequired

filtered property can be omitted if filters were not applied

usage.​cumulativeTotal.​totalintegerrequired
usage.​cumulativeTotal.​filteredinteger
usage.​termLimitinteger

Limit of pages scanned (for audits) or runs completed (for web journeys) for the contract term

usage.​limitNoteTypestring
Enum"UNLIMITED""LIMIT_UNDETERMINED"
usage.​cumulativePacinginteger

Shows how many pages should be scanned to date to hit the limit by the end of the contract term

usage.​overLimitPriceobject

Price of a page scan (for audits) or a run (for web journeys) over the limit

Response
application/json
{
  "currentContractTerm": {
    "startDateInclusive": "2019-08-24",
    "endDateInclusive": "2019-08-24"
  },
  "contractTerms": [
    { … }
  ],
  "usage": {
    "itemType": "AUDIT",
    "cumulativeTotal": { … },
    "termLimit": 0,
    "limitNoteType": "UNLIMITED",
    "cumulativePacing": 0,
    "overLimitPrice": { … }
  }
}

Get usage trends for specified item type

Request

POST /v3/usage/{itemType}/trends
Security
API_Key
Path
itemTypestringrequired
Enum"AUDIT""WEB_JOURNEY"
Bodyapplication/json
dataSourcesArray of integers(int64)non-empty

Non-empty array of data sources. Usage for selected data sources only will be shown

Example: [107239]
dataSourceCreatorsArray of integersnon-empty

Non-empty array of user IDs. Matches data sources that have been created by any of the specified users

Example: [123]
dataSourceFoldersArray of objectsnon-empty

non-empty array of folders with domains (subfolders), items from which will be included in response

dataSourceLabelsArray of integers(int64)non-empty

Non-empty array of labels present on an item. Matches data sources that have all specified labels

runFrequenciesArray of stringsnon-empty

Non-empty array of frequency names. Matches data sources that have any of the specified frequencies

Items Enum"paused""once""15 minutes""1 hour""6 hours""12 hours""daily""weekly""biweekly""monthly"
contractTermobject

Select specific contract term. Current term will be shown if omitted

curl -i -X POST \
  'https://api.observepoint.com/v3/usage/{itemType}/trends' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "dataSources": [
      107239
    ],
    "dataSourceCreators": [
      123
    ],
    "dataSourceFolders": [
      {
        "folderId": 123,
        "domains": [
          123
        ]
      }
    ],
    "dataSourceLabels": [
      0
    ],
    "runFrequencies": [
      "paused"
    ],
    "contractTerm": {
      "startDateInclusive": "2019-08-24",
      "endDateInclusive": "2019-08-24"
    }
  }'

Responses

Usage trends

Bodyapplication/json
pastPeriodsArray of objectsrequired

Represents all past months

pastPeriods[].​startDateInclusivestring(date)required

Date in ISO 8601 format, in UTC timezone

pastPeriods[].​endDateExclusivestring(date)required

Date in ISO 8601 format, in UTC timezone

pastPeriods[].​periodTotalobjectrequired

filtered property can be omitted if filters were not applied

pastPeriods[].​periodTotal.​totalintegerrequired
pastPeriods[].​periodTotal.​filteredinteger
pastPeriods[].​cumulativeTotalobjectrequired

filtered property can be omitted if filters were not applied

pastPeriods[].​cumulativeTotal.​totalintegerrequired
pastPeriods[].​cumulativeTotal.​filteredinteger
currentPeriodobject

periodProjectedTotal and cumulativeProjectedTotal can represent either pages scanned (for audits) or runs completed (for web journeys)

futurePeriodsArray of objectsrequired

Represents future months, with projected values

futurePeriods[].​startDateInclusivestring(date)required

Date in ISO 8601 format, in UTC timezone

futurePeriods[].​endDateExclusivestring(date)required

Date in ISO 8601 format, in UTC timezone

futurePeriods[].​periodProjectedTotalobjectrequired

Duplicates AccountUsageV2_ProjectedUsage, but includes total and filtered values for each estimate

futurePeriods[].​periodProjectedTotal.​scheduledUsageEstimateobjectrequired

filtered property can be omitted if filters were not applied

futurePeriods[].​periodProjectedTotal.​scheduledUsageEstimate.​totalintegerrequired
futurePeriods[].​periodProjectedTotal.​scheduledUsageEstimate.​filteredinteger
futurePeriods[].​periodProjectedTotal.​historicalUsageEstimateobjectrequired

filtered property can be omitted if filters were not applied

futurePeriods[].​periodProjectedTotal.​historicalUsageEstimate.​totalintegerrequired
futurePeriods[].​periodProjectedTotal.​historicalUsageEstimate.​filteredinteger
futurePeriods[].​cumulativeProjectedTotalobjectrequired

Duplicates AccountUsageV2_ProjectedUsage, but includes total and filtered values for each estimate

futurePeriods[].​cumulativeProjectedTotal.​scheduledUsageEstimateobjectrequired

filtered property can be omitted if filters were not applied

futurePeriods[].​cumulativeProjectedTotal.​scheduledUsageEstimate.​totalintegerrequired
futurePeriods[].​cumulativeProjectedTotal.​scheduledUsageEstimate.​filteredinteger
futurePeriods[].​cumulativeProjectedTotal.​historicalUsageEstimateobjectrequired

filtered property can be omitted if filters were not applied

futurePeriods[].​cumulativeProjectedTotal.​historicalUsageEstimate.​totalintegerrequired
futurePeriods[].​cumulativeProjectedTotal.​historicalUsageEstimate.​filteredinteger
termLimitinteger

Limit of pages scanned (for audits) or runs completed (for web journeys) for the contract term

limitNoteTypestring
Enum"UNLIMITED""LIMIT_UNDETERMINED"
monthlyPacinginteger

Shows how many pages should be scanned per month to hit the limit by the end of the contract term

Response
application/json
{
  "pastPeriods": [
    { … }
  ],
  "currentPeriod": {
    "startDateInclusive": "2019-08-24",
    "endDateExclusive": "2019-08-24",
    "periodTotal": { … },
    "cumulativeTotal": { … },
    "periodProjectedTotal": { … },
    "cumulativeProjectedTotal": { … }
  },
  "futurePeriods": [
    { … }
  ],
  "termLimit": 0,
  "limitNoteType": "UNLIMITED",
  "monthlyPacing": 0
}

Get usage trends for rolling week, for specified item type

Request

GET /v3/usage/{itemType}/daily-trends
Security
API_Key
Path
itemTypestringrequired
Enum"AUDIT""WEB_JOURNEY"
curl -i -X GET \
  'https://api.observepoint.com/v3/usage/{itemType}/daily-trends' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Usage trends

Bodyapplication/json
dailyUsageItemsArray of objectsrequired

Runs completed per day in the last 3 days, today and scheduled in the next 3 days

dailyUsageItems[].​daystring(date)required

Date in ISO 8601 format, in UTC timezone

dailyUsageItems[].​noOfCompletedRunsinteger
dailyUsageItems[].​noOfScheduledRunsinteger
dailyUsageItems[].​completedItemsArray of objects<= 100 items

100 items per day in the account

dailyUsageItems[].​scheduledItemsArray of objects<= 100 items

100 items per day in the account

dailyUsageItems[].​noOfPagesScannedinteger

used for Audits only

dailyUsageItems[].​noOfPagesScheduledToScaninteger

used for Audits only

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

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