Statistics view of an opt-in tool

One statistics view of a popup, landing-page or embedded-form opt-in tool. name picks the view; all returns every section in one response. When the date range is omitted it defaults to the last 7 days.

Popups support every view. Landing pages and embedded forms support optin-summary, optin-history and subscriptions-history only — the revenue views and all return 400 for them. Keywords support subscriptions-history only. A landing page or embedded form has no teaser step and records no bounce, so its teaserConfirm, teaserConfirmRate, teaserDecline, bounce and bounceRate are always 0.

Statistics fields are never null: buckets without activity and empty ranges return 0 counts and 0 rates — zero and "no data" are deliberately not distinguished, matching the dashboard. The only fields that can be absent are the channel-gated email/SMS ones, which are omitted when the tool does not collect that channel.

get

Authorizations

X-Recart-API-KeystringRequired

It can be obtained in Recart account after contacting Support

Path parameters

idstringRequired

ID of the opt-in tool

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.

Example: 2026-08-04

dateTostring · dateOptional

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

Example: 2026-08-10

targetResolutionstring · enumOptional

Bucket size of the time series — history views and all only. Buckets are UTC; weeks start on Monday.

Default: dayPossible 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-tools/{id}/views/{name}

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

{
  "data": {
    "type": "optin-tool-views",
    "attributes": {
      "optin-summary": {
        "impression": 41200,
        "teaserConfirm": 890,
        "teaserConfirmRate": 0.0216,
        "teaserDecline": 2140,
        "emailOptin": 610,
        "emailOptinRate": 0.0148,
        "phoneNumberSubmitted": 530,
        "phoneNumberSubmittedRate": 0.0129,
        "smsOptin": 480,
        "smsOptinRate": 0.0117
      }
    }
  }
}