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.
v3 API//
- Delete specific Scheduled Export
Get Scheduled Exports
Create scheduled export
Get specific Scheduled Export
Update specific Scheduled Export
Delete specific Scheduled...
V3 API
Download OpenAPI description
Overview
Languages
Servers
ObservePoint Production API
https://api.observepoint.com/
Bodyapplication/jsonrequired
Scheduled Export definition
Configuration for the email sent when export completes.
List of email addresses that will receive export email.
Example: ["user@example.com"]
When and how often Scheduled Export will be run.
Date of first desired start (if in range of recurrence rule).
Example: "2025-03-14T12:00:00"
An RFC-5545 (https://www.rfc-editor.org/rfc/rfc5545#appendix-A) compliant recurrence rule string.
Example: "WKST=SU;FREQ=DAILY;INTERVAL=1"
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"
- ObservePoint Production APIhttps://api.observepoint.com/v3/exports/scheduled/{scheduledExportId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
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"
]
}
}'Updated Scheduled Export
Configuration for the email sent when export completes.
List of email addresses that will receive export email.
Example: ["user@example.com"]
Date-time in RFC3339 profile ISO 8601 format with the following additional restrictions:
- An uppercase T must separate the date and time portions.
- 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"
Date-time in RFC3339 profile ISO 8601 format with the following additional restrictions:
- An uppercase T must separate the date and time portions.
- 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"
Date of first desired start (if in range of recurrence rule).
Example: "2025-03-14T12:00:00"
An RFC-5545 (https://www.rfc-editor.org/rfc/rfc5545#appendix-A) compliant recurrence rule string.
Example: "WKST=SU;FREQ=DAILY;INTERVAL=1"
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"
List of dates to skip when scheduling.
Example: ["2025-03-14T12:00:00"]
Date-time in RFC3339 profile ISO 8601 format with the following additional restrictions:
- An uppercase T must separate the date and time portions.
- 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"
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 }
- ObservePoint Production APIhttps://api.observepoint.com/v3/exports/scheduled/{scheduledExportId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
'https://api.observepoint.com/v3/exports/scheduled/{scheduledExportId}' \
-H 'Authorization: YOUR_API_KEY_HERE'