Docs
Open Revolution St
Guide

Data export

Download any dataset as JSON, NDJSON, CSV or XLSX, with filters.

Requests

GET or POST /api/v3/export/{dataset} returns a page of rows. GET /api/v3/export/datasets lists the datasets your credential can read, and /export/datasets/{dataset} describes one.

Parameters (query string for GET, JSON body for POST):

  • where: a Drizzle-style filter, such as {"status":"shipped"} or {"priority":{"gte":2}}. Operators are eq ne gt gte lt lte inArray notInArray like ilike isNull isNotNull between, combined with and, or and not.
  • columns, orderBy (-createdAt,orderNumber), since and until, limit (up to 10000) and offset.
  • groupBy with aggregate (count sum avg min max) and aggregateField for grouped results.
  • format: json (rows and pagination), ndjson, csv or xlsx. For the file formats, pagination is in the X-Total-Count, X-Next-Offset and X-Has-More headers.
curl "https://v3.revolutionstreetwxs.io/api/v3/export/orders?where=%7B%22status%22%3A%22shipped%22%7D&orderBy=-createdAt&limit=100&format=csv" \
  -H "Authorization: Bearer wxs_pk_YOUR_API_KEY" -o orders.csv

The Monitoring → Export page in Revolution St builds these URLs for you and can create an API key limited to one dataset.

esc