Skip to main content
GET
Download file

Fetch one chart’s capture

Some jobs also render a PNG of each chart individually, named by the chart’s queryIdentifierMapKey. Pass that key as element to get the chart’s own PNG instead of the full download file. A job started directly through the Initiate dashboard download endpoint doesn’t render individual charts, so it has nothing to return for element.
If the job doesn’t have a capture under that name, the response is a 404 with code: "ELEMENT_NOT_CAPTURED". captured_elements lists the keys the job does have:

Authorizations

Authorization
string
header
required

Can be either an Organization API Key or Personal Access Token (PAT).

Include in the Authorization header as: Bearer YOUR_TOKEN

Path Parameters

dashboardId
string
required

The dashboard identifier. This must match the ID of the original download request.

jobId
string<uuid>
required

The job ID returned from the Initiate dashboard download endpoint

Query Parameters

element
string

The queryIdentifierMapKey of one chart on the dashboard. Returns that chart's own PNG capture instead of the full download file.

Only a job whose render captured individual chart images has these.

Minimum string length: 1

Response

File download successful

The response is of type file.