Skip to main content
Exports give you every record matching a search, written to a file you download. Use an export — rather than paging cursors — when you need exhaustive, durable output.

​
Steps

1

Create the export

Send a search request with an export format. The response returns an export_id and a status; the export runs asynchronously.
curl https://api.withsplendor.com/v1/export \
  -H "Authorization: Bearer $SPLENDOR_TOKEN" \
  -H "X-Splendor-Tenant-Id: $SPLENDOR_TENANT_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "text": "timeout",
    "datasets": ["app-logs"],
    "format": "ndjson",
    "max_rows": 1000000
  }'
2

Poll for completion

Check the export until its status is complete. The response then includes a download location.
curl https://api.withsplendor.com/v1/export/exp_... \
  -H "Authorization: Bearer $SPLENDOR_TOKEN" \
  -H "X-Splendor-Tenant-Id: $SPLENDOR_TENANT_ID"
3

Download the file

Fetch the download_url from the completed export. Exports support ndjson and csv.
Delete exports you no longer need with DELETE /v1/export/{export_id}; this removes the stored artifact.

​
Export vs. cursor vs. view

  • Export — exhaustive, downloadable output of a large result set.
  • Cursor — inspect a little deeper, interactively.
  • View — a reusable, named result set you can re-read or run SQL against.