sequence-templates

Get Sequence Metrics

Changed on

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

Request

  • Base URL: https://api.topo.io
  • URL: https://api.topo.io/v1/sequence-templates/metrics
  • Auth: HTTP bearer

Query parameters

sequence_template_idstring uuid nullable

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.

start_datestring date nullable

Inclusive start of the reporting window.

end_datestring date nullable

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.

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

Changes

  • 3535956158d8Revision changes
    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

  • 4c947c3f2e11Revision changes
    • warning

      added the new NOT_INTERESTED enum value to the // response property for the response status