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//
- Delete a site census by ID
Get all censuses for an account
Create a new site census
Get a site census by ID
Update an existing site census
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
Delete a site census by I...
V3 API
Download OpenAPI description
Overview
Languages
Servers
ObservePoint Production API
https://api.observepoint.com/
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": [ { … } ] }
- 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 DELETE \
'https://api.observepoint.com/v3/site-censuses/{censusId}' \
-H 'Authorization: YOUR_API_KEY_HERE'- ObservePoint Production APIhttps://api.observepoint.com/v3/site-censuses/{censusId}/current-results
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://api.observepoint.com/v3/site-censuses/{censusId}/current-results?page=0&pageSize=100&sortBy=TOTAL_URLS&sortDesc=false&searchPattern=string&returnExternalOnly=true' \
-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 fully qualified domain name (FQDN) of the URL pattern.
The rendered path of the URL pattern with the dynamic segment character. Not meant for display.
The list of URL path segments. Construct a full path pattern by appending the segment in order of array index separated by forward slashes.
The type of segment in the path. A static segment is a string in the path that does not represent a variable. A dynamic segment is one that represents a variable in the URL. For example, a dynamic segment could be a user ID.
Enum"STATIC""DYNAMIC"
present when segment type is static. A static segment is a string in the path that does not represent a variable.
The total number of URLs within this pattern.
The number of URLs in this pattern that can still be visited.
The number of URLs in this pattern that have been visited.
The number of URLs in this pattern that have been visited, but returned with 4xx or 5xx status codes.
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.
Response
application/json
{ "metadata": { "pagination": { … } }, "paginatedUrlPatternResults": [ { … } ], "resultsSummary": { "uniqueUrls": 0, "visitedUrls": 0, "urlsToVisit": 0, "externalLinks": 0, "brokenUrls": 0, "isRunning": true } }