API ReferenceAnalytics

Get flow stats

Get statistics for a specific flow.

Authentication

AuthorizationBearer

Pass a JWT access token or an API key (prefixed with tif_live_) as a Bearer token.

Path parameters

flowIdstringRequiredformat: "uuid"
Flow ID

Query parameters

periodenumOptional
Time period
Allowed values:
startDatestringOptional
Start date for custom period
endDatestringOptional
End date for custom period

Response

Flow statistics
callsobject
Call count breakdown by status
costsobject
Total and average cost metrics
directionobject
Inbound vs outbound call counts
durationobject
Total and average duration in seconds
endDatedatetime
End of the reporting period
flowIdstringformat: "uuid"
Unique identifier of the flow
flowNamestring
Display name of the flow
periodstring
Time period label
ratesobject
Success and failure rate percentages
startDatedatetime
Start of the reporting period

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error