Skip to content
v3 API/
/
Create scheduled export

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

Get Scheduled Exports

Request

GET /v3/exports/scheduled
Security
API_Key
Query
searchstring

Return Scheduled Exports which contain the provided text in their name, schedule description, owner user name, or exported item name.

exportedItemTypestring

Return Scheduled Exports with specified exported item type.

Value"saved_report"
exportedItemIdinteger(int64)

Return Scheduled Exports for a specific exported item. Should be used together with exportedItemType parameter.

sizeinteger[ 50 .. 1000 ]
Default 50
sortBystring
Enum"name""schedule_description""schedule_is_paused""owner_user_name""exported_item_type""exported_item_name""is_editable""created_at""updated_at"
pageinteger>= 0

Page number, starts with 0

Default 0
sortDescboolean

Controls sorting order

Default false
curl -i -X GET \
  'https://api.observepoint.com/v3/exports/scheduled?search=string&exportedItemType=saved_report&exportedItemId=0&size=50&sortBy=name&page=0&sortDesc=false' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Paginated list of Scheduled Exports

Bodyapplication/json
metadataobject

Common metadata for iterable

scheduledExportsArray of objects
Response
application/json
{
  "metadata": {
    "pagination": { … }
  },
  "scheduledExports": [
    { … }
  ]
}

Create scheduled export

Request

POST /v3/exports/scheduled
Security
API_Key
Bodyapplication/jsonrequired

Scheduled Export definition

namestringrequired
exportedItemTypestringrequired
Value"saved_report"
exportedItemIdinteger(int64)required
exportFileFormatstringrequired
Enum"csv""tsv""xlsx""parquet"
exportEmailConfigobjectrequired

Configuration for the email sent when export completes.

exportEmailConfig.​addExportFileAttachmentbooleanrequired
exportEmailConfig.​customMessagestring
exportEmailConfig.​reportLinkTypestring
Enum"public_link""regular_link"
emailsArray of strings(email)non-emptyrequired

List of email addresses that will receive export email.

Example: ["user@example.com"]
scheduleobjectrequired

When and how often Scheduled Export will be run.

schedule.​dtStartstring(local-date-time)required

Date of first desired start (if in range of recurrence rule).

Example: "2025-03-14T12:00:00"
schedule.​recurrenceRulestringrequired

An RFC-5545 (https://www.rfc-editor.org/rfc/rfc5545#appendix-A) compliant recurrence rule string.

Example: "WKST=SU;FREQ=DAILY;INTERVAL=1"
schedule.​tzIdstringrequired

Timezone identifier compliant with tz database (ex. America/New_York). https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

Example: "America/New_York"
schedule.​isPausedbooleanrequired

Whether the schedule is paused or not.

schedule.​exceptionsArray of strings(local-date-time)non-empty

List of dates to skip when scheduling.

Example: ["2025-03-14T12:00:00"]
curl -i -X POST \
  https://api.observepoint.com/v3/exports/scheduled \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "exportedItemType": "saved_report",
    "exportedItemId": 0,
    "exportFileFormat": "csv",
    "exportEmailConfig": {
      "addExportFileAttachment": true,
      "customMessage": "string",
      "reportLinkType": "public_link"
    },
    "emails": [
      "user@example.com"
    ],
    "schedule": {
      "dtStart": "2025-03-14T12:00:00",
      "recurrenceRule": "WKST=SU;FREQ=DAILY;INTERVAL=1",
      "tzId": "America/New_York",
      "isPaused": true,
      "exceptions": [
        "2025-03-14T12:00:00"
      ]
    }
  }'

Responses

Created Scheduled Export

Bodyapplication/json
namestringrequired
exportedItemTypestringrequired
Value"saved_report"
exportedItemIdinteger(int64)required
exportFileFormatstringrequired
Enum"csv""tsv""xlsx""parquet"
exportEmailConfigobjectrequired

Configuration for the email sent when export completes.

exportEmailConfig.​addExportFileAttachmentbooleanrequired
exportEmailConfig.​customMessagestring
exportEmailConfig.​reportLinkTypestring
Enum"public_link""regular_link"
emailsArray of strings(email)non-emptyrequired

List of email addresses that will receive export email.

Example: ["user@example.com"]
idinteger(int64)required
createdAtstring(date-time)

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"
updatedAtstring(date-time)

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"
ownerobject
scheduleobjectrequired
schedule.​dtStartstring(local-date-time)required

Date of first desired start (if in range of recurrence rule).

Example: "2025-03-14T12:00:00"
schedule.​recurrenceRulestringrequired

