Analytics

Get analytics

Returns call analytics for a workspace including summary statistics, time series data, ended reasons, top locations, sentiment distribution, and more.

Available Metrics:

  • summary: Total calls, answered calls, voicemail, durations, answer rate
  • timeSeries: Call volume over time with configurable granularity
  • endedReasons: Distribution of call end reasons
  • topLocations: Most common caller locations
  • topCalls: Longest or most recent calls
  • geoDistribution: Geographic distribution by country and state
  • callThemes: Common topics from call analysis
  • sentimentDistribution: Customer sentiment breakdown
get/analytics

Request

  • Base URL
    https://app.freyavoice.ai/api/v2
  • Auth
    HTTP bearer

Query parameters

workspaceIdstring uuid required

Workspace ID

startDatestring

Start date for analytics period (ISO format)

endDatestring

End date for analytics period (ISO format)

phoneNumberIdstring uuid

Filter by phone number ID

assistantIdstring

Filter by assistant/agent ID (bigint as string)

assistantIdsstring[]

Filter by multiple assistant IDs (JSON array)

granularity'hour' | 'day' | 'month'

Time series granularity: hour, day, or month

metricsstring[]

Specific metrics to return (JSON array)

timezonestring

IANA timezone for date calculations

statusstring[]

Filter by call status (JSON array)

callTypestring[]

Filter by call type: inbound, outbound, web (JSON array)

Response

Analytics data

successtrue required

Changes

No recorded changes to this operation across all 1 revision of this API.