Skip to main content

This page is also available as plain markdown · OpenAPI spec

List revenue

GET 
/revenue

List revenue

Request​

Query Parameters

    currencystring
    Example: usd
    dimensionstring
    Example: month
    pageinteger
    Example: 1
    perPageinteger
    Example: 1
    sincestring
    Example: 2025-04-01
    sortstring
    Example: -grossSales
    untilstring
    Example: 2025-04-30

200

Returns total revenue when dimension is omitted
dataobject[]required
objectstring
dimensionstring
dimensionIdstringnullable
grossSalesnumber<float>
netSalesnumber<float>
onlineSalesnumber<float>
terminalSalesnumber<float>
cashSalesnumber<float>
refundsnumber<float>
stripeFeesnumber<float>
viewcyFeesnumber<float>
objectstringrequired
pageintegerrequired
totalPagesintegerrequired
perPageintegerrequired
totalCountintegerrequired
hasNextPagebooleanrequired
metaobjectrequired
requestIdstringrequired
Example: returns_total_revenue_when_dimension_is_omitted
{
  "data": [
    {
      "object": "revenue",
      "dimension": "Total",
      "dimensionId": null,
      "grossSales": 225,
      "netSales": 191.25,
      "onlineSales": 225,
      "terminalSales": 0,
      "cashSales": 0,
      "refunds": 0,
      "stripeFees": 11.25,
      "viewcyFees": 22.5
    }
  ],
  "object": "list",
  "page": 1,
  "totalPages": 1,
  "perPage": 25,
  "totalCount": 1,
  "hasNextPage": false,
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}
Example: returns_total_revenue_when_dimension_is_'total'
{
  "data": [
    {
      "object": "revenue",
      "dimension": "Total",
      "dimensionId": null,
      "grossSales": 225,
      "netSales": 191.25,
      "onlineSales": 225,
      "terminalSales": 0,
      "cashSales": 0,
      "refunds": 0,
      "stripeFees": 11.25,
      "viewcyFees": 22.5
    }
  ],
  "object": "list",
  "page": 1,
  "totalPages": 1,
  "perPage": 25,
  "totalCount": 1,
  "hasNextPage": false,
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}
Example: returns_revenue_grouped_by_date_dimension
{
  "data": [
    {
      "object": "revenue",
      "dimension": "2025-03-15",
      "dimensionId": "2025-03-15",
      "grossSales": 100,
      "netSales": 85,
      "onlineSales": 100,
      "terminalSales": 0,
      "cashSales": 0,
      "refunds": 0,
      "stripeFees": 5,
      "viewcyFees": 10
    },
    {
      "object": "revenue",
      "dimension": "2025-04-10",
      "dimensionId": "2025-04-10",
      "grossSales": 50,
      "netSales": 42.5,
      "onlineSales": 50,
      "terminalSales": 0,
      "cashSales": 0,
      "refunds": 0,
      "stripeFees": 2.5,
      "viewcyFees": 5
    },
    {
      "object": "revenue",
      "dimension": "2025-05-01",
      "dimensionId": "2025-05-01",
      "grossSales": 75,
      "netSales": 63.75,
      "onlineSales": 75,
      "terminalSales": 0,
      "cashSales": 0,
      "refunds": 0,
      "stripeFees": 3.75,
      "viewcyFees": 7.5
    }
  ],
  "object": "list",
  "page": 1,
  "totalPages": 1,
  "perPage": 25,
  "totalCount": 3,
  "hasNextPage": false,
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}

401

Returns 401
objectstringrequired
statusintegerrequired
messagestringrequired
metaobjectrequired
requestIdstringrequired
Example: returns_401
{
  "object": "error",
  "status": 401,
  "message": "Authentication required",
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}