Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.abconvert.io/llms.txt

Use this file to discover all available pages before exploring further.

Preview — this page is an early draft. We’re still verifying the API reference against the current endpoints. Fields, response shapes, and examples may change before this section is marked stable. Follow PRO-1459 or ask in #abconvert-dev if you’re integrating against this today.
Storewide analytics measure the impact of an experiment on your whole store, not just the products directly enrolled in the test. This lets you detect revenue cannibalization (where a variant wins on the test product but loses revenue elsewhere) or spillover lift (where winning variants also improve behavior on related products). Both storewide analytics endpoints are session endpoints and require Shopify authentication. They accept the same standard request body as the per-experiment analytics endpoints.

​
Storewide analytics vs. per-experiment analytics

DimensionPer-experiment analyticsStorewide analytics
ScopeOnly products enrolled in the experimentYour entire store catalog
Use caseMeasure direct test impactDetect cannibalization or spillover
AttributionEvents tied to specific experiment productsAll store events during the experiment window
Visitor countingExperiment participants onlyAll store visitors during the period
Storewide analytics still require an experimentId to define the visitor groups. ABConvert uses the experiment’s test group assignments to segment storewide behavior — it does not compare random store visitors.

​
Storewide analytics v1

Returns storewide conversion metrics broken down by the experiment’s test groups, using the same visitor-based methodology as per-experiment analytics v1. 
POST /api/analytics/v1/storewide/:experimentId

​
Path parameters

​
experimentId
string
required
The _id of the experiment whose visitor groups you want to use for segmentation.

​
Request body

Accepts the standard analytics request body: 
{
  "dateStart": "2024-01-01T00:00:00.000Z",
  "dateFinish": "2024-01-31T23:59:59.999Z",
  "filterParams": {
    "countries": ["US", "CA"]
  },
  "deviceType": "ALL",
  "visitorType": "ALL"
}
See the standard analytics request fields for full parameter documentation.

​
Example request

curl -X POST "https://app.abconvert.io/api/analytics/v1/storewide/64a1f2b3c4d5e6f7a8b9c0d1" \
  -H "Authorization: Bearer <shopi...en>" \
  -H "Content-Type: application/json" \
  -d '{
    "dateStart": "2024-01-01T00:00:00.000Z",
    "dateFinish": "2024-01-31T23:59:59.999Z",
    "filterParams": { "countries": ["US", "CA"] },
    "deviceType": "ALL",
    "visitorType": "ALL"
  }'

​
Response

{
  "totalViews": [4200, 4150],
  "totalAddToCarts": [890, 920],
  "totalOrders": [310, 330],
  "totalRevenue": [31000.00, 34200.00],
  "statisticalSignificance": {
    "pValue": 0.061,
    "tStat": 1.88,
    "confidenceInterval": [-0.01, 0.09]
  }
}
​
totalViews
array
Total store page views per test group across all products during the period.
​
totalAddToCarts
array
Total add-to-cart events per test group across the whole store.
​
totalOrders
array
Total completed orders per test group across the whole store.
​
totalRevenue
array
Total revenue in store currency per test group, across all products.
​
statisticalSignificance
object
Statistical significance metrics for the storewide conversion difference. See experiment analytics for field definitions.

​
Storewide analytics v2

An enhanced version of storewide analytics that includes visitor journey tracking across multiple sessions, matching the richer attribution model of per-experiment analytics v2. 
POST /api/analytics/v2/storewide/:experimentId

​
Path parameters

​
experimentId
string
required
The _id of the experiment whose visitor groups define the segmentation.

​
Request body

Same structure as v1. See the standard analytics request fields.

​
Example request

curl -X POST "https://app.abconvert.io/api/analytics/v2/storewide/64a1f2b3c4d5e6f7a8b9c0d1" \
  -H "Authorization: Bearer <shopi...en>" \
  -H "Content-Type: application/json" \
  -d '{
    "dateStart": "2024-01-01T00:00:00.000Z",
    "dateFinish": "2024-01-31T23:59:59.999Z",
    "deviceType": "ALL",
    "visitorType": "ALL"
  }'
The response extends the v1 shape with additional journey-level breakdown fields, reflecting how experiment participants behaved across your entire store over multiple sessions.

​
Specialized experiment analytics

For experiment types other than price and content, ABConvert provides dedicated analytics endpoints that return type-appropriate metrics:
Experiment typeEndpoint
ShippingPOST /api/analytics/shipping/:experimentId
URL redirectPOST /api/analytics/redirect/:experimentId
TemplatePOST /api/analytics/template/:experimentId
ThemePOST /api/analytics/theme/:experimentId
Checkout UIPOST /api/analytics/checkout/:experimentId
All specialized endpoints accept the same standard request body.