An RFC-5545 (https://www.rfc-editor.org/rfc/rfc5545#appendix-A) compliant recurrence rule string.

Example: "WKST=SU;FREQ=DAILY;INTERVAL=1"
schedule.​tzIdstringrequired

Timezone identifier compliant with tz database (ex. America/New_York). https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

Example: "America/New_York"
schedule.​isPausedbooleanrequired

Whether the schedule is paused or not.

schedule.​exceptionsArray of strings(local-date-time)non-empty

List of dates to skip when scheduling.

Example: ["2025-03-14T12:00:00"]
schedule.​descriptionstringrequired
Example: "Every day"
schedule.​presetTypestringrequired
Example: "DAILY"
schedule.​nextExportAtstring(date-time)

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"
exportedItemNamestringrequired
isEditablebooleanrequired
Response
application/json
{
  "name": "string",
  "exportedItemType": "saved_report",
  "exportedItemId": 0,
  "exportFileFormat": "csv",
  "exportEmailConfig": {
    "addExportFileAttachment": true,
    "customMessage": "string",
    "reportLinkType": "public_link"
  },
  "emails": [
    "user@example.com"
  ],
  "id": 0,
  "createdAt": "2016-08-18T17:33:00Z",
  "updatedAt": "2016-08-18T17:33:00Z",
  "owner": {
    "id": 123,
    "userName": "string"
  },
  "schedule": {
    "dtStart": "2025-03-14T12:00:00",
    "recurrenceRule": "WKST=SU;FREQ=DAILY;INTERVAL=1",
    "tzId": "America/New_York",
    "isPaused": true,
    "exceptions": [ … ],
    "description": "Every day",
    "presetType": "DAILY",
    "nextExportAt": "2016-08-18T17:33:00Z"
  },
  "exportedItemName": "string",
  "isEditable": true
}

Get specific Scheduled Export

Request

GET /v3/exports/scheduled/{scheduledExportId}
Security
API_Key
Path
scheduledExportIdinteger(int64)required
curl -i -X GET \
  'https://api.observepoint.com/v3/exports/scheduled/{scheduledExportId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Scheduled Export definition

Bodyapplication/json
namestringrequired
exportedItemTypestringrequired
Value"saved_report"
exportedItemIdinteger(int64)required
exportFileFormatstringrequired
Enum"csv""tsv""xlsx""parquet"
exportEmailConfigobjectrequired

Configuration for the email sent when export completes.

exportEmailConfig.​addExportFileAttachmentbooleanrequired
exportEmailConfig.​customMessagestring
exportEmailConfig.​reportLinkTypestring
Enum"public_link""regular_link"
emailsArray of strings(email)non-emptyrequired

List of email addresses that will receive export email.

Example: ["user@example.com"]
idinteger(int64)required
createdAtstring(date-time)

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"
updatedAtstring(date-time)

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"
ownerobject
scheduleobjectrequired
schedule.​dtStartstring(local-date-time)required

Date of first desired start (if in range of recurrence rule).

Example: "2025-03-14T12:00:00"
schedule.​recurrenceRulestringrequired

An RFC-5545 (https://www.rfc-editor.org/rfc/rfc5545#appendix-A) compliant recurrence rule string.

Example: "WKST=SU;FREQ=DAILY;INTERVAL=1"
schedule.​tzIdstringrequired

Timezone identifier compliant with tz database (ex. America/New_York). https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

Example: "America/New_York"
schedule.​isPausedbooleanrequired

Whether the schedule is paused or not.

schedule.​exceptionsArray of strings(local-date-time)non-empty

List of dates to skip when scheduling.

Example: ["2025-03-14T12:00:00"]
schedule.​descriptionstringrequired
Example: "Every day"
schedule.​presetTypestringrequired
Example: "DAILY"
schedule.​nextExportAtstring(date-time)

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"
exportedItemNamestringrequired
isEditablebooleanrequired
Response
application/json
{
  "name": "string",
  "exportedItemType": "saved_report",
  "exportedItemId": 0,
  "exportFileFormat": "csv",
  "exportEmailConfig": {
    "addExportFileAttachment": true,
    "customMessage": "string",
    "reportLinkType": "public_link"
  },
  "emails": [
    "user@example.com"
  ],
  "id": 0,
  "createdAt": "2016-08-18T17:33:00Z",
  "updatedAt": "2016-08-18T17:33:00Z",
  "owner": {
    "id": 123,
    "userName": "string"
  },
  "schedule": {
    "dtStart": "2025-03-14T12:00:00",
    "recurrenceRule": "WKST=SU;FREQ=DAILY;INTERVAL=1",
    "tzId": "America/New_York",
    "isPaused": true,
    "exceptions": [ … ],
    "description": "Every day",
    "presetType": "DAILY",
    "nextExportAt": "2016-08-18T17:33:00Z"
  },
  "exportedItemName": "string",
  "isEditable": true
}

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

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