Get analytics
curl --request GET \
--url https://app.freyavoice.ai/api/v2/analytics \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.freyavoice.ai/api/v2/analytics"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.freyavoice.ai/api/v2/analytics', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.freyavoice.ai/api/v2/analytics",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.freyavoice.ai/api/v2/analytics"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.freyavoice.ai/api/v2/analytics")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.freyavoice.ai/api/v2/analytics")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"message": "<string>",
"result": {
"workspaceId": "<string>",
"timeRange": {
"start": "<string>",
"end": "<string>"
},
"granularity": "hour",
"generatedAt": "<string>",
"summary": {
"totalCalls": 123,
"answeredCalls": 123,
"voicemailCalls": 123,
"totalDurationSec": 123,
"averageDurationSec": 123,
"answerRate": 123
},
"timeSeries": [
{
"date": "<string>",
"totalCalls": 123,
"answeredCalls": 123,
"averageDurationSec": 123,
"sentimentCounts": {
"very-unhappy": 123,
"unhappy": 123,
"neutral": 123,
"happy": 123,
"very-happy": 123
}
}
],
"endedReasons": [
{
"reason": "<string>",
"count": 123
}
],
"topCalls": [
{
"callId": "<string>",
"customerNumber": "<string>",
"durationSec": 123,
"startedAt": "<string>",
"status": "<string>",
"endedReason": "<string>"
}
],
"geoDistribution": {
"countries": [
{
"countryCode": "<string>",
"countryName": "<string>",
"callCount": 123
}
],
"states": [
{
"countryCode": "<string>",
"countryName": "<string>",
"stateCode": "<string>",
"stateName": "<string>",
"callCount": 123
}
]
},
"callThemes": [
{
"theme": "<string>",
"count": 123
}
],
"sentimentDistribution": [
{
"bucket": "very-unhappy",
"count": 123
}
]
}
}
}{
"success": false,
"data": {
"message": "<string>",
"result": "<unknown>"
}
}{
"success": false,
"data": {
"message": "<string>",
"result": "<unknown>"
}
}{
"success": false,
"data": {
"message": "<string>",
"result": "<unknown>"
}
}{
"success": false,
"data": {
"message": "<string>",
"result": "<unknown>"
}
}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 ratetimeSeries: Call volume over time with configurable granularityendedReasons: Distribution of call end reasonstopCalls: Longest or most recent callsgeoDistribution: Geographic distribution by country and statecallThemes: Common topics from call analysissentimentDistribution: Customer sentiment breakdown
GET
/
analytics
Get analytics
curl --request GET \
--url https://app.freyavoice.ai/api/v2/analytics \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.freyavoice.ai/api/v2/analytics"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.freyavoice.ai/api/v2/analytics', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.freyavoice.ai/api/v2/analytics",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.freyavoice.ai/api/v2/analytics"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.freyavoice.ai/api/v2/analytics")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.freyavoice.ai/api/v2/analytics")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"message": "<string>",
"result": {
"workspaceId": "<string>",
"timeRange": {
"start": "<string>",
"end": "<string>"
},
"granularity": "hour",
"generatedAt": "<string>",
"summary": {
"totalCalls": 123,
"answeredCalls": 123,
"voicemailCalls": 123,
"totalDurationSec": 123,
"averageDurationSec": 123,
"answerRate": 123
},
"timeSeries": [
{
"date": "<string>",
"totalCalls": 123,
"answeredCalls": 123,
"averageDurationSec": 123,
"sentimentCounts": {
"very-unhappy": 123,
"unhappy": 123,
"neutral": 123,
"happy": 123,
"very-happy": 123
}
}
],
"endedReasons": [
{
"reason": "<string>",
"count": 123
}
],
"topCalls": [
{
"callId": "<string>",
"customerNumber": "<string>",
"durationSec": 123,
"startedAt": "<string>",
"status": "<string>",
"endedReason": "<string>"
}
],
"geoDistribution": {
"countries": [
{
"countryCode": "<string>",
"countryName": "<string>",
"callCount": 123
}
],
"states": [
{
"countryCode": "<string>",
"countryName": "<string>",
"stateCode": "<string>",
"stateName": "<string>",
"callCount": 123
}
]
},
"callThemes": [
{
"theme": "<string>",
"count": 123
}
],
"sentimentDistribution": [
{
"bucket": "very-unhappy",
"count": 123
}
]
}
}
}{
"success": false,
"data": {
"message": "<string>",
"result": "<unknown>"
}
}{
"success": false,
"data": {
"message": "<string>",
"result": "<unknown>"
}
}{
"success": false,
"data": {
"message": "<string>",
"result": "<unknown>"
}
}{
"success": false,
"data": {
"message": "<string>",
"result": "<unknown>"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Workspace ID
Start date for analytics period (ISO format)
End date for analytics period (ISO format)
Filter by phone number ID
Filter by assistant/agent ID
Filter by multiple assistant IDs
Time series granularity: hour, day, or month
Available options:
hour, day, month Specific metrics to return (JSON array)
Available options:
summary, timeSeries, endedReasons, topCalls, geoDistribution, callThemes, sentimentDistribution IANA timezone for date calculations
Required string length:
2 - 64Filter by call status (JSON array)
Minimum string length:
1Filter by call type: inbound, outbound, web (JSON array)
Available options:
inbound, outbound, web, inboundPhoneCall, outboundPhoneCall, webCall