Statistics view of a campaign

One statistics view of a campaign, addressed by campaign id — the same two views as /automated-flows/{id}/views/{name}. When the date range is omitted it covers the campaign's lifetime — a campaign's revenue keeps arriving for days after the send. The id of an automated flow returns 404 — use /automated-flows/{id}/views/{name} instead.

flow-summary returns the campaign's totals for the range. flow-items-summary returns an object keyed by flowItemId — the same id as items[] on /campaign-flows/{id} — with one key per message item that recorded activity in the range; adaptive-test variants are message items, so each variant gets its own key.

adaptive-flow-summary is for adaptive campaigns only (404 for a standard one): the campaign's id and name, its adaptive test state and result, and one entry per variant with the evaluationStats the winner was picked on next to the variant's lifetime totals. It ignores dateFrom and dateTo.

get

Authorizations

X-Recart-API-KeystringRequired

It can be obtained in Recart account after contacting Support

Path parameters

idstringRequired

ID of the campaign

namestring · enumRequired

The view to return

Possible values:

Query parameters

dateFromstring · dateOptional

First day of the range, inclusive (YYYY-MM-DD, UTC). Defaults to the campaign's send day (sentAt, or scheduledFor / createdAt while it has not been sent), clamped to 18 months ago. A caller-supplied dateFrom must not be older than 18 months — the API does not serve older data, and an older dateFrom returns 400.

Example: 2026-08-25

dateTostring · dateOptional

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

Example: 2026-08-31

Responses

200

Ok

application/vnd.api+json

4XX

HTTP Error response

application/vnd.api+json

5XX

HTTP Error response

application/vnd.api+json

get/campaign-flows/{id}/views/{name}

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

{
  "data": {
    "type": "campaign-flow-views",
    "attributes": {
      "flow-summary": {
        "sent": 24700,
        "recipients": 24700,
        "clicked": 1310,
        "clickRate": 0.053,
        "converted": 189,
        "sales": {
          "USD": 15020.5
        },
        "spent": {
          "USD": 741
        },
        "roi": 20.27,
        "optOutRate": 0.0038,
        "spamRate": 0.0001,
        "revenuePerRecipient": 0.61,
        "revenuePerMessage": 0.61
      }
    }
  }
}