> ## 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 real-time status

> Shows open and waiting tickets and the agents available right now.



## OpenAPI

````yaml /api-reference/openapi.en.yaml get /reports/dashboard/now
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/now:
    get:
      tags:
        - reports
      summary: Get real-time status
      description: Shows open and waiting tickets and the agents available right now.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/ReportDashboardNow'
components:
  schemas:
    ReportDashboardNow:
      type: object
      description: >-
        Snapshot of customer service right now. Each section is a list of
        aggregated rows. The data can be up to 150 seconds behind, so two
        requests in a row may return the same numbers.
      properties:
        allInfo:
          type: array
          description: Overall company counters. A single row.
          items:
            type: object
            properties:
              total:
                type: integer
                description: Tickets within the applied filters.
                example: 940
              unique_contacts:
                type: integer
                description: Contacts who showed up for the first time today.
                example: 74
              total_chat_waiting:
                type: integer
                description: Tickets waiting for an agent, outside the chatbot.
                example: 5
              total_chat_in_service:
                type: integer
                description: Tickets being handled by a human agent.
                example: 18
              total_chat_bot:
                type: integer
                description: Tickets in a chatbot flow.
                example: 12
              total_nps:
                type: integer
                description: Tickets in a satisfaction survey.
                example: 3
              total_chat_finished:
                type: integer
                description: Closed tickets.
                example: 902
              total_outcoming:
                type: integer
                description: Tickets started by the company today.
                example: 140
              total_incoming:
                type: integer
                description: Tickets started by the contact today.
                example: 380
              total_chat_bot_wrapuped:
                type: integer
                description: >-
                  Tickets closed and given a wrap-up by the chatbot itself,
                  without going through an agent.
                example: 66
              time_average_first_answer_seconds:
                type: number
                nullable: true
                description: Average time to first response, in seconds.
                example: 92.4
              time_average_human_service_seconds:
                type: number
                nullable: true
                description: Average human handling time, in seconds.
                example: 744
              time_average_chatbot_service_seconds:
                type: number
                nullable: true
                description: Average time spent in the chatbot, in seconds.
                example: 130.5
        usersInfo:
          type: array
          description: One row per agent in the company.
          items:
            type: object
            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
              profile:
                type: string
                nullable: true
                description: Profile name in this company (`Owner` for the company owner).
                example: Atendente
              online:
                type: boolean
                example: true
              chats:
                type: integer
                description: The agent's tickets within the applied filters.
                example: 24
              count_chats_open:
                type: integer
                description: Open tickets assigned to the agent right now.
                example: 4
              count_chats_finished:
                type: integer
                description: Tickets closed by this agent.
                example: 20
              time_average_service_seconds:
                type: number
                nullable: true
                description: This agent's average handling time, in seconds.
                example: 690
        openChatsInfo:
          type: array
          description: >-
            Closed tickets, grouped in 5-minute buckets. This is the data behind
            the day's activity chart.
          items:
            type: object
            properties:
              total:
                type: integer
                description: Number of tickets in the bucket.
                example: 7
              time_group:
                type: string
                format: date-time
                description: Start of the 5-minute bucket.
                example: '2026-09-09T14:35:00.000Z'
        usersOnlineCount:
          type: array
          description: How many agents are online right now. Returned as a single row.
          items:
            type: object
            properties:
              count:
                type: integer
                example: 11
  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.