Allo

Metriques sortantes

Utilisez extend=items avec un stage pour inclure la liste reelle des appels sortants derriere les chiffres de l'entonnoir dans la reponse.

POST/v2/api/analytics/outbound

Parametre extend

Utilisez extend=items avec un stage pour inclure la liste reelle des appels sortants derriere les chiffres de l'entonnoir dans la reponse.

ValeurRequisEffet
itemsstageInclut un champ pagine items avec les appels pour l'etape d'entonnoir specifiee

Etapes

EtapeAppels inclus
DIALTous les appels sortants
CONNECTEDAppels ou le destinataire a decroche
CONVERSATIONAppels connectes de plus d'une minute
CONVERSIONAppels tagges avec l'un des tags specifies

Exemple avec detail

{
  "date": { "from": "2026-04-14", "to": "2026-04-21" },
  "tags": ["meeting_booked"],
  "granularity": "DAY",
  "extend": "items",
  "stage": "CONVERSION",
  "page": 1,
  "size": 20
}

La reponse inclut les metriques completes de l'entonnoir plus un champ items avec la liste paginee des appels pour l'etape demandee.

Passer extend=items sans stage retourne une erreur 400 avec le code MISSING_PARAMETER.

Autorisation

Authorizationstring · headerrequis

Api-Key ak_live_…

Corps

dateobjectrequis
2 champs
fromstring<date>requis

Start date

tostring<date>requis

End date

compare_dateobject
2 champs
fromstring<date>requis

Start date

tostring<date>requis

End date

user_idsstring[]

Filter by user IDs. Cannot be combined with allo_numbers.

allo_numbersstring[]

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

tagsstring[]

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

granularityenum<string>

Time series granularity

DAYWEEKMONTH

extendenum<string>

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

items

stageenum<string>

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

DIALCONNECTEDCONVERSATIONCONVERSION

pageinteger

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

sizeinteger

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

Réponses

200Outbound analytics
dataobject
9 champs
dateobject
2 champs
fromstring<date>requis

Start date

tostring<date>requis

End date

compare_dateobject
2 champs
fromstring<date>requis

Start date

tostring<date>requis

End date

funnelobject
4 champs
dialsobject
2 champs
countobject
ratenumber | null

Percentage of total dials (e.g. 0.29 = 29%)

connectedobject
2 champs
countobject
ratenumber | null

Percentage of total dials (e.g. 0.29 = 29%)

conversationsobject
2 champs
countobject
ratenumber | null

Percentage of total dials (e.g. 0.29 = 29%)

conversionsobject
2 champs
countobject
ratenumber | null

Percentage of total dials (e.g. 0.29 = 29%)

time_seriesobject
4 champs
dialsobject[]
2 champs
datestring<date>
valuenumber
connectedobject[]
2 champs
datestring<date>
valuenumber
connection_rateobject[]
2 champs
datestring<date>
valuenumber
conversionsobject[]
2 champs
datestring<date>
valuenumber
heatmapobject
3 champs
dialsobject[]
3 champs
dayenum<string>

MONDAYTUESDAYWEDNESDAYTHURSDAYFRIDAYSATURDAYSUNDAY

hourinteger

Hour of day (0-23)

valueinteger
connectedobject[]
3 champs
dayenum<string>

MONDAYTUESDAYWEDNESDAYTHURSDAYFRIDAYSATURDAYSUNDAY

hourinteger

Hour of day (0-23)

valueinteger
connection_rateobject[]
3 champs
dayenum<string>

MONDAYTUESDAYWEDNESDAYTHURSDAYFRIDAYSATURDAYSUNDAY

hourinteger

Hour of day (0-23)

valueinteger
leaderboardobject[]
2 champs
userobject
3 champs
idstring
namestring
emailstring
connectedinteger
time_spentobject
3 champs
avg_ringing_time_secondsobject
3 champs
valuenumber

Current period value

previousnumber | null

Previous period value

changenumber | null

Percentage change vs previous period (e.g. 0.15 = +15%)

avg_conversation_time_secondsobject
3 champs
valuenumber

Current period value

previousnumber | null

Previous period value

changenumber | null

Percentage change vs previous period (e.g. 0.15 = +15%)

total_conversation_time_secondsobject
3 champs
valuenumber

Current period value

previousnumber | null

Previous period value

changenumber | null

Percentage change vs previous period (e.g. 0.15 = +15%)

last_updatedstring<date-time>

When the metrics were last updated

itemsobject | null

Drilldown call list. Only present when extend=items is set.

2 champs
dataobject[]
9 champs
idstring

Call ID

userobject
allo_numberstring
allo_number_labelstring
contact_numberstring
stageenum<string>

DIALCONNECTEDCONVERSATIONCONVERSION

voicemailboolean
durationinteger

Duration in seconds

datestring<date-time>
paginationobject
5 champs
pageinteger
sizeinteger
total_countinteger
total_pagesinteger
has_moreboolean
400
401
429