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
Bodyapplication/jsonrequired Default "name"
Enum"name""emailAddress""messagesReceived""lastMessageReceived""testScenariosCount"
Filter params
The ids of the labels to be associated to the Email Inbox
Example: [223]
- ObservePoint Production APIhttps://api.observepoint.com/v3/email-inboxes/library
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://api.observepoint.com/v3/email-inboxes/library?page=0&pageSize=100&sortBy=name&sortDesc=false' \
-H 'Authorization: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"name": "Adobe Campaign Holidays, Marketing Department",
"emailAddress": "scanTest+<8^[a-z0-9]>-<truncatedInboxName>@email.observepoint.com",
"auditIds": [
0
],
"labelIds": [
223
],
"createdBy": [
123
]
}'Successful operation
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
The ids of the labels associated to the Email Inbox
Example: [223]
The email address that has been assigned to the inbox
Example: "scanTest+<8^[a-z0-9]>@email.observepoint.com"
The number of messages received by the Email Inbox
Default 0
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": { … } }, "emailInboxes": [ { … } ] }
- ObservePoint Production APIhttps://api.observepoint.com/v3/email-inboxes/{emailInboxId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://api.observepoint.com/v3/email-inboxes/{emailInboxId}' \
-H 'Authorization: YOUR_API_KEY_HERE'Response
application/json
{ "id": 10, "labelIds": [ 223 ], "name": "Christmas Marketing Campaign", "emailAddress": "scanTest+<8^[a-z0-9]>@email.observepoint.com", "notes": "string", "subscribers": { "onReceived": [ … ], "onProcessed": [ … ] }, "linkExclusionFilters": [ "string" ], "omitSocialLinks": true }
- ObservePoint Production APIhttps://api.observepoint.com/v3/email-inboxes/{emailInboxId}/audit-configurations
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://api.observepoint.com/v3/email-inboxes/{emailInboxId}/audit-configurations' \
-H 'Authorization: YOUR_API_KEY_HERE'Successful operation, resource found
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
[ { "auditId": 107239, "auditName": "string", "auditLastRunAt": "2016-08-18T17:33:00Z", "auditLabels": [ … ] } ]