Skip to main content
GET
/
v1
/
analytics
/
overview
cURL
curl --request GET \
  --url https://client-api.salesfinity.co/v1/analytics/overview \
  --header 'x-api-key: <api-key>'
import requests

url = "https://client-api.salesfinity.co/v1/analytics/overview"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://client-api.salesfinity.co/v1/analytics/overview', 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://client-api.salesfinity.co/v1/analytics/overview",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$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://client-api.salesfinity.co/v1/analytics/overview"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://client-api.salesfinity.co/v1/analytics/overview")
  .header("x-api-key", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://client-api.salesfinity.co/v1/analytics/overview")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "total_calls": {
    "value": 123,
    "growth_rate": 123
  },
  "total_inbound_calls": {
    "value": 123,
    "growth_rate": 123
  },
  "connected_calls": {
    "value": 123,
    "growth_rate": 123
  },
  "conversations": {
    "value": 123,
    "growth_rate": 123
  },
  "connection_rate": {
    "value": 123,
    "growth_rate": 123
  },
  "conversation_rate": {
    "value": 123,
    "growth_rate": 123
  },
  "avg_calls_per_day": {
    "value": 123,
    "growth_rate": 123
  },
  "total_call_duration": {
    "value": 123,
    "growth_rate": 123
  },
  "total_meetings_set": {
    "value": 123,
    "growth_rate": 123
  },
  "total_follow_up_tasks": {
    "value": 123,
    "growth_rate": 123
  },
  "unique_contacts": {
    "value": 123,
    "growth_rate": 123
  },
  "unique_companies": {
    "value": 123,
    "growth_rate": 123
  }
}
Returns aggregated analytics metrics with growth rates compared to the previous period. Use this endpoint to get a high-level summary of call performance including total calls, connected calls, conversations, meetings set, and follow-up tasks.

Query Parameters

  • start_date (optional, date): Start date for the analytics period. Accepts ISO 8601 format. If omitted, defaults to 7 days before end_date.
    • Examples:
      • 2024-01-01T00:00:00.000Z - ISO 8601 with UTC timezone
      • 2024-01-01 - Simple date format (YYYY-MM-DD)
      • 2024-01-01T00:00:00-05:00 - ISO 8601 with timezone offset
  • end_date (optional, date): End date for the analytics period. Accepts ISO 8601 format. If omitted, defaults to the current date.
    • Examples:
      • 2024-01-31T23:59:59.999Z - ISO 8601 with UTC timezone
      • 2024-01-31 - Simple date format (YYYY-MM-DD)
      • 2024-01-31T23:59:59-05:00 - ISO 8601 with timezone offset
  • user_ids (optional, array of strings): Filter by specific user IDs.
    • Example: ["64d2b3f2c4e3a6b8f2d9e1a7"]
  • disposition_ids (optional, array of numbers): Filter by disposition IDs (1=Meeting Set, 2=No Longer With Company, 3=Not Interested, etc.).
    • Example: [1, 2, 3]
  • timezone (optional, string): Timezone for date calculations.
    • Example: America/New_York

Response

Each metric is returned as an object of the form { "value": number, "growth_rate": number }, where growth_rate is the percentage change compared to the previous period of equal length. Metrics included:
  • total_calls - Total number of calls made
  • total_inbound_calls - Total number of inbound calls
  • connected_calls - Calls that connected (answered by human, disposition < 10)
  • conversations - Connected calls with a meeting set or duration >= 60s
  • connection_rate - connected_calls / total_calls (percentage)
  • conversation_rate - conversations / connected_calls (percentage)
  • avg_calls_per_day - Average calls per active day
  • total_call_duration - Total call duration in seconds
  • total_meetings_set - Calls with disposition ID = 1 (Meeting Set)
  • total_follow_up_tasks - Number of follow-up tasks created
  • unique_contacts - Number of distinct contacts called
  • unique_companies - Number of distinct companies called
Example:
{
  "total_calls": { "value": 1240, "growth_rate": 12.5 },
  "total_inbound_calls": { "value": 85, "growth_rate": -3.1 },
  "connected_calls": { "value": 430, "growth_rate": 8.0 },
  "conversations": { "value": 96, "growth_rate": 5.2 },
  "connection_rate": { "value": 34.7, "growth_rate": 1.4 },
  "conversation_rate": { "value": 22.3, "growth_rate": -0.8 },
  "avg_calls_per_day": { "value": 62, "growth_rate": 4.0 },
  "total_call_duration": { "value": 51840, "growth_rate": 9.7 },
  "total_meetings_set": { "value": 41, "growth_rate": 10.0 },
  "total_follow_up_tasks": { "value": 58, "growth_rate": 6.3 },
  "unique_contacts": { "value": 512, "growth_rate": 7.1 },
  "unique_companies": { "value": 233, "growth_rate": 3.9 }
}

Authorizations

x-api-key
string
header
required

Query Parameters

start_date
string<date>

Start date for the analytics period (ISO 8601). Examples: 2024-01-01, 2024-01-01T00:00:00.000Z, 2024-01-01T00:00:00-05:00. If omitted, defaults to 7 days before end_date.

end_date
string<date>

End date for the analytics period (ISO 8601). Examples: 2024-01-31, 2024-01-31T23:59:59.999Z, 2024-01-31T23:59:59-05:00. If omitted, defaults to the current date.

user_ids
string[]

Filter by specific user IDs

disposition_ids
integer[]

Filter by disposition IDs (1-14)

timezone
string

IANA timezone for date calculations (e.g., America/New_York)

Response

200 - application/json

Analytics overview retrieved successfully

total_calls
object
required
total_inbound_calls
object
required
connected_calls
object
required
conversations
object
required
connection_rate
object
required
conversation_rate
object
required
avg_calls_per_day
object
required
total_call_duration
object
required
total_meetings_set
object
required
total_follow_up_tasks
object
required
unique_contacts
object
required
unique_companies
object
required