Export chart

Method for rendering a saved Exabel chart as an image.

The chart is referenced by its resource name, which can be copied from the chart's URL in the Exabel web app. The rendered image matches the chart as it appears in the app, using the chart's own saved signals, entities, transforms and appearance settings.

Provide entities to render the saved chart for a different set of entities than the ones it was saved with. This turns a chart into a reusable template: one saved chart can be rendered for any number of companies without editing it.

If the chart was saved with a relative time range, such as the last twelve months, that range is resolved when the request is made, not when the chart was saved. Two requests made on different days therefore return different windows. Provide timeRange to render a fixed, absolute window instead.

Charts that live in a dashboard rather than in the library can also be rendered, by naming the widget that holds them instead of the chart. Use the Management API's "List dashboard widgets" method to find those names.

Only time series charts are currently supported. Requests for other chart types, such as bar, column, pie, cohort and seasonality charts, are rejected with an error.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request to ExportChart.

string
required

The chart to render, represented by its resource name.

Either a saved chart, such as charts/123, whose id can be copied from the chart's URL in the Exabel web app; or a chart widget in a dashboard, such as dashboards/1234/widgets/1. A chart built inside a dashboard is stored in that dashboard and has no name of its own, so naming the widget is the only way to export it. Use the Management API to list a dashboard's widgets.

entities
array of strings
length ≤ 100

Entities to render the chart for, represented by resource names. If empty, the entities saved with the chart are used. If provided, they replace the saved entities for every signal group in the chart. At most 100 entities can be given; a chart with that many series is in any case unlikely to be legible.

entities
timeRange
object

A time range represented by two google.protobuf.Timestamps.

date-time

The version to retrieve data at. If empty, the end of time is used.

string
enum

Image format to return. Matched case-insensitively.

  • png
Allowed:
int32
100 to 4000
Defaults to 1600

Image width in pixels. Defaults to 1600, matching the image produced by the web app's own chart download.

int32
100 to 4000
Defaults to 800

Image height in pixels. Defaults to 800, matching the image produced by the web app's own chart download.

Response

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
image/png