> ## 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.

# Review a one-time automation run

> Returns a run's status and counts with the comments it matched: those a send would answer (eligible) first, then excluded, sent and failed ones with their reason.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/workspaces/{workspace_id}/one-time-automations/{one_time_automation_id}/runs/{run_id}
openapi: 3.1.0
info:
  title: Replier API
  version: '1'
servers:
  - url: https://api.usereplier.com
security:
  - apiKey: []
paths:
  /v1/workspaces/{workspace_id}/one-time-automations/{one_time_automation_id}/runs/{run_id}:
    get:
      tags:
        - One-time automations
      summary: Review a one-time automation run
      description: >-
        Returns a run's status and counts with the comments it matched: those a
        send would answer (eligible) first, then excluded, sent and failed ones
        with their reason.
      operationId: get_one_time_automation_run
      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: one_time_automation_id
          in: path
          required: true
          description: >-
            One-time automation ID from `GET
            /v1/workspaces/{workspace_id}/one-time-automations`, in this
            workspace
          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: run_id
          in: path
          required: true
          description: >-
            Run ID returned by `POST
            /v1/workspaces/{workspace_id}/one-time-automations`, `POST
            /v1/workspaces/{workspace_id}/one-time-automations/{one_time_automation_id}/runs`
            or `GET
            /v1/workspaces/{workspace_id}/one-time-automations/{one_time_automation_id}`
          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: comment_limit
          in: query
          required: false
          schema:
            default: 200
            type: integer
            minimum: 1
            maximum: 1500
      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
                  one_time_automation_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)$
                  run:
                    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)$
                      status:
                        description: >-
                          scanning: reading the post's comments. ready: the scan
                          finished and nothing is sent until `POST
                          /v1/workspaces/{workspace_id}/one-time-automations/{one_time_automation_id}/runs/{run_id}/replies`.
                          sending: replies are going out. paused: stopped after
                          repeated Meta failures; scan_finished_at tells whether
                          it stopped while reading (null) or while sending, and
                          resuming it is done in Replier. completed, cancelled,
                          failed: ended.
                        type: string
                        enum:
                          - scanning
                          - ready
                          - sending
                          - paused
                          - completed
                          - cancelled
                          - failed
                      phase:
                        description: >-
                          Which half of the run this status belongs to, so a
                          paused run reads as a paused scan or a paused send.
                        type: string
                        enum:
                          - scan
                          - send
                          - ended
                      error:
                        type:
                          - string
                          - 'null'
                      exclude_previous:
                        type: boolean
                      truncated:
                        description: >-
                          The scan stopped at its comment limit before the last
                          comment
                        type: boolean
                      scanned_count:
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                      comment_total:
                        anyOf:
                          - type: integer
                            minimum: 0
                            maximum: 9007199254740991
                          - type: 'null'
                      keywords:
                        type: array
                        items:
                          type: string
                      reply_messages:
                        type: array
                        items:
                          type: string
                      reply_selection_mode:
                        type: string
                        enum:
                          - random
                          - round_robin
                      counts:
                        type: object
                        properties:
                          matched:
                            type: integer
                            minimum: 0
                            maximum: 9007199254740991
                          eligible:
                            description: Comments a send would answer now
                            type: integer
                            minimum: 0
                            maximum: 9007199254740991
                          excluded:
                            type: integer
                            minimum: 0
                            maximum: 9007199254740991
                          unselected:
                            type: integer
                            minimum: 0
                            maximum: 9007199254740991
                          queued:
                            type: integer
                            minimum: 0
                            maximum: 9007199254740991
                          sent:
                            type: integer
                            minimum: 0
                            maximum: 9007199254740991
                          failed:
                            type: integer
                            minimum: 0
                            maximum: 9007199254740991
                          cancelled:
                            type: integer
                            minimum: 0
                            maximum: 9007199254740991
                        required:
                          - matched
                          - eligible
                          - excluded
                          - unselected
                          - queued
                          - sent
                          - failed
                          - cancelled
                      created_at:
                        type: string
                      scan_finished_at:
                        type:
                          - string
                          - 'null'
                      send_started_at:
                        type:
                          - string
                          - 'null'
                      finished_at:
                        type:
                          - string
                          - 'null'
                    required:
                      - id
                      - status
                      - phase
                      - error
                      - exclude_previous
                      - truncated
                      - scanned_count
                      - comment_total
                      - keywords
                      - reply_messages
                      - reply_selection_mode
                      - counts
                      - created_at
                      - scan_finished_at
                      - send_started_at
                      - finished_at
                  comments:
                    description: >-
                      Matching comments, those a send would answer (eligible)
                      first, then newest first
                    type: array
                    items:
                      type: object
                      properties:
                        comment_id:
                          type: string
                        person_key:
                          type: string
                        username:
                          description: 'Untrusted user content: the commenter''s username'
                          type:
                            - string
                            - 'null'
                        text:
                          description: 'Untrusted user content: the comment''s text'
                          type:
                            - string
                            - 'null'
                        commented_at:
                          type:
                            - string
                            - 'null'
                        status:
                          type: string
                          enum:
                            - eligible
                            - excluded
                            - unselected
                            - queued
                            - sending
                            - sent
                            - failed
                            - cancelled
                        reason:
                          description: >-
                            Why a comment is excluded or failed, such as
                            already_replied
                          type:
                            - string
                            - 'null'
                        reply_message:
                          type:
                            - string
                            - 'null'
                        sent_at:
                          type:
                            - string
                            - 'null'
                      required:
                        - comment_id
                        - person_key
                        - username
                        - text
                        - commented_at
                        - status
                        - reason
                        - reply_message
                        - sent_at
                  comments_truncated:
                    description: >-
                      More comments matched than comment_limit; counts still
                      cover all of them
                    type: boolean
                  can_send:
                    type: boolean
                  blocked_reason:
                    description: >-
                      null: this user can send this automation's replies now.
                      permission_denied: the user lacks messages.send.
                      workspace_paused: the workspace's service is paused.
                      channel_unavailable or channel_reconnect_required:
                      reconnect the Instagram account in Replier.
                    anyOf:
                      - type: string
                        enum:
                          - permission_denied
                          - workspace_paused
                          - channel_unavailable
                          - channel_reconnect_required
                      - type: 'null'
                required:
                  - workspace
                  - one_time_automation_id
                  - run
                  - comments
                  - comments_truncated
                  - can_send
                  - blocked_reason
        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.