zyte_api_usage_stats
Recorded Zyte API usage of the organization: requests made, cost, response times and status codes for a time window (default: the last 7 days), as one summary or broken down with group_by into one row per hour/day/month/year, per target domain (sorted by cost), per requested feature (browserHtml, httpResponseBody, screenshot, actions, ...) or per automatic extraction type (product, article, ...). Filter by domain, API key label, status code, feature, extraction type or request tags ('tag:value'). Costs are in the currency's main unit (e.g. USD), one entry per currency. Only recorded usage: it cannot estimate a future crawl (use zyte_api_domain_pricing for rates) and knows nothing about Scrapy Cloud jobs. Rate limit: 20 Stats API calls per minute; group_by 'feature' spends 8 of them and 'extraction_type' 11, so do not repeat those within a minute.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| tags | No | Only requests carrying all of these tags; each entry is 'tag' or 'tag:value'. | |
| domains | No | Only requests to these domains. | |
| feature | No | Only requests that used this feature. | |
| end_time | No | End of the window, UTC, same formats. A bare date is included whole. Default: now. | |
| group_by | No | 'none' for one total; 'hour'/'day'/'month'/'year' for one row per time bucket; 'domain' for one row per target domain; 'feature' or 'extraction_type' for one row per Zyte API feature or automatic extraction type used. | none |
| start_time | No | Start of the window, UTC, as an ISO 8601 date (2026-08-01) or date-time (2026-08-01T12:00:00Z). Default: 7 days ago. | |
| status_codes | No | Only requests that got these HTTP status codes. | |
| domain_health | No | Add Zyte's health status per domain (top 100 domains of the last 7 days). Implies group_by=domain. | |
| api_key_labels | No | Only requests made with API keys having these labels. | |
| organizationId | Yes | Required. The Zyte organization whose usage to report: the number in https://app.zyte.com/o/<id>, the 'organizationId' of a Scrapy Cloud project, or one of the organizations the user_info tool lists. Never guess an id; once chosen, reuse it across the session unless the user asks for another. | |
| extraction_from | No | Only extraction requests from this source. | |
| extraction_type | No | Only requests with this automatic extraction type. |