Usage
API functions for the Usage resource.
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[GetUsageResponse200]
sync(client=client) -> Optional[GetUsageResponse200]
await asyncio_detailed(client=client) -> Response[GetUsageResponse200]
await asyncio(client=client) -> Optional[GetUsageResponse200]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_ (Union[Unset, datetime.date])to (Union[Unset, datetime.date])api_key (Union[Unset, str])
Call styles
sync_detailed(client=client, from_=from_, to=to, api_key=api_key) -> Response[GetUsageByEndpointResponse200]
sync(client=client, from_=from_, to=to, api_key=api_key) -> Optional[GetUsageByEndpointResponse200]
await asyncio_detailed(client=client, from_=from_, to=to, api_key=api_key) -> Response[GetUsageByEndpointResponse200]
await asyncio(client=client, from_=from_, to=to, api_key=api_key) -> Optional[GetUsageByEndpointResponse200]Get Usage Daily
Get daily usage breakdown
Default range is last 30 days. Max range is 366 days.
Parameters
from_ (Union[Unset, datetime.date])to (Union[Unset, datetime.date])api_key (Union[Unset, str])
Call styles
sync_detailed(client=client, from_=from_, to=to, api_key=api_key) -> Response[GetUsageDailyResponse200]
sync(client=client, from_=from_, to=to, api_key=api_key) -> Optional[GetUsageDailyResponse200]
await asyncio_detailed(client=client, from_=from_, to=to, api_key=api_key) -> Response[GetUsageDailyResponse200]
await asyncio(client=client, from_=from_, to=to, api_key=api_key) -> Optional[GetUsageDailyResponse200]