find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/digitail:digitail-reports-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Digitail Reports API
  description: Digitail API
  contact:
    email: developer@digitail.io
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  version: 1.0.0
servers:
- url: https://developer.digitail.io
  description: Sandbox server (uses test data)
- url: https://vet.digitail.io
  description: Production server (uses live data)
security:
- passport: []
- Bearer: []
tags:
- name: Reports
paths:
  /api/v1/pets-report/aggregated:
    get:
      tags:
      - Reports
      summary: Get aggregated report about Patients
      description: 'Permissions needed: NONE

        Returns aggregated reports about patients in the currently authenticated user''s clinic'
      parameters:
      - name: without_archived
        in: query
        description: if true, will exclude archived patients from the report
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      species:
                        type: object
                        properties:
                          chart:
                            type: object
                            properties:
                              labels:
                                type: array
                                items:
                                  type: string
                              series:
                                type: array
                                items:
                                  type: number
                          breakdown:
                            type: array
                            items:
                              type: object
                              properties:
                                label:
                                  type: string
                                amount:
                                  type: integer
                                value:
                                  type: string
                      breeds:
                        type: object
                        properties:
                          chart:
                            type: object
                            properties:
                              labels:
                                type: array
                                items:
                                  type: string
                              series:
                                type: array
                                items:
                                  type: number
                          breakdown:
                            type: array
                            items:
                              type: object
                              properties:
                                label:
                                  type: string
                                amount:
                                  type: integer
                                value:
                                  type: string
                                species_id:
                                  type: integer
                      age:
                        type: object
                        properties:
                          chart:
                            type: object
                            properties:
                              labels:
                                type: array
                                items:
                                  type: string
                              series:
                                type: array
                                items:
                                  type: number
                          breakdown:
                            type: array
                            items:
                              type: object
                              properties:
                                label:
                                  type: string
                                amount:
                                  type: integer
                                value:
                                  type: string
                      reproductive_status:
                        type: object
                        properties:
                          chart:
                            type: object
                            properties:
                              labels:
                                type: array
                                items:
                                  type: string
                              series:
                                type: array
                                items:
                                  type: number
                          breakdown:
                            type: array
                            items:
                              type: object
                              properties:
                                label:
                                  type: string
                                amount:
                                  type: integer
                                value:
                                  type: string
        '400':
          $ref: '#/paths/~1api~1v1~1pets/get/responses/400'
        '401':
          $ref: '#/paths/~1api~1v1~1pets/get/responses/401'
        '403':
          $ref: '#/paths/~1api~1v1~1pets/get/responses/403'
        '429':
          $ref: '#/paths/~1api~1v1~1pets/get/responses/429'
      operationId: getApiV1PetsReportAggregated
      x-operation-id-source: derived
  /api/v1/reports/appointments:
    get:
      tags:
      - Reports
      summary: Get appointments report
      parameters:
      - $ref: '#/paths/~1api~1v1~1pets/get/parameters/0'
      - name: filter[vet_id]
        description: Filter by vet ID
        in: query
        required: false
        schema:
          type: string
      - name: filter[source]
        description: '`0` - Clinic `1` - Web `2` - App

          '
        in: query
        required: false
        schema:
          type: string
      - name: filter[status]
        in: query
        required: false
        schema:
          type: string
          enum:
          - created_by_vet
          - requested_by_user
          - rescheduled_by_vet
          - requested_reschedule_by_user
          - confirmed
          - canceled_by_user
          - canceled_by_vet
          - auto_created
          - no_show
          - pending
          - completed
      - name: filter[date_between]
        in: query
        description: 'Dates Between (start_date, end_date), format: YYYY-MM-DD'
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      - name: filter[visit_type_id]
        description: Filter by visit type ID
        in: query
        required: false
        schema:
          type: string
      - name: filter[has_payment_deposits]
        in: query
        description: 'Return only the appointments that have or not payment deposits(Ex: <i>0 - false; 1 - true;</i>)'
        required: false
        schema:
          type: boolean
      - name: sort
        in: query
        description: 'Sorting(ex: ''datetime_start_utc'', ''datetime_end_utc'', ''clinic_id'', ''vet_id'')'
        required: false
        schema:
          type: string
      - $ref: '#/paths/~1api~1v1~1tags/get/parameters/5'
      - $ref: '#/paths/~1api~1v1~1pets/get/parameters/11'
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      title: Appointment
                      properties:
                        id:
                          type: integer
                          example: 1
                        datetime_start_utc:
                          type: string
                          format: date-time
                          example: '2023-12-01T09:00:00.000000Z'
                        datetime_end_utc:
                          type: string
                          format: date-time
                          example: '2023-12-01T10:00:00.000000Z'
                        status:
                          type: string
                          enum:
                          - created_by_vet
                          - requested_by_user
                          - rescheduled_by_vet
                          - requested_reschedule_by_user
                          - confirmed
                          - canceled_by_user
                          - canceled_by_vet
                          - auto_created
                          - no_show
                          - pending
                          - completed
                        source:
                          type: integer
                          description: '`0` - Vet `1` - Pet Parent `2` - Mobile

                            '
                        pet:
                          type: object
                          title: Pet
                          properties:
                            id:
                              type: integer
                              example: 1
                            nickname:
                              type: string
                              example: Ben
                            species:
                              $ref: '#/paths/~1api~1v1~1species/get/responses/200/content/application~1json/schema/properties/data/items'
                            breed:
                              $ref: '#/paths/~1api~1v1~1breeds/get/responses/200/content/application~1json/schema/properties/data/items'
                            pet_parents:
                              type: array
                              items:
                                type: object
                                title: Pet Parent
                                properties:
                                  id:
                                    type: integer
                                  name:
                                    type: string
                                  last_name:
                                    type: string
                                  phone:
                                    type: string
                                  address:
                                    type: string
                                  address_2:
                                    type: string
                                  email:
                                    type: string
                                  chat_uid:
                                    type:
                                    - string
                                    - 'null'
                            age:
                              type: string
                            archive:
                              type:
                              - object
                              - 'null'
                              title: ReportPetArchive
                              description: Archive details for an archived pet, in the shape returned by the report resources (App\Http\Resources\Reports\Shared\PetArchiveResource). Drives the frontend archived badge / legacy name emoji.
                              properties:
                                type:
                                  type: string
                                  enum:
                                  - Deceased
                                  - Moved away
                                  - Change of owner
                                  - Other
                                  example: Deceased
                                archived_at:
                                  type:
                                  - string
                                  - 'null'
                                  example: '2026-01-12T00:00:00.000000Z'
                                reason:
                                  type:
                                  - string
                                  - 'null'
                                  example: The patient was archived because...
                            patient:
                              type:
                              - object
                              - 'null'
                              properties:
                                id:
                                  type: integer
                                clinic_id:
                                  type: integer
                                number:
                                  type: string
                        clinic:
                          type: object
                          title: Clinic
                          properties:
                            id:
                              type: integer
                              example: 1
                            name:
                              type: string
                        vet:
                          type: object
                          title: Vet
                          properties:
                            id:
                              type: integer
                              example: 1
                            first_name:
                              type: string
                            last_name:
                              type: string
                            job_title:
                              type: string
                        payment_deposits:
                          type: object
                          title: PaymentDeposit
                          properties:
                            id:
                              type: integer
                            value:
                              type: number
                              format: float
                            paid_value:
                              type: number
                              format: float
                            status:
                              type: string
                              enum:
                              - paid
                              - pending
                              - partially_paid
                            appointments:
                              type: array
                              items:
                                $ref: '#/paths/~1api~1v1~1reports~1appointments/get/responses/200/content/application~1json/schema/properties/data/items'
                            payment_links:
                              type: array
                              items:
                                type: object
                                title: PaymentLink
                                properties:
                                  id:
                                    type: integer
                                  amount:
                                    type: string
                                    format: float
                                  url:
                                    type: string
                        guest:
                          type: boolean
                          example: false
                        pet_name:
                          type:
                          - string
                          - 'null'
                          example: null
                        pet_parent_name:
                          type:
                          - string
                          - 'null'
                          example: null
                        pet_parent_email:
                          type:
                          - string
                          - 'null'
                          example: null
                        pet_parent_phone:
                          type:
                          - string
                          - 'null'
                          example: null
                        revenue:
                          type: string
                          format: float
                        utm_source:
                          type:
                          - string
                          - 'null'
                        services:
                          type:
                          - array
                          - 'null'
                          items:
                            type: object
                            properties:
                              id:
                                type: integer
                              name:
                                type: string
                        last_confirmed_at:
                          type:
                          - string
                          - 'null'
                          format: date-time
                          example: '2023-12-01T09:00:00.000000Z'
                        confirmed_by:
                          type:
                          - string
                          - 'null'
                          enum:
                          - client
                          - staff
                          example: client
                        confirmation_source:
                          type:
                          - string
                          - 'null'
                          enum:
                          - phone
                          - sms_reminder
                          - email_reminder
                          - pet_portal
                          - public_calendar
                          - crm
                          example: sms_reminder
        '403':
          $ref: '#/paths/~1api~1v1~1pets/get/responses/403'
        '422':
          $ref: '#/paths/~1api~1v1~1plans/get/responses/422'
      operationId: getApiV1ReportsAppointments
      x-operation-id-source: derived
  /api/v1/reports/appointments/export-csv:
    get:
      tags:
      - Reports
      summary: Get appointments report as CSV
      parameters:
      - $ref: '#/paths/~1api~1v1~1pets/get/parameters/0'
      - name: filter[vet_id]
        description: Filter by vet ID
        in: query
        required: false
        schema:
          type: string
      - name: filter[source]
        description: '`0` - Clinic `1` - Web `2` - App

          '
        in: query
        required: false
        schema:
          type: string
      - name: filter[status]
        description: '`0` - Pending `1` - Pending Client Approval `2` - Pending Clinic Approval `3` - Rescheduled Clinic Approval `4` - Rescheduled Client Approval `5` - Confirmed `6` - Canceled By Client `7` - Canceled By Clinic'' `8` - Automatically Created'' `9` - No Show

          '
        in: query
        required: false
        schema:
          type: string
      - name: filter[date_between]
        in: query
        description: 'Dates Between (start_date, end_date), format: YYYY-MM-DD'
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      - name: filter[visit_type_id]
        description: Filter by visit type ID
        in: query
        required: false
        schema:
          type: string
      - name: sort
        in: query
        description: 'Sorting(ex: ''datetime_start_utc'', ''datetime_end_utc'', ''clinic_id'', ''vet_id'')'
        required: false
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          content:
            application/csv: {}
        '202':
          description: Accepted
          content:
            application/json: {}
        '403':
          $ref: '#/paths/~1api~1v1~1pets/get/responses/403'
        '422':
          $ref: '#/paths/~1api~1v1~1plans/get/responses/422'
      operationId: getApiV1ReportsAppointmentsExportCsv
      x-operation-id-source: derived
components:
  securitySchemes:
    passport:
      type: oauth2
      description: Laravel passport oauth2 security.
      flows:
        authorizationCode:
          authorizationUrl: https://developer.digitail.io/oauth/authorize
          tokenUrl: https://developer.digitail.io/oauth/token
          refreshUrl: https://developer.digitail.io/oauth/token
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
x-provenance:
  method: harvested
  publisher: Digitail
  source: https://developer.digitail.io/api-docs
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)