Skip to main content
GET
Get Aimee performance overview

Authorizations

Authorization
string
header
required

Bearer access token issued by Peerlogic.

Query Parameters

practice_ids
string

Comma-separated list of practice IDs to filter statistics by specific practices. Example: '9AxAFr4n63uputNXKo89x1,9AxAFr4n63uputNXKo89x2'

organization_id
string

Organization ID to filter statistics within a specific organization. Example: '9AxAFr4n63uputNXKo89x1'

region_id
string

Region ID to filter statistics by a specific region. Example: '9AxAFr4n63uputNXKo89x1'

Search term to filter conversations by message content. Example: 'follow-up'

caller_name
string

Filter conversations by caller name. Example: 'John Doe'

start_time
string

Filter conversations by start time. Example: '2024-09-25T08:00:00Z'

non_practice_participant_type
enum<string>

Filter conversations by non-practice participant type. Example: 'new_patient'.

Available options:
new_patient,
existing_patient
custom_filter
enum<string>

Apply custom filters to conversations. Example: 'aimee_booked'.

Available options:
all_conversations,
patients_engaged,
action_required,
aimee_booked,
aimee_rescheduled,
aimee_cancelled,
aimee_confirmed,
staff_intervened,
staff_booked,
staff_rescheduled,
staff_cancelled,
staff_confirmed

Response

Aimee overview statistics.

conversations_initiated
integer
patients_engaged
integer
booked_revenue
number
booked_opportunities
integer
booked_opportunities_percentage
number
rescheduled_opportunities
integer
rescheduled_opportunities_percentage
number
cancelled_opportunities
integer
cancelled_opportunities_percentage
number
staff_intervened_opportunities
integer
staff_intervened_opportunities_percentage
number
escalated_opportunities
integer
escalated_opportunities_percentage
number
total_hand_offs
integer