AI agent instructions
AI agent instructions
Open the Console
Try every Data API in the playground.
Get your API key
Create a key to call the API.
Quick start
The 10 Data APIs
You can list them at any time with
GET /data.
Authentication
Every request needs your API key as a bearer token:Caching
Results are cached on the server. Defaults per API:
Control it per request with these headers:
string
default:"default"
default uses the cache, refresh re-fetches and updates it, bypass skips it.integer
Maximum age of a cached result you accept, in milliseconds.
0 forces a fresh result.integer
Store the result for less time than the default.
0 means don’t store it.cache_metadata with status (hit or miss) and age_ms.
Read your current policy with GET /data/cache. Clear cached results with DELETE /data/cache.
Common parameters
Some APIs accept these optional fields. Check the table before sending them, because unsupported fields are rejected.
Products, Maps and YouTube take none of them. For Styleguide, which is a
GET, they are query parameters (timeoutOpts[milliseconds], timeoutOpts[behavior], zdr, tags). For the others they go in the JSON body.
Errors
Errors return a JSON body with anerror_code, a message and a request_id:
The OpenAPI spec also lists a
422 response with a detail array for validation errors on some endpoints. Handle both 400 and 422 as invalid input.
Include the request_id when you contact support.
Usage
GET /data/analytics returns your request counts, successes, partial results and p50/p95 latency per API. It takes optional since and until (ISO 8601) query parameters and defaults to the last 7 days. You can also see usage in the Console.
GET /data/analytics/requests and GET /data/analytics/requests/{request_id}.