Analytics

Get Email By Step

Email metrics by STEP ORDER - where in the sequence people drop.

The step view is the one that changes a sequence: a reply rate that dies at step three is a step-three problem, not a sequence problem.

get/analytics/outbound/email-metrics/by-step

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/analytics/outbound/email-metrics/by-step
  • Auth: HTTP bearer

Query parameters

daysinteger

Size of the trailing window, in days, ending today (UTC).

sequence_idstring nullable

Narrow to one sequence. Omit for every sequence's steps folded together by step order.

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Response

Successful Response

dataReportPayload required

An OPEN envelope around one report's answer.

The app wraps every one of these reports in {success, data, meta}, where meta carries the cache state, the window and - on the agency reports - failed_org_ids, the orgs that contributed NOTHING to the totals above. That field is the difference between "this client sent no email" and "we could not query this client", so it is forwarded rather than flattened away.

Open on purpose: data is dict | list in the app and its contents grow with the product. A closed model would turn every new metric into a silently dropped one.

Changes

No recorded changes to this operation across all 2 revisions of this API.