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//
- Create a new site census
Get all censuses for an account
Get a site census by ID
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
Create a new site census
V3 API
Download OpenAPI description
Overview
Languages
Servers
ObservePoint Production API
https://api.observepoint.com/
- ObservePoint Production APIhttps://api.observepoint.com/v3/site-censuses
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://api.observepoint.com/v3/site-censuses?page=0&pageSize=10&sortBy=NAME&sortDesc=false&filterByName=string' \
-H 'Authorization: YOUR_API_KEY_HERE'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 number of unique included URLs found. Included is defined as URLs that share the same main-domain as any starting URL.
The number of included URLs visited. Included is defined as URLs that share the same main-domain as any starting URL.
The number of included URLs to visit. Included is defined as URLs that share the same main-domain as any starting URL.
The number of external links found on included pages. Included is defined as URLs that share the same main-domain as any starting URL.
The number of included URLs that are broken. Broken is defined as URLs that return a non-2xx,3xx status code. Included is defined as URLs that share the same main-domain as any starting URL.
The account ID associated with the Site Census.
The max time the scan will run, in minutes.
The userId of the user who created the Site Census.
The date and time when the current scan session started.
The date and time when the last scan session stopped.
Target email addresses for notification when this census auto-pauses or runs out of URLs.
The list of starting URLs for the Site Census.
The GLOB pattern to match the path of the URL.
The fully qualified domain name (FQDN) to match against the URL.
Response
application/json
{ "metadata": { "pagination": { … } }, "censuses": [ { … } ] }
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": [ { … } ] }