> ## Documentation Index
> Fetch the complete documentation index at: https://docs.usereplier.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get automation flow analytics

> Returns, for an automation with a message flow, how many people entered it and each step's delivery outcomes and button taps. An automation without a flow is refused.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/workspaces/{workspace_id}/automations/{automation_id}/flow-analytics
openapi: 3.1.0
info:
  title: Replier API
  version: '1'
servers:
  - url: https://api.usereplier.com
security:
  - apiKey: []
paths:
  /v1/workspaces/{workspace_id}/automations/{automation_id}/flow-analytics:
    get:
      tags:
        - Automations
      summary: Get automation flow analytics
      description: >-
        Returns, for an automation with a message flow, how many people entered
        it and each step's delivery outcomes and button taps. An automation
        without a flow is refused.
      operationId: get_flow_analytics
      parameters:
        - name: workspace_id
          in: path
          required: true
          description: Workspace ID returned by `GET /v1/workspaces`
          schema:
            type: string
            format: uuid
            pattern: >-
              ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
        - name: automation_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            pattern: >-
              ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
        - name: days
          in: query
          required: false
          schema:
            default: 30
            anyOf:
              - type: number
                const: 7
              - type: number
                const: 30
              - type: number
                const: 90
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  workspace:
                    type: object
                    properties:
                      id:
                        type: string
                        format: uuid
                        pattern: >-
                          ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                      name:
                        type: string
                      kind:
                        type: string
                        enum:
                          - personal
                          - agency
                      role:
                        type: string
                        enum:
                          - owner
                          - admin
                          - member
                    required:
                      - id
                      - name
                      - kind
                      - role
                  automation:
                    type: object
                    properties:
                      id:
                        type: string
                        format: uuid
                        pattern: >-
                          ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                      name:
                        type: string
                    required:
                      - id
                      - name
                  period:
                    type: object
                    properties:
                      days:
                        type: integer
                        minimum: 1
                        maximum: 365
                      start:
                        type: string
                        format: date-time
                        pattern: >-
                          ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
                      end:
                        type: string
                        format: date-time
                        pattern: >-
                          ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
                    required:
                      - days
                      - start
                      - end
                  analytics:
                    type: object
                    properties:
                      entered:
                        description: >-
                          Unique people whose run started in the period,
                          including people still waiting at a gate.
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                      nodes:
                        type: array
                        items:
                          description: >-
                            Counts are unique people per channel account, not
                            messages.
                          type: object
                          properties:
                            node_id:
                              type: string
                            name:
                              description: >-
                                Current step name; null when the step was
                                removed.
                              type:
                                - string
                                - 'null'
                            reached:
                              type: integer
                              minimum: 0
                              maximum: 9007199254740991
                            sent:
                              type: integer
                              minimum: 0
                              maximum: 9007199254740991
                            failed:
                              type: integer
                              minimum: 0
                              maximum: 9007199254740991
                            pending:
                              description: Being processed now. Excludes gated.
                              type: integer
                              minimum: 0
                              maximum: 9007199254740991
                            gated:
                              description: >-
                                Waiting for the recipient to complete a gate
                                before this step's message is sent. Not a
                                failure or a backlog.
                              type: integer
                              minimum: 0
                              maximum: 9007199254740991
                            uncertain:
                              description: >-
                                Send attempted with an unknown outcome, so it
                                may have been delivered. Not retried
                                automatically, to avoid duplicate DMs.
                              type: integer
                              minimum: 0
                              maximum: 9007199254740991
                          required:
                            - node_id
                            - name
                            - reached
                            - sent
                            - failed
                            - pending
                            - gated
                            - uncertain
                      buttons:
                        type: array
                        items:
                          type: object
                          properties:
                            node_id:
                              type: string
                            button_id:
                              type: string
                            title:
                              description: >-
                                Current button title; null when the button was
                                removed.
                              type:
                                - string
                                - 'null'
                            type:
                              type: string
                              enum:
                                - web_url
                                - postback
                            destination:
                              type: string
                            people:
                              description: Unique people who clicked.
                              type: integer
                              minimum: 0
                              maximum: 9007199254740991
                            clicks:
                              description: Total clicks, including repeats.
                              type: integer
                              minimum: 0
                              maximum: 9007199254740991
                            delivered:
                              description: >-
                                Unique people this button was sent to; the
                                denominator for its click rate.
                              type: integer
                              minimum: 0
                              maximum: 9007199254740991
                          required:
                            - node_id
                            - button_id
                            - title
                            - type
                            - destination
                            - people
                            - clicks
                            - delivered
                    required:
                      - entered
                      - nodes
                      - buttons
                required:
                  - workspace
                  - automation
                  - period
                  - analytics
        default:
          $ref: '#/components/responses/Error'
components:
  responses:
    Error:
      description: Refused
      content:
        application/json:
          schema:
            type: object
            required:
              - error
            properties:
              error:
                type: object
                required:
                  - code
                  - message
                properties:
                  code:
                    type: string
                    description: >-
                      Why the request was refused, such as AUTOMATION_NOT_FOUND
                      or VERSION_CONFLICT. Other fields beside it give details.
                  message:
                    type: string
                    description: The same reason, in English.
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: A Replier API key (rpl_...).

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.