Statistics view of an A/B test experiment

One statistics view of an A/B test experiment — the same numbers as the dashboard's experiment results. name picks the section; all returns every section in one response. A single request always returns every variant of the experiment: each section is an object keyed by the variant's opt-in tool ID, so the caller never passes optinToolIds — the participants are read from the experiment itself.

There are no date parameters and no targetResolution — every section is a total for the experiment's own window, which is derived from its status: an ended experiment uses its full window, a running one spans its start until now, and a draft, scheduled or cancelled one has no statistics and returns 400.

Statistics fields behave as in the opt-in tool views: counts and rates are never null, so a variant without activity returns 0 rather than being omitted, and rates are 0 when the denominator is 0. The exceptions are the channel-gated email/SMS fields, absent when the tool does not collect that channel, and metric-event-summary, whose per-variant map is sparse — only events that occurred appear, and a missing key means 0.

get

Authorizations

X-Recart-API-KeystringRequired

It can be obtained in Recart account after contacting Support

Path parameters

idstringRequired

ID of the experiment

namestring · enumRequired

The view to return

Possible values:

Responses

200

Ok

application/vnd.api+json

4XX

HTTP Error response

application/vnd.api+json

5XX

HTTP Error response

application/vnd.api+json

get/optin-tool-experiments/{id}/views/{name}

GET /app-integrations/2023-12/optin-tool-experiments/{id}/views/{name} HTTP/1.1
Host: api.recart.com
X-Recart-API-Key: YOUR_API_KEY
Accept: */*

{
  "data": {
    "type": "optin-tool-experiments-views",
    "attributes": {
      "optin-summary": {
        "655637c97825e6ae655fe1c9": {
          "impression": 20400,
          "teaserConfirm": 512,
          "teaserConfirmRate": 0.0251,
          "teaserDecline": 1230,
          "emailOptin": 0,
          "emailOptinRate": 0,
          "phoneNumberSubmitted": 310,
          "phoneNumberSubmittedRate": 0.0152,
          "smsOptin": 276,
          "smsOptinRate": 0.0135,
          "subscriptions": 268
        },
        "655637c97825e6ae655fe1b5": {
          "impression": 20600,
          "teaserConfirm": 445,
          "teaserConfirmRate": 0.0216,
          "teaserDecline": 1180,
          "emailOptin": 0,
          "emailOptinRate": 0,
          "phoneNumberSubmitted": 271,
          "phoneNumberSubmittedRate": 0.0132,
          "smsOptin": 240,
          "smsOptinRate": 0.0117,
          "subscriptions": 233
        }
      }
    }
  }
}