Download Card Data

Downloads the report data. Choose csv, json, or xlsx depending on what you need.

If the report has no required filters, pass parameters: []. If it does, include a QueryFilterParameter entry for each required filter.

This is a POST request — filters go in the request body, not the URL.

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

Card ID from GET /api/collection/{id}/items.

enum
required

The format you want back. csvtext/csv. jsonapplication/json (flat array of row objects). xlsx → Excel spreadsheet (application/vnd.openxmlformats-officedocument.spreadsheetml.sheet).

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 from the parameters array.

401

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

403

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

404

Card not found.

500

Query failed — the Card's SQL threw a database error. This often means a required template tag parameter was not passed or was set to an invalid value. Check parameters[] on the Card and ensure all entries with required: true are included.

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