Skip to main content

API reference

This reference is generated from the Crazy Egg GraphQL schema and its descriptions. It lists every query, mutation and subscription in the published schema, along with the types they use. Each page keeps the schema's descriptions, nullability (! marks a value that is never null), custom scalars and deprecation notices.

Read the getting started guide first. It covers the endpoint, personal access tokens, errors and rate limits, which apply to every operation listed here.

Calling these operations​

Send requests to https://api.crazyegg.com/api with a personal access token:

POST /api HTTP/1.1
Host: api.crazyegg.com
Authorization: Bearer ce_pat_...
Content-Type: application/json

Two groups of operations work differently:

  • Subscriptions are not supported for personal access token integrations: the GraphQL WebSocket transport that delivers them does not accept personal access tokens.
  • Page editor operations, marked on their pages, also accept the Crazy Egg page editor's own credential and check access to the editor, page or site involved.

A read-only token can call queries but not mutations, and queries that need edit access are denied too. A query can still have side effects; check the operation's description before calling it repeatedly.

About this snapshot​

The reference and the schema download come from the source revision shown at the bottom of each page. They are not checked against the deployed API, which can be briefly ahead of or behind this snapshot. If a live response disagrees with this reference, trust the response.