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//
- Get all emails in an account
Get emails subscribed to given items
Search assignable items (audits, journeys, rules etc) for specified email
Get all emails in an acco...
V3 API
Download OpenAPI description
Overview
Languages
Servers
ObservePoint Production API
https://api.observepoint.com/
- ObservePoint Production APIhttps://api.observepoint.com/v3/notification-center/emails
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://api.observepoint.com/v3/notification-center/emails \
-H 'Authorization: YOUR_API_KEY_HERE'Response
application/json
{ "emails": [ { … } ] }
- ObservePoint Production APIhttps://api.observepoint.com/v3/notification-center/emails
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://api.observepoint.com/v3/notification-center/emails \
-H 'Authorization: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"itemType": "AUDIT",
"itemIds": [
107239
]
}'Response
application/json
{ "emails": [ { … } ] }
Bodyapplication/jsonrequired
non-empty array of labels present on an item. When multiple labels specified, target item is expected to have all of them (condition works as "AND" for all labels specified)
Example: [223]
- ObservePoint Production APIhttps://api.observepoint.com/v3/notification-center/target-items/{itemType}/search
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://api.observepoint.com/v3/notification-center/target-items/{itemType}/search?size=50&sortBy=IS_ASSIGNED&page=0&sortDesc=false' \
-H 'Authorization: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"email": "string",
"itemName": "string",
"itemLabels": [
223
],
"isAssigned": true
}'Items that have specified email both assigned and not assigned
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
TRUE if specified email is assigned to this item, FALSE otherwise
TRUE if specified email can be assigned or unassigned from this item, FALSE otherwise
Enum"AUDIT""WEB_JOURNEY""RULE""ALERT""USAGE_ALERT""EMAIL_INBOX_MESSAGE_RECEIVED""EMAIL_INBOX_MESSAGE_PROCESSED""SCHEDULED_EXPORT"
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
{ "metadata": { "pagination": { … } }, "items": [ { … } ] }