SDK ReferencePython SDK

Usage

API functions for the Usage resource.

For AI agents: https://bytekit.com/llms.txt — every docs page is available as markdown by appending .md

Usage

Functions for interacting with the usage API resource. Each operation ships in four forms — sync / sync_detailed and their async counterparts.

Get Usage

Get current billing period usage

Call styles

sync_detailed(client=client) -> Response[Error | GetUsageResponse200]
sync(client=client) -> Error | GetUsageResponse200 | None
await asyncio_detailed(client=client) -> Response[Error | GetUsageResponse200]
await asyncio(client=client) -> Error | GetUsageResponse200 | None

Get Usage By Endpoint

Get per-endpoint bandwidth breakdown

Returns bandwidth usage broken down by endpoint (screenshots, recordings, scrape, scrape_md, fetch, fetch_md, crawl, crawl_links, sitemap, monitors) for a date range. Each row carries raw bytes, the billing multiplier, and billable bytes. Endpoints with zero raw bytes for the range are omitted from rows; totals is always present. Default range is the last 30 days; max 366 days.

Parameters

  • from_ (datetime.date | Unset)
  • to (datetime.date | Unset)
  • api_key (str | Unset)

Call styles

sync_detailed(client=client, from_=from_, to=to, api_key=api_key) -> Response[Error | GetUsageByEndpointResponse200]
sync(client=client, from_=from_, to=to, api_key=api_key) -> Error | GetUsageByEndpointResponse200 | None
await asyncio_detailed(client=client, from_=from_, to=to, api_key=api_key) -> Response[Error | GetUsageByEndpointResponse200]
await asyncio(client=client, from_=from_, to=to, api_key=api_key) -> Error | GetUsageByEndpointResponse200 | None

Get Usage Daily

Get daily usage breakdown

Default range is last 30 days. Max range is 366 days.

Parameters

  • from_ (datetime.date | Unset)
  • to (datetime.date | Unset)
  • api_key (str | Unset)

Call styles

sync_detailed(client=client, from_=from_, to=to, api_key=api_key) -> Response[Error | GetUsageDailyResponse200]
sync(client=client, from_=from_, to=to, api_key=api_key) -> Error | GetUsageDailyResponse200 | None
await asyncio_detailed(client=client, from_=from_, to=to, api_key=api_key) -> Response[Error | GetUsageDailyResponse200]
await asyncio(client=client, from_=from_, to=to, api_key=api_key) -> Error | GetUsageDailyResponse200 | None