API reference

One page per endpoint: what it returns, its parameters, an example, and what to watch out for.

Page	Endpoint	Use it for
Current store	/me	Checking a key and reading the store's currency
Store overview	/store/overview	Store-wide traffic and conversion, period on period
List custom events	/custom-events	Tracking IDs for custom event goals and filters
List experiments	/experiments	Finding experiments and their IDs
Experiment details	/experiments/{testId}	How one experiment is set up and what changed
Experiment summary	/experiments/{testId}/summary	Headline metrics and the status
Experiment results	/experiments/{testId}/results	Every metric, lift, winner and probabilities
Experiment timeseries	/experiments/{testId}/timeseries	How the numbers moved over time
Experiment segments	/experiments/{testId}/segments/{view}	Which visitors the change worked for
Filter values	/experiments/{testId}/filter-values	What values a filter field holds

Every results endpoint takes the same filters and date window, and each request spends rate limit points.

Every field is listed on its page, with its type. The same contract is published as an OpenAPI 3.1 document, generated from the code:

https://elevateab.app/external-api/openapi-v1.json

Each version of the API has its own document, named after it (openapi-v1.json).

Use it in your own tools

• Postman, Insomnia or Bruno: import the URL above to get every endpoint as a ready-made request.

• Client generation: point openapi-generator, oapi-codegen or your language's equivalent at it for a typed client.

• AI tools: give the URL to an assistant so it can call the API with the right parameters.