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//
- Search for target items (audits or web journeys) for data source assignment based on searched item type (ALERT, CUSTOM_HEADER, EMAIL_INBOX, RULE)
Get all data sources in the account
Search data sources with specific item IDs
Search for target items (...
V3 API
Download OpenAPI description
Overview
Languages
Servers
ObservePoint Production API
https://api.observepoint.com/
- ObservePoint Production APIhttps://api.observepoint.com/v3/data-sources/search
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://api.observepoint.com/v3/data-sources/search?page=0&pageSize=100&sortBy=itemName&sortDesc=false' \
-H 'Authorization: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"itemName": "string",
"labelIds": [
0
],
"itemIds": [
0
],
"itemType": "audit",
"withRuns": true
}'Response
application/json
{ "metadata": { "pagination": { … } }, "dataSources": [ { … } ] }
Bodyapplication/json
non-empty array of labels present on an item, works as "item has all specified labels" filter
Example: [223]
- ObservePoint Production APIhttps://api.observepoint.com/v3/data-sources/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/data-sources/target-items/{itemType}/search?sortBy=ITEM_NAME&sortDesc=false&pageSize=100&page=0' \
-H 'Authorization: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"searchItemType": "ALERT",
"searchedItemId": 0,
"assignedToSearchedItem": true,
"itemName": "string",
"itemLabels": [
223
],
"folders": {
"folders": [
{
"folderId": 123,
"domains": [
123
]
}
]
}
}'Response
application/json
{ "metadata": { "totalCount": 0, "totalPageCount": 0, "pageSize": 0, "currentPageSize": 0, "currentPageNumber": 0 }, "items": [ { … } ] }