> ## 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 performance by practice

> Retrieve Aimee Overview Statistics By Practice.

**Sample Request:**
```
GET /api/aimee-overview-stats-by-practice/?practice_ids=9AxAFr4n63uputNXKo89x1,9AxAFr4n63uputNXKo89x2&organization_id=9AxAFr4n63uputNXKo89x1&region_id=9AxAFr4n63uputNXKo89x1&start_time=2024-01-10&end_time=2024-01-15
```



## OpenAPI

````yaml /openapi/peerlogic-api.json get /api/aimee-overview-stats-by-practice/
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-overview-stats-by-practice/:
    parameters: []
    get:
      tags:
        - Aimee
      summary: Get Aimee performance by practice
      description: >-
        Retrieve Aimee Overview Statistics By Practice.


        **Sample Request:**

        ```

        GET
        /api/aimee-overview-stats-by-practice/?practice_ids=9AxAFr4n63uputNXKo89x1,9AxAFr4n63uputNXKo89x2&organization_id=9AxAFr4n63uputNXKo89x1&region_id=9AxAFr4n63uputNXKo89x1&start_time=2024-01-10&end_time=2024-01-15

        ```
      operationId: aimee-overview-stats-by-practice_list
      parameters:
        - name: practice_ids
          in: query
          description: >-
            Comma-separated list of practice IDs to filter statistics by
            specific practices. Example:
            '9AxAFr4n63uputNXKo89x1,9AxAFr4n63uputNXKo89x2'
          required: false
          schema:
            type: string
        - name: organization_id
          in: query
          description: >-
            Organization ID to filter statistics within a specific organization.
            Example: '9AxAFr4n63uputNXKo89x1'
          required: false
          schema:
            type: string
        - name: region_id
          in: query
          description: >-
            Region ID to filter statistics by a specific region. Example:
            '9AxAFr4n63uputNXKo89x1'
          required: false
          schema:
            type: string
        - name: start_time
          in: query
          description: 'Filter conversations by start time. Example: ''2024-09-25'''
          required: false
          schema:
            type: string
        - name: end_time
          in: query
          description: 'Filter conversations by end time. Example: ''2024-12-25'''
          required: false
          schema:
            type: string
      responses:
        '200':
          description: Aimee overview statistics by practice.
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    practice_id:
                      type: string
                    practice_name:
                      type: string
                    conversations_initiated:
                      type: integer
                    engagements:
                      type: integer
                    booked_revenue:
                      type: number
                    booked:
                      type: integer
                    rescheduled:
                      type: number
                    cancelled:
                      type: integer
                    action_required:
                      type: number
                    staff_intervened:
                      type: integer
              examples:
                response:
                  value:
                    - practice_id: 9AxAFr4n63uputNXKo89x1
                      practice_name: Peerlogic
                      booked_revenue: 0
                      booked: 1
                      rescheduled: 1
                      cancelled: 1
                      action_required: 1
                      staff_intervened: 1
                      conversations_initiated: 1
                      engagements: 1
        '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 Aimee performance overview](/peerlogic-api-reference/aimee/get-aimee-performance-overview.md)
- [Get Aimee revenue overview](/peerlogic-api-reference/aimee/get-aimee-revenue-overview.md)
- [Get Aimee action-required reasons](/peerlogic-api-reference/aimee/get-aimee-action-required-reasons.md)
- [Get task performance overview](/peerlogic-api-reference/tasks/get-task-performance-overview.md)
- [Get opportunity performance overview](/peerlogic-api-reference/call-insights/get-opportunity-performance-overview.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.