> ## Documentation Index > Fetch the complete documentation index at: https://docs.peerlogic.com/llms.txt > Use this file to discover all available pages before exploring further. # Get Aimee action-required reasons > Retrieve Reasons for Action Required with Percentage Values. **Sample Request:** ``` GET /api/aimee-reason-action-required/?practice_ids=9AxAFr4n63uputNXKo89x1,9AxAFr4n63uputNXKo89x2&organization_id=9AxAFr4n63uputNXKo89x1®ion_id=9AxAFr4n63uputNXKo89x1 ``` ## OpenAPI ````yaml /openapi/peerlogic-api.json get /api/aimee-reason-action-required/ openapi: 3.1.0 info: title: Peerlogic API version: 1.0.0 description: >- Customer-facing API reference for accessing Peerlogic calls, insights, conversations, tasks, opportunities, subscriptions, and events. servers: - url: https://api.prod.peerlogic.com description: Production security: [] tags: - name: Authentication description: Obtain an access token for authenticated API requests. - name: Call insights description: Call records and aggregate performance insights. - name: Transcripts description: Transcripts, summaries, sentiment, pauses, and call-purpose details. - name: Aimee description: Aimee activity, configuration, and performance insights. - name: Conversations description: Conversation records, messages, and conversation actions. - name: Tasks description: Customer tasks and task workflow actions. - name: Opportunities description: Opportunities and follow-up reporting. - name: Subscriptions and events description: >- Create and manage event subscriptions, then inspect event records and analytics. For the complete webhook delivery flow, see the Webhooks and subscriptions guide. - name: Organizations and practices description: >- Discover the organizations and practices available to the authenticated account. - name: Contacts and patients description: Find contacts and patients for caller recognition and related workflows. - name: Appointments description: Retrieve appointment history and upcoming appointments for a patient. - name: Messaging description: Send practice messages, including missed-call recovery outreach. - name: Call recordings description: Retrieve recording metadata and secure audio URLs for calls. paths: /api/aimee-reason-action-required/: parameters: [] get: tags: - Aimee summary: Get Aimee action-required reasons description: >- Retrieve Reasons for Action Required with Percentage Values. **Sample Request:** ``` GET /api/aimee-reason-action-required/?practice_ids=9AxAFr4n63uputNXKo89x1,9AxAFr4n63uputNXKo89x2&organization_id=9AxAFr4n63uputNXKo89x1®ion_id=9AxAFr4n63uputNXKo89x1 ``` operationId: aimee-reason-action-required_list parameters: - name: practice_ids in: query description: >- Comma-separated list of practice IDs to filter reasons by specific practices. Example: '9AxAFr4n63uputNXKo89x1,9AxAFr4n63uputNXKo89x2' required: false schema: type: string - name: organization_id in: query description: >- Organization ID to filter reasons within a specific organization. Example: '9AxAFr4n63uputNXKo89x1' required: false schema: type: string - name: region_id in: query description: >- Region ID to filter reasons by a specific region. Example: '9AxAFr4n63uputNXKo89x1' required: false schema: type: string - name: search in: query description: >- Search term to filter conversations by message content. Example: 'follow-up' required: false schema: type: string - name: caller_name in: query description: 'Filter conversations by caller name. Example: ''John Doe''' required: false schema: type: string - name: start_time in: query description: 'Filter conversations by start time. Example: ''2024-09-25T08:00:00Z''' required: false schema: type: string - name: non_practice_participant_type in: query description: >- Filter conversations by non-practice participant type. Example: 'new_patient'. required: false schema: type: string enum: - new_patient - existing_patient - name: responsive_outreach_status in: query description: >- Filter conversations by responsive outreach status. Example: 'working_aimee'. required: false schema: type: string enum: - working_aimee - working_agent - escalated - not_applicable - resolved_by_aimee - resolved_by_agent - closed - name: responsive_outreach_escalation_type in: query description: >- Filter conversations by responsive outreach escalation. Example: 'aimee_initiated'. required: false schema: type: string enum: - 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 - name: custom_filter in: query description: 'Apply custom filters to conversations. Example: ''aimee_booked''.' required: false schema: type: string enum: - all_conversations - patients_engaged - action_required - aimee_booked - aimee_rescheduled - aimee_cancelled - aimee_confirmed - staff_intervened - staff_booked - staff_rescheduled - staff_cancelled - staff_confirmed responses: '200': description: >- A list of reasons for action required with their respective percentage values. content: application/json: schema: type: array items: type: object properties: reason_name: type: string enum: - working_aimee - working_agent - escalated - not_applicable - resolved_by_aimee - resolved_by_agent - closed value: type: number count: type: integer examples: response: value: - reason_name: resolved_by_agent value: 0.55 count: 3 - reason_name: not_applicable value: 15.69 count: 85 - reason_name: resolved_by_aimee value: 0.18 count: 1 - reason_name: escalated value: 81.75 count: 444 - reason_name: working_aimee value: 1.82 count: 10 '400': description: Bad Request - Invalid parameters. content: application/json: schema: $ref: '#/components/schemas/ValidationError' example: field_error: >- One of the following parameter must be provided [practice_ids, organization_id or region_id] '401': description: Authentication is required. content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' example: detail: '''Authorization'' header is required' security: - bearerAuth: [] components: schemas: ValidationError: title: Validation error type: object additionalProperties: true description: Validation details keyed by the invalid field or grouped under `errors`. AuthenticationError: title: Authentication error type: object additionalProperties: true required: - detail properties: detail: type: string description: Why authentication failed. securitySchemes: bearerAuth: type: http scheme: bearer description: Bearer access token issued by Peerlogic. ```` ## Related topics - [Get action-required conversation count](/peerlogic-api-reference/aimee/get-action-required-conversation-count.md) - [Get Aimee performance overview](/peerlogic-api-reference/aimee/get-aimee-performance-overview.md) - [Get call outcome reason](/peerlogic-api-reference/transcripts/get-call-outcome-reason.md) - [Get Aimee performance by practice](/peerlogic-api-reference/aimee/get-aimee-performance-by-practice.md) - [Get call](/peerlogic-api-reference/call-insights/get-call.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.