Skip to main content
The Data API returns reusable JSON data. Dataset routes return joined and transformed source data. Chart routes return the rows and field metadata prepared for the chart, without renderer settings.

Create a key

A team owner or team admin can create a key in Team settings → API keys.
  1. Enter a name.
  2. Select all projects in the team or specific projects.
  3. Keep Read chart and dataset data selected.
  4. Select Refresh data from sources if the client sends variables, date filters, or refreshes.
Copy the key when Chartbrew shows it. The key is not shown again. The key is bound to the team where you create it. It cannot read a project from another team.

Read default data

For a dataset, use /api/v1/teams/{team_id}/datasets/{dataset_id}/data.

Send runtime values

Use POST when you need variables, filters, or a source refresh.
Dataset requests can also set an IANA timezone, such as "Asia/Bangkok". Chart requests always use the dashboard timezone.

Cache default reads

Save the ETag from a successful GET, then send it with the next request.
An unchanged result returns 304 with no body. X-Chartbrew-Data-Stale: true means Chartbrew returned the last known chart data while it refreshes the source.

Use chart rows

Each chart result has fields, series, and rows. Field keys describe the row properties. The same response can drive any chart library.

Handle errors

All errors include error.code, a safe message, and error.requestId. Do not retry 401, 403, or 404 until the key or request changes.