> ## Documentation Index > Fetch the complete documentation index at: https://docs-qa.interactly.ai/llms.txt > Use this file to discover all available pages before exploring further. # Get Appointments Dashboard ## OpenAPI ````yaml https://api-qa.interactly.ai/api-docs/integrations/api.json get /integrations/v2/resource-records/{integration_id}/appointments/statistics openapi: 3.1.0 info: title: Interactly API description: API for building interactly.ai services version: 1.1.0 contact: name: Interactly url: https://interactly.ai email: developers@interactly.ai servers: - url: https://api-qa.interactly.ai description: API Server security: [] paths: /integrations/v2/resource-records/{integration_id}/appointments/statistics: get: tags: - Integrations Resource Records V2 summary: Get Appointments Dashboard operationId: >- integrations_service_get_appointments_dashboard_v2_resource_records__integration_id__appointments_statistics_get parameters: - name: integration_id in: path required: true schema: type: string minLength: 24 maxLength: 24 pattern: ^[0-9a-f]{24}$ example: 5eb7cf5a86d9755df3a6c593 title: Integration Id - name: appointmentType in: query required: false schema: anyOf: - type: string - type: 'null' description: Filter statistics by appointment type title: Appointmenttype description: Filter statistics by appointment type - name: debug in: query required: false schema: type: boolean description: >- Enable debug mode to include additional logging for troubleshooting default: false title: Debug description: Enable debug mode to include additional logging for troubleshooting - name: size in: query required: false schema: type: integer minimum: 1 description: Number of items per page default: 300 title: Size description: Number of items per page - name: page in: query required: false schema: type: integer minimum: 1 description: Page number default: 1 title: Page description: Page number - name: search in: query required: false schema: anyOf: - type: string - type: 'null' description: Search keywords title: Search description: Search keywords - name: start in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' description: Filter by start time (ISO 8601 format) title: Start description: Filter by start time (ISO 8601 format) - name: end in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' description: Filter by end time (ISO 8601 format) title: End description: Filter by end time (ISO 8601 format) responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AppointmentsStatsResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - bearer: [] components: schemas: AppointmentsStatsResponse: properties: overview: $ref: '#/components/schemas/StatsOverview' title: Appointments Overview description: Overview of total appointments in the date range trends: items: $ref: '#/components/schemas/StatsTrend' type: array title: Appointments Trends description: >- List of appointment trends broken down by date, showing successful and failed counts source: items: $ref: '#/components/schemas/StatsSource' type: array title: Appointments Sources description: >- List of appointment sources with counts, showing where appointments originated utm_source: items: $ref: '#/components/schemas/StatsSource' type: array title: UTM Source description: >- Unique UTM source values with counts. Defaults to 'direct' when not set. utm_medium: items: $ref: '#/components/schemas/StatsSource' type: array title: UTM Medium description: >- Unique UTM medium values with counts. Defaults to 'not set' when not set. utm_campaign: items: $ref: '#/components/schemas/StatsSource' type: array title: UTM Campaign description: >- Unique UTM campaign values with counts. Defaults to 'not set' when not set. type: object required: - overview title: AppointmentsStatsResponse description: |- Response model for appointments dashboard data. Contains overview, trends, and source information for appointments. HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError StatsOverview: properties: total: type: integer minimum: 0 title: Total Count description: Total number of appointments/patients in the selected date range default: 0 type: object title: StatsOverview description: |- Model for appointment/patient overview data. Provides a summary of total count. StatsTrend: properties: _id: anyOf: - type: string format: date-time - type: 'null' title: Trend Date description: Date for this trend data (daily) successful: type: integer minimum: 0 title: Successful Count description: Number of successful appointments/patients for this date default: 0 failed: type: integer minimum: 0 title: Failed Count description: Number of failed appointments/patients for this date default: 0 type: object title: StatsTrend description: |- Model for appointment/patient trends over time. Contains daily breakdown of successful and failed records. StatsSource: properties: _id: anyOf: - type: string - type: 'null' title: Source Name description: Creation source of the appointments/patients count: type: integer minimum: 0 title: Source Count description: Number of appointments/patients from this source default: 0 type: object title: StatsSource description: |- Model for appointment/patient sources with counts. Groups records by their creation source. ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type type: object required: - loc - msg - type title: ValidationError securitySchemes: bearer: scheme: bearer bearerFormat: Bearer type: http description: >- Retrieve your API Key from [Dashboard API Keys Section](https://dashboard-qa.interactly.ai/api-keys). ````