Download Dashboard Card Data

Downloads data for a specific report inside a dashboard. Use GET /api/dashboard/{id} first to get the dashcard_id and card_id values you need.

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

Dashboard ID from GET /api/collection/{id}/items — look for items where model is "dashboard".

string
required

Dashcard ID from GET /api/dashboard/{id}dashcards[].id. This is the placement ID — not the same as card_id.

string
required

Card ID from GET /api/dashboard/{id}dashcards[].card_id. This is the underlying question ID.

enum
required

The format you want back. csvtext/csv. jsonapplication/json (flat array of row objects). xlsx → Excel spreadsheet.

Allowed:
Body Params

The request body for download endpoints.

parameters
array of objects
required

Filters to apply. Pass [] if the report has no required filters.

parameters*
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

400

Bad Request — the JSON body is malformed or a required filter parameter is missing.

401

Unauthorized — x-api-key header is missing or invalid.

403

Forbidden — your API key doesn't have access to this Dashboard or Card.

404

Dashboard, Dashcard, or Card not found. Double-check all three IDs from GET /api/dashboard/{id}.

500

Query failed — the underlying SQL threw a database error. Make sure all required template tag parameters are present and set to valid values.

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