Skip to main content
GET
Get analytics overview
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:

Authorizations

x-api-key
string
header
required

Team-scoped API key generated in the Salesfinity dashboard under Settings -> Connections & API. A missing or invalid key returns HTTP 403.

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

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