- Metric Sources
- Using Instrumental
- Where to Start
API Authentication & Formatting
The Instrumental API follows a basic RESTful design. You are required to provide an authentication token with each request. All requests are returned in strict JSON format.
Supply the project or your user token in the X-Instrumental-Token header:
"curl -H 'X-Instrumental-Token:
The response format for each endpoint is detailed on that endpoint's documentation page.
Response HTTP status codes other than
204 No Content, or
304 Not Modified should be interpreted as errors.
All time values returned by the Instrumental API are expressed as a Unix timestamp (seconds since 1970).
Access-Control-Request-Method: GET, OPTIONS
HTTP Conditional Get is partially supported. Returned JSON data will include an
ETag: <content-id> header to use in an
If-Not-Modified header of future requests.
If-Modified-Since is not currently supported.
You may specify
Content-Encoding: gzip to receive GZIP compressed responses.