API Reference

Stream a full export of an explorer widget

POST /api/dashboards/{id}/widgets/{widgetId}/export

Streams every row matching the explorer widget's merged query (author base_query + viewer filters/sort/columns) as a CSV/JSON/NDJSON file download — no pagination and no server-side buffering. Fails for non-explorer widgets and widgets whose features list omits export. Cancel by aborting the request.

Operation IDexportDashboardWidget

Authentication

BearerAuth·http bearer·API key token (envoy_<hex>). Create keys from Settings → API Keys — see Using the API.

Path parameters

idintegerrequired

Resource ID

widgetIdstringrequired

Request body

Content typeapplication/json

requestobject

3 properties

explorer_paramsobject

Viewer-supplied refinements for an explorer widget. Merged into the author's base_query — base filter keys always win, and when the widget declares columns they act as an allowlist for filters/sort/columns.

6 properties

filtersarray<object>

Array items

itemobject

3 properties

fieldstringrequired

operatorstringrequired

Allowed values: eq, neq, gt, gte, lt, lte, in, nin, contains, exists

valueunknown

sortarray<object>

Array items

itemobject

2 properties

columnstring

directionstring

Allowed values: asc, desc

pageinteger

limitinteger

columnsarray<string>

Array items

itemstring

cursorstring

formatstring

Default: csv
Allowed values: csv, ndjson

filenamestring

Success response body

200Streamed file download. Gzip when Accept-Encoding includes gzip.

Streamed file download. Gzip when Accept-Encoding includes gzip.

Content typetext/csv

No schema is documented.

Content typeapplication/x-ndjson

No schema is documented.

Error responses

400Validation error

Validation error

Content typeapplication/json

responseobject

2 properties

errorstring

Example: NOT_FOUND

messagestring

Example: Resource not found

Example response

{
  "error": "VALIDATION_ERROR",
  "message": "Invalid input"
}

404Resource not found

Resource not found

Content typeapplication/json

responseobject

2 properties

errorstring

Example: NOT_FOUND

messagestring

Example: Resource not found

Example response

{
  "error": "NOT_FOUND",
  "message": "Resource not found"
}

Code examples

curl --request POST \
  --url 'https://your-envoy.example.com/api/dashboards/YOUR_ID/widgets/YOUR_WIDGET_ID/export' \
  --header 'Authorization: Bearer $API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "explorer_params": {
    "filters": [
      {
        "field": "string",
        "operator": "eq"
      }
    ],
    "sort": [
      {
        "column": "string",
        "direction": "asc"
      }
    ],
    "page": 0,
    "limit": 0,
    "columns": [
      "string"
    ]
  },
  "format": "csv",
  "filename": "string"
}'

const response = await fetch("https://your-envoy.example.com/api/dashboards/YOUR_ID/widgets/YOUR_WIDGET_ID/export", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "explorer_params": {
      "filters": [
        {
          "field": "string",
          "operator": "eq"
        }
      ],
      "sort": [
        {
          "column": "string",
          "direction": "asc"
        }
      ],
      "page": 0,
      "limit": 0,
      "columns": [
        "string"
      ]
    },
    "format": "csv",
    "filename": "string"
  }),
});

if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = response.status === 204 ? null : await response.json();
console.log(data);