For the complete documentation index, see llms.txt. This page is also available as Markdown.

Store overview

GET /store/overview

Returns how the whole store performed over a period, next to the period of the same length just before it, plus how many experiments are running. It is store-wide: experiment filters do not apply.

Parameters

Parameter
Description

startDate, endDate

The window, YYYY-MM-DD, both days included. Defaults to the last 30 days, up to 365 days

Response

Field
Type
What it holds

storeId, plan, currency

string | null

The store, as /me returns it

activeTestCount

integer

Experiments running right now

totalTestsRun

integer

Experiments the store has ever run

period.current

object

startDate and endDate of the window you asked for

period.previous

object

The same length, immediately before it

metrics.{name}.value

number

The metric over the current period

metrics.{name}.change

number | null

Difference from the previous period, null when it had no data

{name} is one of sessions, conversionRate, addToCartRate, checkoutCompletionRate, cartAbandonmentRate, checkoutAbandonmentRate, productPageAddToCartDropOffRate and averageOrderValue.

curl "https://elevateab.app/api/external/v1/store/overview?startDate=2026-08-01&endDate=2026-08-31" \
  -H "Authorization: Bearer YOUR_API_KEY"
{
  "success": true,
  "data": {
    "storeId": "your-store.myshopify.com",
    "currency": "USD",
    "activeTestCount": 3,
    "totalTestsRun": 48,
    "period": {
      "current": { "startDate": "2026-08-01", "endDate": "2026-08-31" },
      "previous": { "startDate": "2026-07-01", "endDate": "2026-07-31" }
    },
    "metrics": {
      "sessions": { "value": 128400, "change": 6.2 },
      "conversionRate": { "value": 2.84, "change": -0.3 },
      "averageOrderValue": { "value": 61.2, "change": 1.8 }
    }
  }
}

Worth knowing

  • change is the difference from the previous period, in percent for counts and money, and in percentage points for rates.

  • Dates cannot be in the future, and a window longer than 365 days returns 400.

  • These numbers cover all traffic, not only visitors in experiments, so they will not match an experiment's results.

Last updated