> ## 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 revenue overview > Returns missed-call recovery, Aimee engagement, booking, and estimated-revenue metrics for an organization. If the selected organization has no active Aimee-enabled practices, the response is marked as projected. ## OpenAPI ````yaml /openapi/peerlogic-api.json get /api/aimee/revenue-overview/ 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/revenue-overview/: parameters: [] get: tags: - Aimee summary: Get Aimee revenue overview description: >- Returns missed-call recovery, Aimee engagement, booking, and estimated-revenue metrics for an organization. If the selected organization has no active Aimee-enabled practices, the response is marked as projected. operationId: aimee_revenue-overview_list parameters: - name: organization_id in: query description: Organization ID. required: true schema: type: string - name: practice_id in: query description: >- Limit the overview to one or more eligible practices. Repeat this parameter for multiple practices. required: false schema: type: array items: type: string style: form explode: true - name: from_date in: query description: >- Start date in YYYY-MM-DD format. Defaults to a 31-day lookback when no dates are supplied. required: false schema: type: string format: date - name: to_date in: query description: End date in YYYY-MM-DD format. required: false schema: type: string format: date responses: '200': description: Aimee revenue and engagement overview. content: application/json: schema: type: object additionalProperties: true example: is_projected: false projected_assumptions: null date_range: start: '2026-08-01T00:00:00-07:00' end: '2026-09-01T00:00:00-07:00' periods: 1 period_length_days: 30 timezone: America/Phoenix organization_id: org_example practices_count: 4 org_total_practices_count: 4 avg_appointment_value: 750 calls: inbound_total: 420 inbound_with_opportunities: 96 missed_total: 61 missed_opportunities_total: 48 missed_opportunities_trailing_30d: 45 opportunities: active: 14 resolved_booked: 21 aimee_sms: conversations_initiated: 52 patients_engaged: 31 engagement_rate: 59.62 appointments_booked: 12 booking_rate: 38.71 booked_revenue: 9000 '400': description: The organization, practices, or date range is invalid. 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' '403': description: The authenticated account cannot access the requested practices. content: application/json: schema: $ref: '#/components/schemas/PermissionError' example: message: No permissions assigned to permit access to this endpoint. 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. PermissionError: title: Permission error type: object additionalProperties: false required: - message properties: message: type: string description: Why access was denied. 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 performance by practice](/peerlogic-api-reference/aimee/get-aimee-performance-by-practice.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) - [List answered calls](/peerlogic-api-reference/call-insights/list-answered-calls.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.