Statistics view of an automated flow

One statistics view of an automated flow. name picks the view. When the date range is omitted it defaults to the last 7 days. The id of a campaign-backed flow returns 404 — use /campaign-flows/{id}/views/{name} instead.

flow-summary returns the flow's totals for the range. flow-items-summary returns an object keyed by flowItemId — the same id as items[] on /automated-flows/{id} — with one key per message item that recorded activity in the range; a missing key means no activity.

get

Authorizations

X-Recart-API-KeystringRequired

It can be obtained in Recart account after contacting Support

Path parameters

idstringRequired

ID of the automated flow

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-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/automated-flows/{id}/views/{name}

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

{
  "data": {
    "type": "automated-flow-views",
    "attributes": {
      "flow-summary": {
        "sent": 12900,
        "recipients": 9100,
        "clicked": 900,
        "clickRate": 0.0698,
        "converted": 110,
        "sales": {
          "USD": 9252.5
        },
        "spent": {
          "USD": 387
        },
        "roi": 23.91,
        "optOutRate": 0.0095,
        "spamRate": 0.0001,
        "revenuePerRecipient": 1.02,
        "revenuePerMessage": 0.72
      }
    }
  }
}