appActivityDrilldown

Requires permission analytics:sales:read.

The customers or products behind one app activity number, one page at a time, over a date range. 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 AppActivityDrilldown($input: AppActivityDrilldownInput!, $range: AnalyticsRangeInput!) {
  appActivityDrilldown(input: $input, range: $range) {
    baseCurrency
    hasMore
    metric
    offset
    total
    rows {
      orderNumber
      customerName
      productName
      variantName
      at
      count
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query AppActivityDrilldown($input: AppActivityDrilldownInput!, $range: AnalyticsRangeInput!) {\n  appActivityDrilldown(input: $input, range: $range) {\n    baseCurrency\n    hasMore\n    metric\n    offset\n    total\n    rows {\n      orderNumber\n      customerName\n      productName\n      variantName\n      at\n      count\n    }\n  }\n}",
  "variables": {
    "input": {
      "metric": "ACTIVE_CUSTOMERS"
    },
    "range": {
      "from": "2025-01-15T00:00:00Z",
      "to": "2025-01-15T00:00:00Z"
    }
  }
}
EOF

Variables:

{
  "input": {
    "metric": "ACTIVE_CUSTOMERS"
  },
  "range": {
    "from": "2025-01-15T00:00:00Z",
    "to": "2025-01-15T00:00:00Z"
  }
}

Response:

{
  "data": {
    "appActivityDrilldown": {
      "baseCurrency": "string",
      "hasMore": true,
      "metric": "ACTIVE_CUSTOMERS",
      "offset": 0,
      "total": 0,
      "rows": [
        {
          "orderNumber": "string",
          "customerName": "string",
          "productName": "string",
          "variantName": "string",
          "at": "2025-01-15T00:00:00Z",
          "count": 0
        }
      ]
    }
  }
}

appActivityDrilldown(
  input: AppActivityDrilldownInput!
  range: AnalyticsRangeInput!
): AppActivityDrilldownPage!

Arguments

appActivityDrilldown.input ● AppActivityDrilldownInput! non-null input

Which number to drill into, plus paging.

appActivityDrilldown.range ● AnalyticsRangeInput! non-null input

The date range and, optionally, the visibility scope.

Type

AppActivityDrilldownPage object

A page of the rows behind a figure.