Skip to content
/Data Sources

V3 API

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

Download OpenAPI description
combined.openapi.json
combined.openapi.yaml
Overview
URL
https://www.observepoint.com/contact-us
Languages
Servers
ObservePoint Production API
https://api.observepoint.com/

Alert Summary Report

Alert Summary report endpoints

Operations

Audit Summary Report

Audit Summary report endpoints

Operations

Browser Logs Report

Browser Logs report endpoints

Operations

File Changes Report

File changes report endpoints

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

Request Privacy Report

Request Privacy report endpoints

Operations

Rule Summary Report

Rule Summary report endpoints

Operations

Tag Duplicates and Multiples Report

Tag Duplicates and Multiples report endpoints

Operations

Tag Health Report

Tag Health report endpoints

Operations

Tag Inventory Report

Tag Inventory report endpoints

Operations

Tag Privacy Report

Tag privacy report endpoints

Operations

Variable Inventory Report

Variable Inventory report endpoints

Operations

Audit Run Data

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

Operations

Account Usage Export

Export account usage data

Operations

Alert Export

Export alert data

Operations

Audit Run Export

Export audit run data

Operations

Exports Center

Access requested exports status/information

Operations

Manual Journey Run Export

Export manual journey run data

Operations

Scheduled Exports

Manage scheduled grid report data exports

Operations

Web Journey Run Export

Export web journey run data

Operations

Account's Triggered Alerts

Account-level triggered alerts

Operations

Account Usage Alerts

Alerts related to account usage

Operations

Alerts

Alert management and configuration

Operations

Email Inbox Message Alerts

Email inbox message alerts

Operations

Account Usage

Account usage data

Operations

Email Inbox Configuration

APIs for managing email inbox configurations and setting

Operations

Email Inbox Messages

Get Email Inbox message details

Operations

Email Inboxes

APIs for getting email messages and results from email inboxes

Operations

Action Set Action Rules

APIs for managing Action Set Action Rules

Operations

Action Set Actions

APIs for managing Action Set Actions

Operations

Action Sets

APIs for managing Action Sets

Operations

Audit Actions

APIs for managing audit actions

Operations

Audit Blocking Config

APIs for managing audit request blocking configuration

Operations

Audit Login Actions

APIs for managing audit login actions

Operations

Audits Management

APIs for managing audits

Operations

Custom Headers

APIs for managing custom HTTP header groups

Operations

Data Sources

APIs for managing Data Sources

Operations

Get all data sources in the account

Request

GET /v3/data-sources

this endpoint is get all the data sources in the account with their labels

Security
API_Key
Query
pageinteger>= 0

Number of results page of an endpoint with paginated results

Default 0
pageSizeinteger[ 100 .. 1000 ]
Default 100
sortBystring
Default "lastRun"
Enum"itemName""itemType""lastRun"
sortDescboolean

Controls sorting order

Default false
itemNamestring

filter the items by a given name

labelIdsArray of integers

filter the items by label ids

itemTypestring

filter the items by a given item type

Enum"audit""web-journey"
withRunsboolean

if true - response will only include data sources that have at least one run, if false - only data sources that have no runs. All data sources if not set.

withLabelsboolean

if true - response will include labels for each data source, if false - only the data source id. All data sources if not set. Disabling labels will improve performance.

Default true
withConsentCategoriesboolean

if true - response will include consent categories. Disabling this will improve performance.

Default true
curl -i -X GET \
  'https://api.observepoint.com/v3/data-sources?page=0&pageSize=100&sortBy=itemName&sortDesc=false&itemName=string&labelIds=0&itemType=audit&withRuns=true&withLabels=true&withConsentCategories=true' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Retrieve user events in the account

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

dataSourcesArray of objectsrequired
dataSources[].​itemTypestringrequired

Type of data source item.

Enum"audit""web-journey"
dataSources[].​itemIdintegerrequired
dataSources[].​itemNamestring
dataSources[].​lastCompletedRunobject
dataSources[].​consentCategoryTypestring
Enum"approved""unapproved"
dataSources[].​labelsArray of objectsrequired
dataSources[].​labels[].​idinteger(int64)>= 1required

Label identifier

Example: 223
dataSources[].​labels[].​namestringrequired
Response
application/json
{
  "metadata": {
    "pagination": { … }
  },
  "dataSources": [
    { … }
  ]
}

