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 a site census by ID
Get all censuses for an account
Create a new site census
Update an existing site census
Delete a site census by ID
Returns a summary of the current census results data
Returns a preview of the current census results data given specific path patterns
Starts data-collection for a given census
Stops data-collection for a given census
Get a site census by ID
V3 API
Download OpenAPI description
Overview
Languages
Servers
ObservePoint Production API
https://api.observepoint.com/
Bodyapplication/jsonrequired
Create a new site census
The date and time when the current scan session started.
Target email addresses for notification when this census auto-pauses or runs out of URLs.
The fully qualified domain name (FQDN) to match against the URL.
- ObservePoint Production APIhttps://api.observepoint.com/v3/site-censuses
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://api.observepoint.com/v3/site-censuses \
-H 'Authorization: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"id": 0,
"accountId": 0,
"name": "string",
"autoPauseAfter": 1,
"ownerId": 0,
"currentScanStartedAt": "2019-08-24T14:15:22Z",
"lastScanStoppedAt": "2019-08-24T14:15:22Z",
"notificationEmails": [
"user@example.com"
],
"startingUrls": [
"http://example.com"
],
"filterPatterns": [
{
"pathPattern": "string",
"fqdn": "string",
"type": "PRIORITY"
}
]
}'Response
application/json
{ "id": 0, "accountId": 0, "name": "string", "autoPauseAfter": 1, "ownerId": 0, "currentScanStartedAt": "2019-08-24T14:15:22Z", "lastScanStoppedAt": "2019-08-24T14:15:22Z", "notificationEmails": [ "user@example.com" ], "startingUrls": [ "http://example.com" ], "filterPatterns": [ { … } ] }
- ObservePoint Production APIhttps://api.observepoint.com/v3/site-censuses/{censusId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://api.observepoint.com/v3/site-censuses/{censusId}' \
-H 'Authorization: YOUR_API_KEY_HERE'Response
application/json
{ "id": 0, "accountId": 0, "name": "string", "autoPauseAfter": 1, "ownerId": 0, "currentScanStartedAt": "2019-08-24T14:15:22Z", "lastScanStoppedAt": "2019-08-24T14:15:22Z", "notificationEmails": [ "user@example.com" ], "startingUrls": [ "http://example.com" ], "filterPatterns": [ { … } ] }
Bodyapplication/jsonrequired
Update an existing site census by ID
The date and time when the current scan session started.
Target email addresses for notification when this census auto-pauses or runs out of URLs.
The fully qualified domain name (FQDN) to match against the URL.
- ObservePoint Production APIhttps://api.observepoint.com/v3/site-censuses/{censusId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://api.observepoint.com/v3/site-censuses/{censusId}' \
-H 'Authorization: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"id": 0,
"accountId": 0,
"name": "string",
"autoPauseAfter": 1,
"ownerId": 0,
"currentScanStartedAt": "2019-08-24T14:15:22Z",
"lastScanStoppedAt": "2019-08-24T14:15:22Z",
"notificationEmails": [
"user@example.com"
],
"startingUrls": [
"http://example.com"
],
"filterPatterns": [
{
"pathPattern": "string",
"fqdn": "string",
"type": "PRIORITY"
}
]
}'Response
application/json
{ "id": 0, "accountId": 0, "name": "string", "autoPauseAfter": 1, "ownerId": 0, "currentScanStartedAt": "2019-08-24T14:15:22Z", "lastScanStoppedAt": "2019-08-24T14:15:22Z", "notificationEmails": [ "user@example.com" ], "startingUrls": [ "http://example.com" ], "filterPatterns": [ { … } ] }