appActivityAnalytics

Requires permission analytics:sales:read.

App activity analytics: how customers use the buyer app and the web portal, over a date range. Every number is 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 AppActivityAnalytics($range: AnalyticsRangeInput!) {
  appActivityAnalytics(range: $range) {
    asOf
    baseCurrency
    periodDays
    source
    abandonedProducts {
      productName
      variantName
      customers
      productId
      value
      variantId
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query AppActivityAnalytics($range: AnalyticsRangeInput!) {\n  appActivityAnalytics(range: $range) {\n    asOf\n    baseCurrency\n    periodDays\n    source\n    abandonedProducts {\n      productName\n      variantName\n      customers\n      productId\n      value\n      variantId\n    }\n  }\n}",
  "variables": {
    "range": {
      "from": "2025-01-15T00:00:00Z",
      "to": "2025-01-15T00:00:00Z"
    }
  }
}
EOF

Variables:

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

Response:

{
  "data": {
    "appActivityAnalytics": {
      "asOf": "2025-01-15T00:00:00Z",
      "baseCurrency": "string",
      "periodDays": 0,
      "source": "ARC",
      "abandonedProducts": [
        {
          "productName": "string",
          "variantName": "string",
          "customers": 0,
          "productId": "id",
          "value": 0,
          "variantId": "id"
        }
      ]
    }
  }
}

appActivityAnalytics(
  options: AppActivityOptionsInput
  range: AnalyticsRangeInput!
): AppActivityAnalytics!

Arguments

appActivityAnalytics.options ● AppActivityOptionsInput input

Optional settings for the report.

appActivityAnalytics.range ● AnalyticsRangeInput! non-null input

The date range and, optionally, the visibility scope.

Type

AppActivityAnalytics object

How customers use the buyer app and portal.