> ## 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 automations report > Lists automation runs in progress. ## OpenAPI ````yaml /api-reference/openapi.en.yaml get /reports/automations 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/automations: get: tags: - reports summary: Get automations report description: Lists automation runs in progress. parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/perPage' - name: fromDate in: query description: >- Start of the period analysed. The day starts in your company's time zone. schema: type: string format: date-time example: '2026-09-01' - name: toDate in: query description: >- End of the period analysed. The day ends at 23:59:59 in your company's time zone. schema: type: string format: date-time example: '2026-09-30' - name: contact in: query description: Search by contact name or number. schema: type: string example: marina - name: automationIds in: query description: Automation ids, separated by commas. schema: type: string example: 12,15 - name: triggers in: query description: Trigger types, separated by commas. schema: type: string example: message,keyword - name: statuses in: query description: Conversation statuses, separated by commas. schema: type: string example: finished,abandoned - name: source in: query description: Source of the run. schema: type: string default: automatic example: automatic responses: '200': description: OK content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/AutomationReportRow' meta: $ref: '#/components/schemas/PageMeta' components: parameters: page: name: page in: query description: Page number, starting at 1. An invalid value is treated as 1. schema: type: integer minimum: 1 default: 1 example: 1 perPage: name: perPage in: query description: >- Number of items per page. The maximum depends on the environment (default 100). schema: type: integer minimum: 1 maximum: 100 default: 20 example: 50 schemas: AutomationReportRow: type: object description: >- A run of a Flow automation. The ids in this response come as text (string), not as numbers. properties: sessionId: type: string description: Identifier of the run. example: 9f2c1a70-31bd-4a4e-b0f2-17c6d3a91b55 automationId: type: string nullable: true description: Internal id of the automation. publicAutomationId: type: string nullable: true description: Public id of the automation, the same one shown in Flow. example: aut_7d21c9 automationName: type: string nullable: true example: Boas-vindas do site triggerType: type: string nullable: true description: What triggered the run. example: message_received triggerLabel: type: string nullable: true description: The same trigger, as display-ready text. example: Mensagem recebida startedAt: type: string format: date-time description: Start of the run. durationLabel: type: string description: >- Time elapsed since the start, as text, calculated at the time of the query. example: 2 h 14 min executionStatus: type: string description: State of the run as recorded in Flow, with no interpretation. example: running contactId: type: string nullable: true description: Id of the run's contact, as a string. example: '842' contactName: type: string nullable: true example: Maria Silva contactNumber: type: string nullable: true example: '5511987654321' ticketId: type: string nullable: true description: Id of the related ticket, when there is one. protocolId: type: string nullable: true description: Related protocol. conversationStatus: type: string nullable: true description: >- Status of the conversation tied to the run. Comes as `null` when the protocol has already been closed. blockId: type: string nullable: true description: Flow block where the run is currently stopped. blockLabel: type: string nullable: true description: Name of that block in the Flow editor. example: Aguarda resposta situation: type: string nullable: true description: >- Interpreted status of the run. Use this field to show the run's state to a person. example: Aguardando resposta do contato waitingFor: type: string nullable: true description: What the run is waiting for in order to continue. pausedBlockType: type: string nullable: true description: Type of the input block where the run stopped. resumeAt: type: string format: date-time nullable: true description: When the run resumes on its own, if a deadline is set. source: type: string nullable: true description: Source of the trigger. lastProgressAt: type: string format: date-time nullable: true description: Date of the last progress in the flow. isOverdue: type: boolean nullable: true description: >- Whether the `resumeAt` deadline has passed without the run continuing. example: false PageMeta: type: object required: - page - perPage - hasMore properties: page: type: integer example: 1 perPage: type: integer example: 20 hasMore: type: boolean description: Whether there are more records beyond this page. example: true example: page: 1 perPage: 20 hasMore: 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.