Manage charts
List, get, change and delete the charts of your organization. All free.
Charts made with any key of your organization, from POST /v1/charts. None of
these requests is billed. Stored charts expire after 90 days on pay as you go and never on the monthly credit
plan (expires_at); an expired or deleted chart answers 404 chart_not_found.
List charts
Your charts, newest first, a page at a time.
Query
| Parameter | Type | |
|---|---|---|
limit | integer | How many, 1 to 100. Default: 20. |
before | string | The next_before of the previous page. |
Response
object"list"Always
list.dataobject[]Your organization’s charts, newest first.
Show child attributes
idstringThe chart id.
typestringThe chart type.
titlestringIts title.
themestringIts theme.
localestringIts language.
created_atstringWhen it was created.
expires_atstring | nullWhen it expires, or
nullif it never does.embed_urlstringThe page for an iframe.
image_urlstringThe PNG.
svg_urlstringThe SVG.
has_morebooleanWhether there are older charts.
next_beforestring | nullPass it as
beforefor the next page.nullon the last one.
Get a chart
One chart, with what is drawn, its plan and its sources: the same fields as the
POST /v1/charts response, with usage.cost_usd at 0.
Path
| Parameter | Type | |
|---|---|---|
id | string | The chart id, chart_…. |
Change a chart
Switches the type, the theme, the title, the subtitle or the language, and redraws from the same data: no new
search, free. Send at least one field. type should be one of the chart's compatible_types; if the data
doesn't fit it, the chart is drawn with the closest type that does and warnings says so
(chart_type_adjusted). Without a title of your own, the title is rewritten for the new type and language.
The embed_url, image_url and svg_url stay the same. Embeds and images are cached for 5 minutes, so the
change shows there within that time.
Body
typeenum<string>The new chart type: one of the chart’s
compatible_types. If the data doesn’t fit it, the closest type is drawn, with achart_type_adjustedwarning.themeenum<string>light,dark,editorialorelectric.titlestringA new title. Without a title of your own, the title is rewritten for the new type and language.
subtitlestringA new subtitle.
localeenum<string>Redraw it in another language:
enores.
Response
The updated chart, with the same fields as the POST /v1/charts response.
Delete a chart
Deletes the chart. Its embed, image and SVG stop working; copies already cached can take a few minutes to go.
Path
| Parameter | Type | |
|---|---|---|
id | string | The chart id, chart_…. |