Skip to main content

Create a chart

Charts can be created by posting a JSON object that represents the chart to /charts. This request body is optional: an empty untitled chart is created when an empty request body is sent.

POST https://api-{region}
"name": "my chart",
"venueType": "TABLES",
"categories": [
{ "key": 1, "label": "Category 1", "color": "#aaaaaa"},
{ "key": 2, "label": "Category 2", "color": "#bbbbbb", "accessible": true}
  • name: the name of the chart. Optional. Defaults to 'Untitled chart'.
  • venueType: the kind of venue you're creating. Depending on the venue type you choose, drawing sections will or will not be possible in the designer. Valid venue types are "MIXED" (chart without sections) and "ROWS_WITH_SECTIONS" (chart with sections). If you don't pass in a venue type, "MIXED" is used.
  • categories: optional array of categories. Each category contains a key (required), label (required) and color (optional). The key needs to be a number or a string. If it's a number, it cannot exceed Number.MAX_SAFE_INTEGER (i.e. 9007199254740991). A default color is assigned if you don't specify one.
curl https://api-{region} \
-u aSecretKey: -X POST -H 'Content-Type: application/json' -d '{"name": "my chart"}'
"tags": [],
"archived": false,
"publishedVersionThumbnailUrl": ""