Skip to main content
GET
Get Aimee action-required reasons

Authorizations

Authorization
string
header
required

Bearer access token issued by Peerlogic.

Query Parameters

practice_ids
string

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

organization_id
string

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

region_id
string

Region ID to filter reasons 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
responsive_outreach_status
enum<string>

Filter conversations by responsive outreach status. Example: 'working_aimee'.

Available options:
working_aimee,
working_agent,
escalated,
not_applicable,
resolved_by_aimee,
resolved_by_agent,
closed
responsive_outreach_escalation_type
enum<string>

Filter conversations by responsive outreach escalation. Example: 'aimee_initiated'.

Available options:
aimee_initiated,
aimee_error,
user_initiated,
conversation_abandoned,
sms_failed,
insurance_not_accepted,
insurance_needs_verification,
prescription_refill_request,
patient_messaged_resolved_conversation,
user_stop_text_received,
aimee_hallucinated
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

A list of reasons for action required with their respective percentage values.

reason_name
enum<string>
Available options:
working_aimee,
working_agent,
escalated,
not_applicable,
resolved_by_aimee,
resolved_by_agent,
closed
value
number
count
integer