Statistics view of the site's flows and campaigns

Account-level SMS statistics — the numbers behind the Automated Flows overview and the Campaigns list. name picks the view. When the date range is omitted it defaults to the last 7 days.

sms-summary returns one statistics object for the SMS channel; tags narrows it — automated for the Automated Flows header, blast for the Campaigns header, or omit tags for the whole channel. It carries no recipients and no revenuePerRecipient: the channel total has no first-message cohort — RPM (revenuePerMessage) is the per-message figure here, as on the dashboard header. For the Campaigns header's Recipients and RPR read the blast entry of flow-groups-summary.

flow-groups-summary returns one entry per flow group — the dashboard's categories (e.g. default-welcome, abandonment, receipt, fulfillment, back-in-stock), each integration tag the site uses, and blast for campaigns.

automated-flows-summary returns one entry per automated flow of the site — its flowId, name and statistics; a flow without sends in the range is still present, with zeros. tags narrows it to a category.

campaign-flows-summary returns one entry per campaign with activity in the range — the campaign's flowId, name and statistics. Because every entry names its own flow, no separate list call is needed to label the rows.

Every view is a range total.

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-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

tagsstring[]Optional

sms-summary and automated-flows-summary only — flow tags; a flow must carry all of them. sms is always applied.

Responses

200

Ok

application/vnd.api+json

4XX

HTTP Error response

application/vnd.api+json

5XX

HTTP Error response

application/vnd.api+json

get/flows/views/{name}

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

{
  "data": {
    "type": "flow-views",
    "attributes": {
      "sms-summary": {
        "sent": 68700,
        "clicked": 4040,
        "clickRate": 0.0588,
        "converted": 604,
        "sales": {
          "USD": 48423,
          "EUR": 44680.5
        },
        "spent": {
          "USD": 2061
        },
        "roi": 23.5,
        "optOutRate": 0.0048,
        "spamRate": 0.0001,
        "revenuePerMessage": 0.7
      }
    }
  }
}