Heatmap GraphQL API Documentation Directory
POST /graphql/v1

Examples and Best Practices

Minimal Query Body Template


{

  "query": "query Analytics($input: AnalyticsQueryInput!) { analytics(input: $input) { summary { total } rows { dimension value } } }",

  "variables": {

    "input": {

      "siteId": "123",

      "metric": "SESSIONS",

      "range": { "start": "2026-01-01", "end": "2026-01-31" }

    }

  }

}

Build Queries Incrementally

  1. Start with required fields only.
  2. Add one filter at a time.
  3. Add breakdown/grouping after baseline output validates.
  4. Add sorting and limits as a final optimization step.

Date Range Guidance

Performance Tips

Reliability Tips