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 filterable specific item type usage summary for account. If web journeys are not included in contract, 404 status code will be returned
Get brief usage overview for account
Get not filterable usage summary for account
Get usage trends for specified item type
Get usage trends for rolling week, for specified item type
Get filterable specific i...
V3 API
Download OpenAPI description
Overview
Languages
Servers
ObservePoint Production API
https://api.observepoint.com/
- ObservePoint Production APIhttps://api.observepoint.com/v3/usage/summary
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://api.observepoint.com/v3/usage/summary \
-H 'Authorization: YOUR_API_KEY_HERE'Response
application/json
{ "usersUsage": { "totalUsers": 0, "usersLoggedInLast30Days": [ … ] }, "contacts": [ { … } ], "allowOverages": true }
Bodyapplication/json
Non-empty array of data sources. Usage for selected data sources only will be shown
Example: [107239]
Non-empty array of user IDs. Matches data sources that have been created by any of the specified users
Example: [123]
non-empty array of folders with domains (subfolders), items from which will be included in response
Non-empty array of labels present on an item. Matches data sources that have all specified labels
Example: [223]
Non-empty array of frequency names. Matches data sources that have any of the specified frequencies
Items Enum"paused""once""15 minutes""1 hour""6 hours""12 hours""daily""weekly""biweekly""monthly"
- ObservePoint Production APIhttps://api.observepoint.com/v3/usage/{itemType}/summary
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://api.observepoint.com/v3/usage/{itemType}/summary' \
-H 'Authorization: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"dataSources": [
107239
],
"dataSourceCreators": [
123
],
"dataSourceFolders": [
{
"folderId": 123,
"domains": [
123
]
}
],
"dataSourceLabels": [
223
],
"runFrequencies": [
"paused"
],
"contractTerm": {
"startDateInclusive": "2019-08-24",
"endDateInclusive": "2019-08-24"
}
}'Specific item type usage summary
Contract start and end dates
Dates of contracts
Subtypes:
- AccountUsageV2_SpecificItemTypeSummary_AuditUsage
- AccountUsageV2_SpecificItemTypeSummary_WebJourneyUsage
cumulativeTotal - number of pages scanned (for audits) or runs completed (for web journeys) to date. termLimit, cumulativePacing - can be omitted if there is no limit. overLimitPrice is only visible to account admins.
filtered property can be omitted if filters were not applied
Limit of pages scanned (for audits) or runs completed (for web journeys) for the contract term
Shows how many pages should be scanned to date to hit the limit by the end of the contract term
Response
application/json
{ "currentContractTerm": { "startDateInclusive": "2019-08-24", "endDateInclusive": "2019-08-24" }, "contractTerms": [ { … } ], "usage": { "itemType": "AUDIT", "cumulativeTotal": { … }, "termLimit": 0, "limitNoteType": "UNLIMITED", "cumulativePacing": 0, "overLimitPrice": { … } } }
Bodyapplication/json
Non-empty array of data sources. Usage for selected data sources only will be shown
Example: [107239]
Non-empty array of user IDs. Matches data sources that have been created by any of the specified users
Example: [123]
non-empty array of folders with domains (subfolders), items from which will be included in response
Non-empty array of labels present on an item. Matches data sources that have all specified labels
Example: [223]
Non-empty array of frequency names. Matches data sources that have any of the specified frequencies
Items Enum"paused""once""15 minutes""1 hour""6 hours""12 hours""daily""weekly""biweekly""monthly"
- ObservePoint Production APIhttps://api.observepoint.com/v3/usage/{itemType}/trends
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://api.observepoint.com/v3/usage/{itemType}/trends' \
-H 'Authorization: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"dataSources": [
107239
],
"dataSourceCreators": [
123
],
"dataSourceFolders": [
{
"folderId": 123,
"domains": [
123
]
}
],
"dataSourceLabels": [
223
],
"runFrequencies": [
"paused"
],
"contractTerm": {
"startDateInclusive": "2019-08-24",
"endDateInclusive": "2019-08-24"
}
}'Usage trends
Represents all past months
filtered property can be omitted if filters were not applied
Represents future months, with projected values
Duplicates AccountUsageV2_ProjectedUsage, but includes total and filtered values for each estimate
filtered property can be omitted if filters were not applied
filtered property can be omitted if filters were not applied
Duplicates AccountUsageV2_ProjectedUsage, but includes total and filtered values for each estimate
filtered property can be omitted if filters were not applied
filtered property can be omitted if filters were not applied
Limit of pages scanned (for audits) or runs completed (for web journeys) for the contract term
Response
application/json
{ "pastPeriods": [ { … } ], "currentPeriod": { "startDateInclusive": "2019-08-24", "endDateExclusive": "2019-08-24", "periodTotal": { … }, "cumulativeTotal": { … }, "periodProjectedTotal": { … }, "cumulativeProjectedTotal": { … } }, "futurePeriods": [ { … } ], "termLimit": 0, "limitNoteType": "UNLIMITED", "monthlyPacing": 0 }