Aller au contenu
Pomelo Analytics

Current billing period usage

GET
/v1/usage/current

Requires usage:read scope. Tokens with metrics:read also have implicit access to this endpoint.

Authorizations

Section intitulée « Authorizations »

Parameters

Section intitulée « Parameters »

Header Parameters

Section intitulée « Header Parameters »
X-Request-Id
string

Optional idempotency/request correlation identifier.

Responses

Section intitulée « Responses »

200

Section intitulée « 200 »

OK

object
period
required
string
Example
2026-02
units_used
required
integer
units_included
required
integer
units_overage
required
integer
hard_cap_units
required
integer
reset_at
required
string format: date-time

Headers

Section intitulée « Headers »
X-Request-Id
string

Request identifier for troubleshooting.

401

Section intitulée « 401 »

Invalid or revoked API token.

object
error
required
object
code
required
string
Allowed values: UNAUTHORIZED FORBIDDEN INVALID_METHOD INVALID_PARAMS RETENTION_EXCEEDED RATE_LIMITED HARD_CAP_REACHED REPORT_LOCKED_BY_PROFILE REPORT_NOT_AVAILABLE_FOR_REQUESTED_PERIOD REPORT_RESPONSE_TOO_LARGE INTERNAL_ERROR NOT_FOUND
message
required
string
request_id
required
string
details
object
key
additional properties
any

Headers

Section intitulée « Headers »
X-Request-Id
string

Request identifier for troubleshooting.

403

Section intitulée « 403 »

Token scope/site/plan does not allow this request.

object
error
required
object
code
required
string
Allowed values: UNAUTHORIZED FORBIDDEN INVALID_METHOD INVALID_PARAMS RETENTION_EXCEEDED RATE_LIMITED HARD_CAP_REACHED REPORT_LOCKED_BY_PROFILE REPORT_NOT_AVAILABLE_FOR_REQUESTED_PERIOD REPORT_RESPONSE_TOO_LARGE INTERNAL_ERROR NOT_FOUND
message
required
string
request_id
required
string
details
object
key
additional properties
any

Headers

Section intitulée « Headers »
X-Request-Id
string

Request identifier for troubleshooting.

429

Section intitulée « 429 »

Request was throttled.

object
error
required
object
code
required
string
Allowed values: UNAUTHORIZED FORBIDDEN INVALID_METHOD INVALID_PARAMS RETENTION_EXCEEDED RATE_LIMITED HARD_CAP_REACHED REPORT_LOCKED_BY_PROFILE REPORT_NOT_AVAILABLE_FOR_REQUESTED_PERIOD REPORT_RESPONSE_TOO_LARGE INTERNAL_ERROR NOT_FOUND
message
required
string
request_id
required
string
details
object
key
additional properties
any

Headers

Section intitulée « Headers »
X-Request-Id
string

Request identifier for troubleshooting.

X-RateLimit-Limit
integer

Maximum requests allowed during current short window.

X-RateLimit-Remaining
integer

Remaining requests in current short window.

X-RateLimit-Reset
integer

Unix timestamp when short window resets.