salesAnalytics

Requires permission analytics:sales:read.

Sales analytics for a period. Limited to the customers you may see.. Needs the sales analytics read permission.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query SalesAnalytics($period: AnalyticsPeriod!) {
  salesAnalytics(period: $period) {
    averageOrderValue
    ordersGrowth
    salesGrowth
    totalOrders
    totalSales
    salesByPeriod {
      orders
      period
      sales
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query SalesAnalytics($period: AnalyticsPeriod!) {\n  salesAnalytics(period: $period) {\n    averageOrderValue\n    ordersGrowth\n    salesGrowth\n    totalOrders\n    totalSales\n    salesByPeriod {\n      orders\n      period\n      sales\n    }\n  }\n}",
  "variables": {
    "period": "LAST_6_MONTHS"
  }
}
EOF

Variables:

{
  "period": "LAST_6_MONTHS"
}

Response:

{
  "data": {
    "salesAnalytics": {
      "averageOrderValue": 0,
      "ordersGrowth": 0,
      "salesGrowth": 0,
      "totalOrders": 0,
      "totalSales": 0,
      "salesByPeriod": [
        {
          "orders": 0,
          "period": "string",
          "sales": 0
        }
      ]
    }
  }
}

salesAnalytics(
  currency: String
  period: AnalyticsPeriod!
): SalesAnalytics!

Arguments

salesAnalytics.currency ● String scalar

Does not change the figures: totals are always reported in the organization's base currency.

salesAnalytics.period ● AnalyticsPeriod! non-null enum

The reporting period to analyse.

Type

SalesAnalytics object

Sales figures for the period.