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
Download OpenAPI description
Overview
Languages
Servers
ObservePoint Production API
https://api.observepoint.com/
Query
Controls sorting
Default "date_exported"
Enum"date_exported""item_name""run_date""export_name""exported_item_type""requested_by""status""is_scheduled"
aggregate filter for different export types and item types
Enum"audit""web_journey""live_connect""consent_categories""alert""account_usage""grid_data"
- ObservePoint Production APIhttps://api.observepoint.com/v3/exports
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://api.observepoint.com/v3/exports?page=0&size=20&sortBy=date_exported&sortDesc=false&exportedItemType=audit&search=my+audit&requestedByUserId=123&exportIds=0' \
-H 'Authorization: YOUR_API_KEY_HERE'Export Center exports
Common metadata for iterable
Total number of items available from all result pages combined
Page size - number of items per result page configured by size query parameter or default page size
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"
Enumeration of all high-level export types
Enum"AUDIT_RUN_EXPORT""WEB_JOURNEY_RUN_EXPORT""MANUAL_JOURNEY_RUN_EXPORT""CONSENT_CATEGORY_EXPORT""ALERT_EXPORT""ACCOUNT_USAGE_EXPORT""GRID_DATA_EXPORT"
Enum"audit""web_journey""live_connect""consent_categories""alert""account_usage""grid_data"
Name of an item this export has been executed for, see ItemType
Example: "My Audit"
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"
Specific export type, for example AuditRun_ExportTypeEnum for audits
Export file download link
Example: "https://api.observepoint.com/v3/exports/550e8400-e29b-41d4-a716-446655440000"
Response
application/json
{ "metadata": { "pagination": { … } }, "exports": [ { … } ] }
- ObservePoint Production APIhttps://api.observepoint.com/v3/exports/{exportUuid}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://api.observepoint.com/v3/exports/{exportUuid}' \
-H 'Authorization: YOUR_API_KEY_HERE'