Sign in

v1

latestOpenAPI 3.1.02026-07-24318141.2 MB
Dashboards

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.

post/api/dashboard/{dashboard_id}/dashcard/{dashcard_id}/card/{card_id}/query/{export_format}

Path parameters

{"stackTrail":"paths:/api/dashboard/{dashboard_id}/dashcard/{dashcard_id}/card/{card_id}/query/{export_format}:post:parameters:0:schema","oasType":"schema","type":"unknown"}

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

{"stackTrail":"paths:/api/dashboard/{dashboard_id}/dashcard/{dashcard_id}/card/{card_id}/query/{export_format}:post:parameters:1:schema","oasType":"schema","type":"unknown"}

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

{"stackTrail":"paths:/api/dashboard/{dashboard_id}/dashcard/{dashcard_id}/card/{card_id}/query/{export_format}:post:parameters:2:schema","oasType":"schema","type":"unknown"}

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

export_format'csv' | 'json' | 'xlsx' required

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

Request body

Example request

{
  "parameters": [
    {
      "type": "category",
      "target": [
        "variable",
        [
          "template-tag",
          "client_id"
        ]
      ],
      "value": "YOUR_CLIENT_ID"
    }
  ]
}

Response

Query results in the format you requested.

ExportJsonRow[] required

Example response

[
  {
    "Total Programs": 42,
    "Application ID": "abc123",
    "Created At": "2025-03-15T10:00:00Z"
  }
]