Skip to content
v3 API
/
Scheduled Exports
/
Get specific Scheduled Export

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

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

Number of results page of an endpoint with paginated results

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

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"]
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

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"]
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
}

Update specific Scheduled Export

Request

PUT /v3/exports/scheduled/{scheduledExportId}
Security
API_Key
Path
scheduledExportIdinteger(int64)required
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 PUT \
  'https://api.observepoint.com/v3/exports/scheduled/{scheduledExportId}' \
  -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

Updated 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

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"]
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
}

Delete specific Scheduled Export

Request

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

Responses

Deleted successfully

Response
No content

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