v1

latestOpenAPI 3.1.02026-07-24318141.2 MB

Cards

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.

post/api/card/{card_id}/query/{export_format}

Path parameters

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

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

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 (application/vnd.openxmlformats-officedocument.spreadsheetml.sheet).

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"
  }
]