Skip to main content
POST
Outbound metrics
Required scope: CONVERSATIONS_READ

Extend parameter

Use extend=items with a stage to include the actual list of outbound calls behind the funnel numbers in the response.

Stages

Example with drilldown

The response includes the full funnel metrics plus an items field with the paginated call list for the requested stage. Passing extend=items without stage returns a 400 error with code MISSING_PARAMETER.

Authorizations

Authorization
string
header
required

Body

application/json
date
object
required
compare_date
object

Comparison period. Metrics will include change vs this period.

user_ids
string[]

Filter by user IDs. Cannot be combined with allo_numbers.

allo_numbers
string[]

Filter by Allo numbers (E.164). Cannot be combined with user_ids.

tags
string[]

Tag keys that define a conversion (e.g. ['meeting_booked', 'demo_scheduled'])

granularity
enum<string>
default:DAY

Time series granularity

Available options:
DAY,
WEEK,
MONTH
extend
enum<string>

Include the list of outbound calls behind the funnel numbers. Requires stage.

Available options:
items
stage
enum<string>

Filter drilldown items by funnel stage. Only used when extend=items.

Available options:
DIAL,
CONNECTED,
CONVERSATION,
CONVERSION
page
integer
default:1

Page number for drilldown items. Only used when extend=items.

size
integer
default:20

Page size for drilldown items. Only used when extend=items.

Required range: x <= 100

Response

Outbound analytics

data
object