Export a page of a dataset

Returns one page of a dataset in the requested format. Filter with where (JSON), pick columns, sort with orderBy (-createdAt,orderNumber), bound by since/until, or aggregate with groupBy. Timestamp columns are rendered in the site timezone (ISO 8601 with offset) unless timezone=utc. Requires the dataset's own read permission.

Parameters

datasetpathrequiredstring

wherequeryDrizzle-style filter. {"status":"shipped"} for equality; {"priority":{"gte":2},"carrier":{"ilike":"%ups%"}} with operators eq, ne, gt, gte, lt, lte, inArray, notInArray, like, notLike, ilike, notIlike, isNull, isNotNull, between, notBetween; {"or":[...]}, {"and":[...]}, {"not":{...}} to combine. Column names come from GET /export/datasets/{dataset}.

columnsqueryComma-separated column names; all when omitted

orderByqueryComma-separated columns; prefix with - for descending

sincequeryInclusive lower bound on the time column (ISO 8601)

untilquerystring

limitqueryinteger

offsetquery

formatquerystring

groupByqueryGroup by this column and return {group, value} rows instead of records

aggregatequerystring

aggregateFieldqueryNumeric column for sum/avg/min/max

timezonequeryHow timestamp columns are rendered: site (default) = the configured site timezone in the site's technical timestamp standard (ISO 8601 with offset unless changed under Configuration → General, e.g. 2026-09-06T10:08:55-04:00); utc = raw UTC instants (2026-09-06T14:08:55.000Z)

filenamequerystring

Responses

200A page of rows in the requested format. For ndjson/csv/xlsx the pagination is returned in the X-Total-Count / X-Next-Offset / X-Has-More headers.

dataobject[]required

paginationobjectrequired

datasetstringrequired

limitnumberrequired

offsetnumberrequired

returnednumberrequired

totalnumberrequired

hasMorebooleanrequired

nextOffsetnumberrequired

400Bad filter, column, or format

403Insufficient permissions

404Unknown dataset

Sending requests from a browser

Open https://v3.revolutionstreetwxs.io/api/v3/docs to send requests to this endpoint with your API key.

Request

curl -X GET 'https://v3.revolutionstreetwxs.io/api/v3/export/orders' \
  -H "Authorization: Bearer wxs_pk_YOUR_API_KEY"

const response = await fetch("https://v3.revolutionstreetwxs.io/api/v3/export/orders", {
  method: "GET",
  headers: {
    Authorization: "Bearer wxs_pk_YOUR_API_KEY",
  },
});
const data = await response.json();

import requests

response = requests.get(
    "https://v3.revolutionstreetwxs.io/api/v3/export/orders",
    headers={"Authorization": "Bearer wxs_pk_YOUR_API_KEY"},
)
data = response.json()

Response 200

{
  "data": [
    {}
  ],
  "pagination": {
    "dataset": "dataset",
    "limit": 1.5,
    "offset": 1.5,
    "returned": 1.5,
    "total": 1.5,
    "hasMore": true,
    "nextOffset": 1.5
  }
}