> ## Documentation Index > Fetch the complete documentation index at: https://docs.connectadesk.com/llms.txt > Use this file to discover all available pages before exploring further. # Get consolidated metrics > Accepts the same filters as the dashboard screen. ## OpenAPI ````yaml /api-reference/openapi.en.yaml get /reports/dashboard openapi: 3.0.3 info: title: Connecta DESK Public API version: 1.0.0 description: >- Public API of Connecta DESK, available at `/api/v1`. Access uses a token generated in the tokens module. Each token has permissions per **module × method**, and every list read is paginated. ## Authentication ``` Authorization: Bearer sk_live_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6 ``` The token belongs to a **company**, not to a user. The company used is always the token's company, so sending `companyId` in the body has no effect. A missing, invalid, revoked or expired token gets the same `401` response. ## Order of checks 1. **token** → `401` 2. **active company** → `403` 3. **API enabled on the plan** → `403 ERR_API_NOT_ENABLED` (does not apply to on-premise) 4. **company rate limit** → `429` 5. **token permission** → `403 ERR_API_FORBIDDEN_SCOPE` ## User ids Every user id in the API is the user's id **in this company**, the same one `GET /users` returns. This applies to what the API returns (`user.id`, `assignedTo.id`, `userCreated.id`) and to what it accepts (`userId`, `userIds`, `assignedToUserId` and the `{id}` in user routes). The same person can work in several companies, with a different name and profile in each one, and has a different id in each company. An id that does not belong to this company returns `404`, with the same message as an id that does not exist. ## Pagination Every list `GET` is paginated. The `meta` contains only `page`, `perPage` and `hasMore`, without the total number of records. To go through everything, keep advancing `page` while `hasMore` is `true`. ## Idempotency Optional on `POST`/`PUT`, through the `Idempotency-Key` header. If you repeat the call with the same key and the same body, you get the stored response (with `Idempotent-Replay: true`). With the same key and a different body, the response is `409`. servers: - url: https://api.connectadesk.com/api/v1 description: Production security: - apiToken: [] tags: - name: contacts description: Contact records, extra fields and marketing source. - name: tickets x-displayName: Tickets description: Opening, transferring, closing and wrap-up of tickets. - name: messages description: Asynchronous sending and reading of messages. - name: tags description: Tags and their link to tickets. - name: queues description: Service queues and their agents. - name: wrapups description: Wrap-up types. - name: users description: Agents and administrators. - name: schedules description: Scheduled messages. - name: quick-messages description: Quick replies. - name: campaigns description: Bulk sending. - name: crm description: Boards, stages, cards and metrics. - name: channels description: Channels (read only). - name: reports description: Reports and dashboards. - name: products description: Product catalog, categories and sales performance. - name: custom-fields description: Custom fields for contacts and cards, plus company-wide global variables. - name: profiles description: Company permission profiles (read only). - name: webchat description: >- Native webchat from your own system: open a visitor session, send and read messages. The token needs the `webchat` scope (GET and POST). paths: /reports/dashboard: get: tags: - reports summary: Get consolidated metrics description: Accepts the same filters as the dashboard screen. responses: '200': description: OK content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/ReportDashboard' components: schemas: ReportDashboard: type: object description: >- Ticket report for the period, with the company counters and one row per agent. properties: counters: type: object description: Counters for the entire filtered set. properties: avgSupportTime: type: number nullable: true description: Average handling time, in minutes. example: 12.4 avgWaitTime: type: number nullable: true description: Average waiting time in the queue, in minutes. example: 3.1 supportHappening: type: integer description: >- Tickets that are `open` right now. This number ignores the period filter. example: 18 supportPending: type: integer description: Tickets that are `pending` right now. example: 5 supportFinished: type: integer description: Tickets closed during the period. example: 640 leads: type: integer description: >- Contacts with exactly one ticket in the period, that is, those who showed up for the first time. example: 212 attendants: type: array description: >- One row per agent in the company, including those who handled no tickets in the period (with zeroed values). items: $ref: '#/components/schemas/ReportDashboardAttendant' ReportDashboardAttendant: type: object description: One row of the ticket report, with the figures for one agent. properties: id: type: integer description: User id in this company, the same one returned by `GET /users`. example: 3 name: type: string example: Marina Alves avgSupportTime: type: number description: Average handling time, in minutes. example: 12.4 tickets: type: integer description: The agent's tickets within the applied filters. example: 84 rating: type: number description: >- Average rating the agent received. `0` when the agent has not been rated. example: 4.6 online: type: boolean description: Whether the agent is logged in to the dashboard right now. example: true securitySchemes: apiToken: type: http scheme: bearer description: API token in the `sk_live_…` format. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.