Sign in
latestOpenAPI 3.1.02026-08-18104219248.1 KB

ad6ac1d13526

sequence-templates

Get Sequence Metrics

Report outreach performance over a date window.

Counters cover the window, not the lifetime of a template, and are counts rather than rates: leads found, sent, opened, clicked, replied, positive replies and hot leads, plus how the replies were categorised. Templates are returned busiest first. Omit sequence_template_id to cover the whole portfolio.

Requires the sequences:read scope on the API key.

get/v1/sequence-templates/metrics

Query parameters

sequence_template_idstring uuid nullable

Report on one template. Omit to cover every template in the workspace.

Report on one template. Omit to cover every template in the workspace.

daysinteger

Lookback window in days, used when start_date and end_date are omitted.

Lookback window in days, used when start_date and end_date are omitted.

start_datestring date nullable

Inclusive start of the reporting window.

Inclusive start of the reporting window.

end_datestring date nullable

Inclusive end of the window. Defaults to today.

Inclusive end of the window. Defaults to today.

channel'EMAIL' | 'LINKEDIN' | 'ALL' | 'MANUAL'

Restrict counters to one channel. Defaults to all channels.

include_inactiveboolean

Include templates that are no longer active.

Include templates that are no longer active.

Response

Successful Response

start_datestring date required

Inclusive first day of the reporting window.

end_datestring date required

Inclusive last day of the reporting window.

channel'EMAIL' | 'LINKEDIN' | 'ALL' | 'MANUAL' required