> ## 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.

# List answered calls

> Returns answered-call booking and estimated-revenue metrics for the selected organization, region, or practices and date range. Set `overview_only=true` for one combined summary; otherwise results are grouped by practice and paginated.



## OpenAPI

````yaml /openapi/peerlogic-api.json get /api/calls/answered-calls/
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/calls/answered-calls/:
    parameters: []
    get:
      tags:
        - Call insights
      summary: List answered calls
      description: >-
        Returns answered-call booking and estimated-revenue metrics for the
        selected organization, region, or practices and date range. Set
        `overview_only=true` for one combined summary; otherwise results are
        grouped by practice and paginated.
      operationId: calls_answered-calls_list
      parameters:
        - $ref: '#/components/parameters/AnalyticsOrganizationId'
        - $ref: '#/components/parameters/AnalyticsRegionId'
        - $ref: '#/components/parameters/AnalyticsPracticeIds'
        - $ref: '#/components/parameters/AnalyticsStartDate'
        - $ref: '#/components/parameters/AnalyticsEndDate'
        - name: overview_only
          in: query
          description: >-
            Return one combined summary instead of a paginated practice
            breakdown.
          required: false
          schema:
            type: boolean
            default: false
        - $ref: '#/components/parameters/AnalyticsPage'
        - $ref: '#/components/parameters/AnalyticsPageSize'
      responses:
        '200':
          description: >-
            Answered-call metrics. The response shape depends on
            `overview_only`.
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/AnsweredCallMetrics'
                  - $ref: '#/components/schemas/PaginatedAnsweredCallMetrics'
              examples:
                by_practice:
                  value:
                    meta:
                      page: 1
                      page_total: 1
                      page_size: 25
                      results_total: 1
                    links:
                      previous: null
                      self: >-
                        https://api.prod.peerlogic.com/api/calls/answered-calls/?practice_ids=prc_example
                      next: null
                    results:
                      - total_appointments: 84
                        booked_calls: 51
                        captured_revenue: 38250
                        not_booked_calls: 33
                        potential_revenue: 24750
                        booked_calls_percentage: 60.71
                        not_booked_calls_percentage: 39.29
                        practice_id: prc_example
                        practice_name: Peerlogic Veterinary Center
                overview:
                  value:
                    total_appointments: 84
                    booked_calls: 51
                    captured_revenue: 38250
                    not_booked_calls: 33
                    potential_revenue: 24750
                    booked_calls_percentage: 60.71
                    not_booked_calls_percentage: 39.29
        '400':
          description: The scope 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:
  parameters:
    AnalyticsOrganizationId:
      name: organization_id
      in: query
      description: Include accessible practices in this organization.
      required: false
      schema:
        type: string
    AnalyticsRegionId:
      name: region_id
      in: query
      description: Include accessible practices assigned to this region.
      required: false
      schema:
        type: string
    AnalyticsPracticeIds:
      name: practice_ids
      in: query
      description: >-
        Comma-separated practice IDs. All requested practices must be accessible
        to the authenticated account.
      required: false
      schema:
        type: string
    AnalyticsStartDate:
      name: call_start_time_after
      in: query
      description: Include calls on or after this date, in YYYY-MM-DD format.
      required: false
      schema:
        type: string
        format: date
    AnalyticsEndDate:
      name: call_start_time_before
      in: query
      description: Include calls before this date, in YYYY-MM-DD format.
      required: false
      schema:
        type: string
        format: date
    AnalyticsPage:
      name: page
      in: query
      description: Page number, beginning with 1.
      required: false
      schema:
        type: integer
        minimum: 1
        default: 1
    AnalyticsPageSize:
      name: page_size
      in: query
      description: Number of results per page.
      required: false
      schema:
        type: integer
        minimum: 1
        maximum: 100
  schemas:
    AnsweredCallMetrics:
      type: object
      required:
        - total_appointments
        - booked_calls
        - captured_revenue
        - not_booked_calls
        - potential_revenue
        - booked_calls_percentage
        - not_booked_calls_percentage
      properties:
        total_appointments:
          type: integer
        booked_calls:
          type: integer
        captured_revenue:
          type: integer
        not_booked_calls:
          type: integer
        potential_revenue:
          type: integer
        booked_calls_percentage:
          type: number
          format: float
        not_booked_calls_percentage:
          type: number
          format: float
        practice_id:
          type: string
        practice_name:
          type: string
    PaginatedAnsweredCallMetrics:
      type: object
      required:
        - meta
        - links
        - results
      properties:
        meta:
          $ref: '#/components/schemas/PaginationMetadata'
        links:
          $ref: '#/components/schemas/PaginationLinks'
        results:
          type: array
          items:
            $ref: '#/components/schemas/AnsweredCallMetrics'
    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.
    PaginationMetadata:
      type: object
      required:
        - page
        - page_total
        - page_size
        - results_total
      properties:
        page:
          type: integer
        page_total:
          type: integer
        page_size:
          type: integer
        results_total:
          type: integer
    PaginationLinks:
      type: object
      required:
        - previous
        - self
        - next
      properties:
        previous:
          type:
            - string
            - 'null'
          format: uri
        self:
          type: string
          format: uri
        next:
          type:
            - string
            - 'null'
          format: uri
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Bearer access token issued by Peerlogic.

````

## Related topics

- [List calls](/peerlogic-api-reference/call-insights/list-calls.md)
- [List call purposes](/peerlogic-api-reference/transcripts/list-call-purposes.md)
- [List call sentiments](/peerlogic-api-reference/transcripts/list-call-sentiments.md)
- [List call outcomes](/peerlogic-api-reference/transcripts/list-call-outcomes.md)
- [List call pauses](/peerlogic-api-reference/transcripts/list-call-pauses.md)


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