Skip to main content
GET
/
chart
/
share
/
{share_string}
cURL
curl --request GET \
  --url https://api.chartbrew.com/chart/share/{share_string} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "name": "<string>",
  "type": "line",
  "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,
      "xAxis": "<string>",
      "xAxisOperation": "<string>",
      "yAxis": "<string>",
      "yAxisOperation": "<string>",
      "dateField": "<string>",
      "dateFormat": "<string>",
      "conditions": [
        {
          "id": "<string>",
          "field": "<string>",
          "operator": "is",
          "value": "<string>",
          "displayValues": true
        }
      ],
      "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,
      "configuration": {
        "variables": [
          {
            "name": "<string>",
            "value": "<string>"
          }
        ]
      }
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.chartbrew.com/llms.txt

Use this file to discover all available pages before exploring further.

This endpoint returns chart data optimized for sharing.

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 policy's share_string

Query Parameters

token
string

Access token generated from the SharePolicy

theme
enum<string>

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

Available options:
light,
dark,
os

Response

Chart data

id
string
name
string
type
enum<string>
Available options:
line,
bar,
pie,
doughnut,
radar,
polar,
table,
kpi,
avg,
gauge,
matrix,
markdown
subType
string
chartData
object
chartDataUpdated
string<date-time>
project_id
string
public
boolean
shareable
boolean
ChartDatasetConfigs
object[]