Search data sources with specific item IDs

Request

POST /v3/data-sources/search

This endpoint retrieves all the data sources in the account with their labels.

Security
API_Key
Query
pageinteger>= 0

Number of results page of an endpoint with paginated results

Default 0
pageSizeinteger[ 100 .. 1000 ]
Default 100
sortBystring
Default "lastRun"
Enum"itemName""itemType""lastRun"
sortDescboolean

Controls sorting order

Default false
Bodyapplication/json
itemNamestring

filter the items by a given name

labelIdsArray of integers

filter the items by label ids

itemIdsArray of integers

filter the items by IDs (itemName & labelIds are ignored)

itemTypestring

Type of data source item.

Enum"audit""web-journey"
withRunsboolean

If true - response includes only data sources with at least one run. If false - only those without runs. All if not set.

curl -i -X POST \
  'https://api.observepoint.com/v3/data-sources/search?page=0&pageSize=100&sortBy=itemName&sortDesc=false' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "itemName": "string",
    "labelIds": [
      0
    ],
    "itemIds": [
      0
    ],
    "itemType": "audit",
    "withRuns": true
  }'

Responses

Retrieve user events in the account

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

dataSourcesArray of objectsrequired
dataSources[].​itemTypestringrequired

Type of data source item.

Enum"audit""web-journey"
dataSources[].​itemIdintegerrequired
dataSources[].​itemNamestring
dataSources[].​lastCompletedRunobject
dataSources[].​consentCategoryTypestring
Enum"approved""unapproved"
dataSources[].​labelsArray of objectsrequired
dataSources[].​labels[].​idinteger(int64)>= 1required

Label identifier

Example: 223
dataSources[].​labels[].​namestringrequired
Response
application/json
{
  "metadata": {
    "pagination": { … }
  },
  "dataSources": [
    { … }
  ]
}

Search for target items (audits or web journeys) for data source assignment based on searched item type (ALERT, CUSTOM_HEADER, EMAIL_INBOX, RULE)

Request

POST /v3/data-sources/target-items/{itemType}/search
Security
API_Key
Path
itemTypestringrequired

Type of items to search for (AUDIT or WEB_JOURNEY)

Enum"AUDIT""WEB_JOURNEY"
Query
sortBystring
Default "ITEM_NAME"
Enum"ITEM_NAME""RUN_DATE"
sortDescboolean

Controls sorting order

Default false
pageSizeinteger[ 100 .. 1000 ]
Default 100
pageinteger>= 0

Number of results page of an endpoint with paginated results

Default 0
Bodyapplication/json
searchItemTypestring
Enum"ALERT""CUSTOM_HEADER""EMAIL_INBOX""RULE"
searchedItemIdinteger(int64)
assignedToSearchedItemboolean
itemNamestringnon-empty
itemLabelsArray of integers(int64)non-empty

non-empty array of labels present on an item, works as "item has all specified labels" filter

Example: [223]
foldersobject

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

curl -i -X POST \
  'https://api.observepoint.com/v3/data-sources/target-items/{itemType}/search?sortBy=ITEM_NAME&sortDesc=false&pageSize=100&page=0' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "searchItemType": "ALERT",
    "searchedItemId": 0,
    "assignedToSearchedItem": true,
    "itemName": "string",
    "itemLabels": [
      223
    ],
    "folders": {
      "folders": [
        {
          "folderId": 123,
          "domains": [
            123
          ]
        }
      ]
    }
  }'

Responses

Successful operation

Bodyapplication/json
metadataobject
itemsArray of objects
Response
application/json
{
  "metadata": {
    "totalCount": 0,
    "totalPageCount": 0,
    "pageSize": 0,
    "currentPageSize": 0,
    "currentPageNumber": 0
  },
  "items": [
    { … }
  ]
}

Geo Locations

APIs for geo locations

Operations

Notification Center

Find and manage email subscriptions

Operations

Remote File Mappings

APIs for managing Remote File Mappings

Operations

Rules

APIs for managing rules

Operations

Schedules

APIs for item schedules and calendars

Operations

Site Censuses

APIs for managing Site Census

Operations

User Events

APIs for managing User Events

Operations

Web Journey Blocking Config

APIs for managing web journey request blocking configuration

Operations

Web Journey Custom Headers

APIs for managing web journey custom headers

Operations

Web Journeys Management

APIs for managing Web Journeys

Operations