Skip to main content
GET
/
v1
/
analytics
/
list-performance
cURL
curl --request GET \
  --url https://client-api.salesfinity.co/v1/analytics/list-performance \
  --header 'x-api-key: <api-key>'
{
  "totalCount": 123,
  "data": [
    {
      "_id": "<string>",
      "name": "<string>",
      "source": "<string>",
      "total_calls": 123,
      "connected_calls": 123,
      "conversations": 123,
      "meetings_set": 123,
      "good_quality_contacts": 123,
      "data_quality": 123,
      "owner": {
        "_id": "<string>",
        "first_name": "<string>",
        "last_name": "<string>",
        "email": "<string>"
      }
    }
  ],
  "page": 123,
  "limit": 123,
  "next": 123,
  "prev": 123
}
Returns call metrics grouped by contact list with pagination. Use this endpoint to analyze performance across different contact lists.

​
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
  • page (optional, number): Page number (default: 1).
    • Example: 1
  • limit (optional, number): Items per page (default: 10, max: 100).
    • Example: 10
  • search (optional, string): Search by list name.
    • Example: "sales"

​
Response

Returns a paginated list of contact list performance metrics. Metrics per list:
  • _id - Contact list ID
  • name - Contact list name
  • source - List source (e.g., “csv”, “crm”)
  • total_calls - Total calls made to contacts in this list
  • connected_calls - Connected calls
  • conversations - Meaningful conversations
  • meetings_set - Meetings set from this list
  • good_quality_contacts - Contacts with valid phone numbers
  • data_quality - Ratio of good quality contacts
  • owner - List owner information (id, name, email)

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)

​
page
integer
default:1

Page number

Required range: x >= 1
​
limit
integer
default:10

Items per page

Required range: 1 <= x <= 100
​
search
string

Search by list name

Response

200 - application/json

List performance retrieved successfully

​
totalCount
integer
required
​
data
object[]
required
​
page
integer
required
​
limit
integer
required
​
next
integer | null
​
prev
integer | null