How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

ObservePoint Account Usage V2 API

Account usage data

ObservePoint Account Usage V2 API is one of 65 APIs that ObservePoint publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include account-usage-v2. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 5 operations across 5 paths, and defines 44 schemas. It is described by OpenAPI 3.2.0.

Requests are made against a single base URL, https://api.observepoint.com.

5 operations 5 paths 44 schemas 3 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
Base URL
https://api.observepoint.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

ObservePoint Account Usage V2 API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (API_Key).

  • API_Key — Use the Authorization header in your requests with ObservePoint API key as header value. Example: Authorization: abc123...def456

Paths & Operations 5

Across 5 paths, the API surfaces 5 operations — 3 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

account-usage-v2 5

Account usage data

GET
/v3/usage/overview
Get brief usage overview for account
getAccountUsageV2Overview → 200401403
GET
/v3/usage/summary
Get not filterable usage summary for account
getAccountUsageV2NotFilterableSummary → 200401403
POST
/v3/usage/{itemType}/summary
Get filterable specific item type usage summary for account. If web journeys are not included in contract, 404 status code will be returned
getAccountUsageV2SpecificItemTypeSummary 1 param body → 200400401403404
POST
/v3/usage/{itemType}/trends
Get usage trends for specified item type
getAccountUsageV2Trends 1 param body → 200400401403
GET
/v3/usage/{itemType}/daily-trends
Get usage trends for rolling week, for specified item type
getAccountUsageV2DailyTrends 1 param → 200401403

Schemas 44

The contract defines 44 schemas that model the data the API accepts and returns. The most detailed are AccountUsageV2_DailyTrends_Usage (7 properties), AccountUsageV2_SpecificItemTypeSummary_BaseUsage (6 properties), AccountUsageV2_Trends_ResponseDTO (6 properties), AccountUsageV2_Overview_SpecificItemTypeUsage (6 properties). Each schema is shown below with its type and property counts.

AccountUsageV2_AllowOveragesFlag
boolean
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 t…
AccountUsageV2_FilterableInteger
object
filtered property can be omitted if filters were not applied
2 properties 1 required
AccountUsageV2_ContractTermFilter
object
Select specific contract term. Current term will be shown if omitted
2 properties 2 required
AccountUsageV2_ItemTypeEnum
string
AccountUsageV2_Summary_UsersUsage
object
2 properties 2 required
AccountUsageV2_RequestDTO
object
Filters for usage report
6 properties
AccountUsageV2_ContractTerm
object
Contract start and end dates
2 properties 2 required
FoldersFilter
array
non-empty array of folders with domains (subfolders), items from which will be included in response
AccountUsageV2_Trends_CurrentPeriod
periodTotal and cumulativeTotal calculated for completed runs in current period, periodProjectedTotal and cumulativeProjectedTotal estimated for future runs
FolderId
integer
ID of a folder
AccountUsageV2_CumulativePacing
integer
Shows how many pages should be scanned to date to hit the limit by the end of the contract term
AccountUsageV2_Trends_BasePeriodTrait
object
startDateInclusive and endDateExclusive define period of time for which usage is shown
2 properties 2 required
AccountUsageV2_SpecificItemTypeSummary_BaseUsage
object
Subtypes: - AccountUsageV2SpecificItemTypeSummaryAuditUsage - AccountUsageV2SpecificItemTypeSummaryWebJourneyUsage cumulativeTotal - number of pages scanned (f…
6 properties 2 required
AccountUsageV2_SpecificItemTypeSummary_ResponseDTO
object
3 properties 3 required
AccountUsageV2_OverLimitPrice
Price of a page scan (for audits) or a run (for web journeys) over the limit
AccountUsageV2_DailyTrends_ItemInfoWithRunDetails
LabelId
integer
Label identifier
AccountUsageV2_DailyTrends_ItemInfo
object
4 properties 3 required
AccountUsageV2_Overview_ResponseDTO
object
webJourneyUsage can be absent if web journeys are not included in contract.
3 properties 2 required
FoldersFilterItem
object
2 properties 1 required
AccountUsageV2_DailyTrends_ResponseDTO
object
1 property 1 required
AccountUsageV2_Trends_ResponseDTO
object
termLimit, monthlyPacing - can be omitted if there is no limit
6 properties 2 required
RunId
integer
DateUtc
string
Date in ISO 8601 format, in UTC timezone
AccountUsageV2_Overview_SpecificItemTypeUsage
object
usagePercentage and usageLimit can be omitted if there is no limit. overLimitPrice is only visible to account admins.
6 properties 2 required
AccountUsageV2_TermLimit
integer
Limit of pages scanned (for audits) or runs completed (for web journeys) for the contract term
AccountUsageV2_DailyTrends_Usage
object
Scheduled items are shown only for today and dates in the future
7 properties 1 required
AccountUsageV2_DailyTrends_ScheduledItemInfoWithRunDetails
AccountUsageV2_Summary_SupportContactType
string
AE - Account Executive CSM - Customer Success Manager
AccountUsageV2_Trends_FuturePeriod
ErrorModel
object
4 properties
AccountUsageV2_Trends_PastPeriod
UserId
integer
ID of a user
AccountUsageV2_Summary_SupportContact
object
3 properties 3 required
AccountUsageV2_FilterableProjectedUsage
object
Duplicates AccountUsageV2ProjectedUsage, but includes total and filtered values for each estimate
2 properties 2 required
AccountUsageV2_MonthlyPacing
integer
Shows how many pages should be scanned per month to hit the limit by the end of the contract term
AccountUsageV2_RunFrequency
string
combination of journey and audit frequency
DomainId
integer
ID of a domain
AccountUsageV2_Summary_ResponseDTO
object
3 properties 3 required
DateAndTime
string
Date-time in [RFC3339 profile ISO 8601 format](https://www.ietf.org/rfc/rfc3339.txt) with the following additional restrictions: 1. An uppercase T must separat…
MonetaryAmount
object
A monetary amount
2 properties 2 required
CurrencyCode
string
A currency represented by its ISO 4217 alpha code
ItemId
integer
ID of a data collector, see ItemType
AccountUsageV2_LimitNoteTypeEnum
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

observepoint-account-usage-v2-api-openapi.yml Raw ↑

Other APIs ObservePoint publishes across the network.

ObservePoint Account API
ObservePoint Account Triggered Alerts API
ObservePoint Account Usage Alerts API
ObservePoint Account Usage Export API
ObservePoint Action Set Action Rules API
ObservePoint Action Set Actions API
ObservePoint Action Sets API
ObservePoint Alert Export API
ObservePoint Alert Summary Report API
ObservePoint Alerts API
ObservePoint Audit Actions API
ObservePoint Audit Blocking Config API
Where this information came from

This is an independent, third-party profile of ObservePoint Account Usage V2 API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.