> For the complete documentation index, see [llms.txt](https://help.recart.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.recart.com/developers/public-api/flow/statistics-view-of-an-automated-flow.md).

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

```json
{"openapi":"3.1.0","info":{"title":"Recart API","version":"2023-12"},"tags":[{"name":"Flow","description":"Flows"}],"servers":[{"url":"https://api.recart.com/app-integrations/2023-12","description":"Production"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-Recart-API-Key","description":"It can be obtained in Recart account after contacting Support"}},"schemas":{"AutomatedFlowViews":{"type":["object"],"required":["type","attributes"],"properties":{"type":{"type":"string","enum":["automated-flow-views"]},"attributes":{"type":"object","description":"The requested view's data under its name — exactly one key per\nrequest.\n","minProperties":1,"properties":{"flow-summary":{"description":"The flow's totals for the range","$ref":"#/components/schemas/FlowStatistics"},"flow-items-summary":{"type":"object","description":"Totals per message item, keyed by flowItemId — the same id as\nitems[] on the flow detail. Only items that recorded activity\nin the range appear; a missing key means no activity. Per\nitem, recipients equals sent (a message reaches a subscriber\nat most once), so revenuePerRecipient equals revenuePerMessage.\n","additionalProperties":{"$ref":"#/components/schemas/FlowStatistics"}}}}}},"FlowStatistics":{"type":"object","description":"Range totals of one flow, campaign, group or message — the same\nnumbers as the dashboard. Rates with a zero denominator are 0.\nAmounts are keyed by ISO 4217 code: USD always, the store currency\nadditionally when it is not USD.\n\nrecipients and revenuePerRecipient are present on every view except\nsms-summary: the SMS channel total is aggregated without the\nfirst-message cohort that defines recipients, and its sent counts\nevery message of every flow, so the number cannot be derived from\nit. The dashboard's Automated Flows header, built on the same data,\nshows RPM and no recipients for the same reason. Where the\ndashboard shows Recipients and RPR — the Campaigns header — read\nthe blast entry of flow-groups-summary.\n","required":["sent","clicked","clickRate","converted","sales","spent","roi","optOutRate","spamRate","revenuePerMessage"],"properties":{"sent":{"type":"integer","description":"SMS and MMS messages sent"},"recipients":{"type":"integer","description":"Subscribers who received the flow's first message. Present on\nflow-groups-summary, automated-flows-summary,\ncampaign-flows-summary, flow-summary and flow-items-summary\n(where it equals the item's sent — a message reaches a subscriber\nat most once); absent on sms-summary.\n"},"clicked":{"type":"integer","description":"Clicks on a link in one of the flow's messages"},"clickRate":{"type":"number","description":"Clicks / sent"},"converted":{"type":"integer","description":"Attributed orders"},"sales":{"type":"object","additionalProperties":{"type":"number"},"description":"Attributed order value per currency (ISO 4217 code)"},"spent":{"type":"object","additionalProperties":{"type":"number"},"description":"SMS and MMS cost per currency (ISO 4217 code)"},"roi":{"type":"number","description":"sales.USD / spent.USD"},"optOutRate":{"type":"number","description":"Opt-outs attributed to the flow / recipients"},"spamRate":{"type":"number","description":"Carrier spam rejections / sent"},"revenuePerRecipient":{"type":"number","description":"sales.USD / recipients — the dashboard's RPR. Present wherever\nrecipients is; absent on sms-summary. Equals revenuePerMessage\non flow-items-summary.\n"},"revenuePerMessage":{"type":"number","description":"sales.USD / sent — the dashboard's RPM"}}},"HttpErrorBody":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["id","code","title","detail"],"properties":{"id":{"type":"string"},"code":{"type":"string"},"title":{"type":"string"},"detail":{"type":"string"}}}}}}},"responses":{"HttpError":{"description":"HTTP Error response","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/HttpErrorBody"}}}}}},"paths":{"/automated-flows/{id}/views/{name}":{"get":{"summary":"Statistics view of an automated flow","tags":["Flow"],"operationId":"getAutomatedFlowView","description":"One statistics view of an automated flow. `name` picks the view.\nWhen the date range is omitted it defaults to the last 7 days. The\nid of a campaign-backed flow returns 404 — use\n`/campaign-flows/{id}/views/{name}` instead.\n\n`flow-summary` returns the flow's totals for the range.\n`flow-items-summary` returns an object keyed by `flowItemId` — the\nsame id as `items[]` on `/automated-flows/{id}` — with one key per\nmessage item that recorded activity in the range; a missing key\nmeans no activity.\n","parameters":[{"name":"id","in":"path","required":true,"description":"ID of the automated flow","schema":{"type":"string"}},{"name":"name","in":"path","required":true,"description":"The view to return","schema":{"type":"string","enum":["flow-summary","flow-items-summary"]}},{"name":"dateFrom","in":"query","description":"First day of the range, inclusive (YYYY-MM-DD, UTC).\nDefaults to 7 days before `dateTo`. Must not be older than\n18 months — the API does not serve older data, and an older\n`dateFrom` returns 400.\n","schema":{"type":"string","format":"date"}},{"name":"dateTo","in":"query","description":"Last day of the range, inclusive — `dateTo=2026-08-31` includes\nthe whole of 2026-08-31 (UTC). Defaults to today.\n","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"Ok","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"description":"Always one resource of type automated-flow-views;\nattributes holds the requested view under its name.\n","$ref":"#/components/schemas/AutomatedFlowViews"}}}}}},"4XX":{"$ref":"#/components/responses/HttpError"},"5XX":{"$ref":"#/components/responses/HttpError"}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://help.recart.com/developers/public-api/flow/statistics-view-of-an-automated-flow.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
