Skip to content

Get current-period API usage broken down by day, endpoint, and mode

GET
/api/public/v1/usage/breakdown/
curl --request GET \
--url https://example.com/api/public/v1/usage/breakdown/ \
--header 'Authorization: Bearer <token>'

Returns the caller’s current-period token usage at the finest grain available: one record per (day, endpoint, mode) bucket, alongside the billing-period boundaries. Records are sorted by date, then endpoint, then mode.

Reach for this only when you need to attribute usage — to see which endpoints or which days are driving consumption. For just the headline numbers (tokens used vs. included, overage), get_usage is the lighter call.

Response size: this grows with activity — an active account can return hundreds of records (one per day × endpoint × mode). The full list is returned in a single response (no pagination), so reading it consumes a correspondingly large number of LLM tokens. Prefer get_usage when the totals are all you need.

Cost: free (the Land Insights token cost; the LLM-token note above is about the size of the payload you read back).

Media type application/json

Current-period usage as raw per-(day, endpoint, mode) records.

object
period_start
required

Start of the current billing period (ISO 8601).

string format: date-time
nullable
period_end
required

End of the current billing period (ISO 8601).

string format: date-time
nullable
records
required

One entry per (day, endpoint, mode) bucket, sorted by date, then endpoint, then mode. Empty when no usage has been recorded this period.

Array<object>

A single (day, endpoint, mode) bucket of token usage.

object
date
required

Calendar day (UTC) the usage was recorded, as YYYY-MM-DD.

string format: date
nullable
endpoint
required

Metering key of the endpoint that consumed the tokens (e.g. public_property_search, public_parcel_filter).

string
nullable
mode
required

How the call was made: direct (REST API key) or mcp (MCP server).

string
nullable
tokens
required

Tokens consumed in this (day, endpoint, mode) bucket.

integer
Examples
Example TwoDaysOfUsageAcrossTwoEndpoints

Two days of usage across two endpoints

{
"period_start": "2026-06-01T00:00:00Z",
"period_end": "2026-07-01T00:00:00Z",
"records": [
{
"date": "2026-06-02",
"endpoint": "public_property_search",
"mode": "direct",
"tokens": 120
},
{
"date": "2026-06-03",
"endpoint": "public_parcel_filter",
"mode": "mcp",
"tokens": 90
}
]
}

Validation error.

Media type application/json
object
error
required
object
code
required

Stable machine-readable error code. One of: unauthorized, forbidden, subscription_required, tier_upgrade_required, usage_limit_exceeded, validation_error, not_found, method_not_allowed, rate_limited, internal_error.

string
message
required

Human-readable description of the error.

string
request_id
required

Echoes the request’s X-Request-Id (or a server-issued id). Quote it in support requests.

string
details

Present on validation errors only: maps each rejected field to its list of messages.

object
key
additional properties
any
Example generated
{
"error": {
"code": "example",
"message": "example",
"request_id": "example",
"details": {}
}
}

Missing or invalid credentials.

Media type application/json
object
error
required
object
code
required

Stable machine-readable error code. One of: unauthorized, forbidden, subscription_required, tier_upgrade_required, usage_limit_exceeded, validation_error, not_found, method_not_allowed, rate_limited, internal_error.

string
message
required

Human-readable description of the error.

string
request_id
required

Echoes the request’s X-Request-Id (or a server-issued id). Quote it in support requests.

string
details

Present on validation errors only: maps each rejected field to its list of messages.

object
key
additional properties
any
Example generated
{
"error": {
"code": "example",
"message": "example",
"request_id": "example",
"details": {}
}
}

A Pro subscription or higher API tier is required.

Media type application/json
object
error
required
object
code
required

Stable machine-readable error code. One of: unauthorized, forbidden, subscription_required, tier_upgrade_required, usage_limit_exceeded, validation_error, not_found, method_not_allowed, rate_limited, internal_error.

string
message
required

Human-readable description of the error.

string
request_id
required

Echoes the request’s X-Request-Id (or a server-issued id). Quote it in support requests.

string
details

Present on validation errors only: maps each rejected field to its list of messages.

object
key
additional properties
any
Example generated
{
"error": {
"code": "example",
"message": "example",
"request_id": "example",
"details": {}
}
}

Authenticated but not permitted.

Media type application/json
object
error
required
object
code
required

Stable machine-readable error code. One of: unauthorized, forbidden, subscription_required, tier_upgrade_required, usage_limit_exceeded, validation_error, not_found, method_not_allowed, rate_limited, internal_error.

string
message
required

Human-readable description of the error.

string
request_id
required

Echoes the request’s X-Request-Id (or a server-issued id). Quote it in support requests.

string
details

Present on validation errors only: maps each rejected field to its list of messages.

object
key
additional properties
any
Example generated
{
"error": {
"code": "example",
"message": "example",
"request_id": "example",
"details": {}
}
}

Resource not found.

Media type application/json
object
error
required
object
code
required

Stable machine-readable error code. One of: unauthorized, forbidden, subscription_required, tier_upgrade_required, usage_limit_exceeded, validation_error, not_found, method_not_allowed, rate_limited, internal_error.

string
message
required

Human-readable description of the error.

string
request_id
required

Echoes the request’s X-Request-Id (or a server-issued id). Quote it in support requests.

string
details

Present on validation errors only: maps each rejected field to its list of messages.

object
key
additional properties
any
Example generated
{
"error": {
"code": "example",
"message": "example",
"request_id": "example",
"details": {}
}
}

Rate limit exceeded.

Media type application/json
object
error
required
object
code
required

Stable machine-readable error code. One of: unauthorized, forbidden, subscription_required, tier_upgrade_required, usage_limit_exceeded, validation_error, not_found, method_not_allowed, rate_limited, internal_error.

string
message
required

Human-readable description of the error.

string
request_id
required

Echoes the request’s X-Request-Id (or a server-issued id). Quote it in support requests.

string
details

Present on validation errors only: maps each rejected field to its list of messages.

object
key
additional properties
any
Example generated
{
"error": {
"code": "example",
"message": "example",
"request_id": "example",
"details": {}
}
}

Internal error.

Media type application/json
object
error
required
object
code
required

Stable machine-readable error code. One of: unauthorized, forbidden, subscription_required, tier_upgrade_required, usage_limit_exceeded, validation_error, not_found, method_not_allowed, rate_limited, internal_error.

string
message
required

Human-readable description of the error.

string
request_id
required

Echoes the request’s X-Request-Id (or a server-issued id). Quote it in support requests.

string
details

Present on validation errors only: maps each rejected field to its list of messages.

object
key
additional properties
any
Example generated
{
"error": {
"code": "example",
"message": "example",
"request_id": "example",
"details": {}
}
}