INinstantly
CampaignSubsequence
Analytics

Get subsequence step and variant analytics

Changed on

Returns engagement metrics grouped by zero-based step and variant for one subsequence. Results include only activity from the requested subsequence, excluding its parent campaign and sibling subsequences.

Requires one of the following scopes: subsequences:read, subsequences:all, all:read, all:all

get/api/v2/subsequences/{id}/analytics/steps

Request

  • Base URL
    https://api.instantly.ai
  • URL
    https://api.instantly.ai/api/v2/subsequences/{id}/analytics/steps
  • Auth
    HTTP bearer

Path parameters

idstring uuid required
Example:01a19e6f-8e19-747d-830a-63f2ea769d81

The ID of the subsequence to analyze.

Query parameters

start_datestring
Example:2024-01-01

Inclusive start of the analytics range. Accepts a date-only value (YYYY-MM-DD) or an ISO 8601 timestamp. Timestamps are normalized to their UTC calendar date.

end_datestring
Example:2024-01-31

Inclusive end of the analytics range. Accepts a date-only value (YYYY-MM-DD) or an ISO 8601 timestamp. Timestamps are normalized to their UTC calendar date.

Response

Engagement metrics grouped by subsequence step and variant.

stepstring nullable required

Zero-based step index. 0 is the first step. Null when the event could not be attributed to a step.

variantstring nullable required

Zero-based variant index. 0 is variant A, 1 is variant B, and so on. Null when the event could not be attributed to a variant.

sentinteger required

Total emails sent from this step and variant.

openedinteger required

Total open events attributed to this step and variant.

unique_openedinteger required

Number of unique leads that opened an email from this step and variant.

repliesinteger required

Total replies attributed to this step and variant.

unique_repliesinteger required

Number of unique leads that replied to this step and variant.

replies_automaticinteger required

Total automatic replies attributed to this step and variant.

unique_replies_automaticinteger required

Number of unique leads that sent an automatic reply to this step and variant.

clicksinteger required

Total link click events attributed to this step and variant.

unique_clicksinteger required

Number of unique leads that clicked a link in this step and variant.

Example response

[
  {
    "step": "0",
    "variant": "0",
    "sent": 100,
    "opened": 45,
    "unique_opened": 40,
    "replies": 12,
    "unique_replies": 11,
    "replies_automatic": 2,
    "unique_replies_automatic": 2,
    "clicks": 18,
    "unique_clicks": 15
  }
]

Changes