Skip to content
v3 API/
/
Get brief usage overview...

Get brief usage overview for account

Request

GET /v3/usage/overview
Security
API_Key
GET
/v3/usage/overview
curl -i -X GET \
  https://api.observepoint.com/v3/usage/overview \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Usage overview

Bodyapplication/json
auditUsageobjectrequired

usagePercentage and usageLimit can be omitted if there is no limit. overLimitPrice is only visible to account admins.

webJourneyUsageobject

usagePercentage and usageLimit can be omitted if there is no limit. overLimitPrice is only visible to account admins.

allowOveragesbooleanrequired

When TRUE, account is allowed to go over the limit and will be charged for overages. When FALSE, account will be blocked from running audits and web journeys that will go over the limit.

Response
{
  "auditUsage": {
    "usageCount": 0,
    "usageLimit": 0,
    "limitNoteType": "UNLIMITED",
    "usagePercentage": 0.1,
    "overLimitPrice": { … },
    "currentContractTerm": { … }
  },
  "webJourneyUsage": {
    "usageCount": 0,
    "usageLimit": 0,
    "limitNoteType": "UNLIMITED",
    "usagePercentage": 0.1,
    "overLimitPrice": { … },
    "currentContractTerm": { … }
  },
  "allowOverages": true
}