Export a page of a dataset (JSON body)

The same export as GET, with the request in a JSON body — easier for nested filters. Every field is optional.

Parameters

datasetpathrequiredstring

Request body (optional)

whereobject

columnsstring[]

orderByobject[]

columnstringrequired

directionenum

ascdesc

sincestring (date-time)

untilstring (date-time)

limitinteger

offsetinteger

formatenum

jsonndjsoncsvxlsx

groupBystring

aggregateenum

countsumavgminmax

aggregateFieldstring

timezoneenum

siteutc

filenamestring

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 POST 'https://v3.revolutionstreetwxs.io/api/v3/export/orders' \
  -H "Authorization: Bearer wxs_pk_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "where": {
    "status": "shipped",
    "lineCount": 1
  },
  "columns": [
    "orderNumber",
    "status",
    "carrier",
    "createdAt"
  ],
  "orderBy": [
    {
      "column": "createdAt",
      "direction": "desc"
    }
  ],
  "since": "2026-09-01T00:00:00Z",
  "limit": 1000,
  "format": "csv"
}'

const response = await fetch("https://v3.revolutionstreetwxs.io/api/v3/export/orders", {
  method: "POST",
  headers: {
    Authorization: "Bearer wxs_pk_YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "where": {
      "status": "shipped",
      "lineCount": 1
    },
    "columns": [
      "orderNumber",
      "status",
      "carrier",
      "createdAt"
    ],
    "orderBy": [
      {
        "column": "createdAt",
        "direction": "desc"
      }
    ],
    "since": "2026-09-01T00:00:00Z",
    "limit": 1000,
    "format": "csv"
  }),
});
const data = await response.json();

import requests

response = requests.post(
    "https://v3.revolutionstreetwxs.io/api/v3/export/orders",
    headers={"Authorization": "Bearer wxs_pk_YOUR_API_KEY"},
    json={
      "where": {
        "status": "shipped",
        "lineCount": 1
      },
      "columns": [
        "orderNumber",
        "status",
        "carrier",
        "createdAt"
      ],
      "orderBy": [
        {
          "column": "createdAt",
          "direction": "desc"
        }
      ],
      "since": "2026-09-01T00:00:00Z",
      "limit": 1000,
      "format": "csv"
    },
)
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
  }
}