GET
/
chart
/
{share_string}
/
embedded
cURL
curl --request GET \
  --url https://api.chartbrew.com/chart/{share_string}/embedded \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "name": "<string>",
  "type": "<string>",
  "subType": "<string>",
  "chartData": {},
  "chartDataUpdated": "2023-11-07T05:31:56Z",
  "project_id": "<string>",
  "public": true,
  "shareable": true,
  "ChartDatasetConfigs": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "chart_id": 123,
      "dataset_id": 123,
      "formula": "<string>",
      "datasetColor": "<string>",
      "fillColor": "<string>",
      "fill": false,
      "multiFill": false,
      "legend": "<string>",
      "pointRadius": 123,
      "excludedFields": [
        "<string>"
      ],
      "sort": "<string>",
      "columnsOrder": [
        "<string>"
      ],
      "order": 0,
      "maxRecords": 123,
      "goal": 123
    }
  ]
}
This endpoint returns chart data optimized for embedding. It supports both legacy public charts and modern SharePolicy-protected charts with signed tokens.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
share_string
string
required

Share string or chart ID for the embedded chart

Query Parameters

​
token
string

Access token for SharePolicy-protected charts

​
theme
enum<string>

Theme for the embedded chart (light, dark, os)

Available options:
light,
dark,
os

Response

200
application/json

Embedded chart data

The response is of type object.