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>'
{
  "total_calls": {
    "value": 123,
    "growth": 123
  },
  "connected_calls": {
    "value": 123,
    "growth": 123
  },
  "conversations": {
    "value": 123,
    "growth": 123
  },
  "meetings_set": {
    "value": 123,
    "growth": 123
  },
  "total_follow_up_tasks": {
    "value": 123,
    "growth": 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.
    • 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.
    • 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

Returns metrics with current values and growth percentages compared to the previous period of equal length. Metrics included:
  • total_calls - Total number of calls made
  • connected_calls - Calls that connected (answered by human, disposition < 10)
  • conversations - Connected calls with meeting set or duration >= 60s
  • meetings_set - Calls with disposition ID = 1 (Meeting Set)
  • total_follow_up_tasks - Number of follow-up tasks created

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
start_date
string<date>
required

Start date for the analytics period

​
end_date
string<date>
required

End date for the analytics period

​
user_ids
string[]

Filter by specific user IDs

​
disposition_ids
integer[]

Filter by disposition IDs (1-14)

Response

200 - application/json

Analytics overview retrieved successfully

​
total_calls
object
required
​
connected_calls
object
required
​
conversations
object
required
​
meetings_set
object
required
​
total_follow_up_tasks
object
required