Built-in tool
Get outreach funnel
See the outreach funnel by campaign, channel, sender account, variant, step and day: requests sent and accepted, messages, replies and positive replies, with rates.
Endpoint
Parameters
| Name | Type | Required | Note |
|---|---|---|---|
| tostring · optional | string | optional | Last day to include, YYYY-MM-DD, in `timezone`. Default today. |
| daysnumber · optional | number | optional | Look back this many days, ending today. Default 30. Ignored when `from` is given. Default: |
| fromstring · optional | string | optional | First day to include, YYYY-MM-DD, in `timezone`. |
| groupByarray · optional | array | optional | How to split the funnel, up to three at once: 'workflow' (campaign), 'channel' (LinkedIn or email), 'sender' (the connected account that sent), 'variant' (A/B variant of a step), 'step' (each send step), 'day' or 'week' (when it was sent). Default ['workflow']. One of: Default: |
| sendersobject · optional | object | optional | Only sends from these accounts: account names or identifiers as connector-list-accounts lists them. |
| stepIdsobject · optional | object | optional | Only these send steps (step ids from a previous call grouped by step). |
| channelsarray · optional | array | optional | Only these outreach channels. Omit for both LinkedIn and email. One of: |
| timezonestring · optional | string | optional | IANA time zone for the date range and for day and week groups, e.g. 'Asia/Makassar'. Default: the person's own time zone when the chat knows it, otherwise UTC; range.timezone in the result names the zone used. Example: |
| workflowIdsobject · optional | object | optional | Workflow UUIDs (campaigns) to include. Omit for every Workflow in the workspace. |
| minimumSamplenumber · optional | number | optional | A rate is marked enoughSample only when its denominator reaches this. Default 30. Default: |