Statistics view of all opt-in tools of the site

The account-level opt-in tool statistics view — every opt-in tool of the site in a single response, the collection counterpart of /optin-tools/{id}/views/{name}. name picks the view. When the date range is omitted it defaults to the last 7 days.

optin-tools-summary returns one entry per opt-in tool that recorded any metric event or collected any SMS subscription in the range: the tool's optinToolName, optinToolType and, for popups, optinToolTags, then its raw metric-event unique-session counts merged with its new SMS subscription count. Event keys are sparse — a missing key means 0; smsSubscriptions is always present, 0 when none. Because every entry names, types and tags its own tool, a per-type or per-tag total can be computed from this response alone, without a separate /optin-tools call. The tags are the tool's current ones: as in the dashboard, the range's statistics are reported per tool under its current configuration. Values are counts, not amounts: this view carries no USD figures; for attributed revenue use the per-tool revenue views. Subscriptions from non-tool sources (imports, customer chat, …) are not part of this view.

get

Authorizations

X-Recart-API-KeystringRequired

It can be obtained in Recart account after contacting Support

Path parameters

namestring · enumRequired

The view to return

Possible values:

Query parameters

dateFromstring · dateOptional

First day of the range, inclusive (YYYY-MM-DD, UTC). Defaults to 7 days before dateTo. Must not be older than 18 months — the API does not serve older data, and an older dateFrom returns 400.

Example: 2026-08-18

dateTostring · dateOptional

Last day of the range, inclusive — dateTo=2026-08-24 includes the whole of 2026-08-24 (UTC). Defaults to today.

Example: 2026-08-24

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-tools/views/{name}

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

{
  "data": {
    "type": "optin-tool-list-views",
    "attributes": {
      "optin-tools-summary": [
        {
          "optinToolId": "655637c97825e6ae655fe1c9",
          "optinToolName": "Summer sale — Main",
          "optinToolType": "popup",
          "optinToolTags": [
            "delay",
            "discount-694132dcb842e9d365676043",
            "micro-yes",
            "one-click-opt-in",
            "opt-in-offer"
          ],
          "impression": 20400,
          "teaserConfirmation": 512,
          "closePopup": 3100,
          "emailClick": 512,
          "smsOptin": 276,
          "smsSubscriptions": 150
        },
        {
          "optinToolId": "655637c97825e6ae655fe1b5",
          "optinToolName": "Summer sale — Preferences",
          "optinToolType": "popup",
          "optinToolTags": [
            "button-group",
            "discount-694132dcb842e9d365676043",
            "exit-intent",
            "in-popup-confirmation",
            "opt-in-offer"
          ],
          "impression": 18100,
          "teaserConfirmation": 445,
          "engagement": 5210,
          "smsOptin": 190,
          "smsSubscriptions": 120
        }
      ]
    }
  }
}