> ## 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 connected account performance

> Returns one connected account's results for the last days (default 30), as the dashboard shows them filtered to that account, each with the previous period, plus its top automations and delivery outcomes.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/workspaces/{workspace_id}/accounts/{channel}/{account_id}/performance
openapi: 3.1.0
info:
  title: Replier API
  version: '1'
servers:
  - url: https://api.usereplier.com
security:
  - apiKey: []
paths:
  /v1/workspaces/{workspace_id}/accounts/{channel}/{account_id}/performance:
    get:
      tags:
        - Accounts
      summary: Get connected account performance
      description: >-
        Returns one connected account's results for the last days (default 30),
        as the dashboard shows them filtered to that account, each with the
        previous period, plus its top automations and delivery outcomes.
      operationId: get_account_performance
      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: channel
          in: path
          required: true
          description: >-
            Channel returned with the account by `GET
            /v1/workspaces/{workspace_id}/accounts`
          schema:
            type: string
            enum:
              - instagram
              - facebook
        - name: account_id
          in: path
          required: true
          description: Account ID returned by `GET /v1/workspaces/{workspace_id}/accounts`
          schema:
            type: string
            minLength: 1
        - name: days
          in: query
          required: false
          description: Reporting window in days, ending now
          schema:
            default: 30
            type: integer
            minimum: 1
            maximum: 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
                  account:
                    type: object
                    properties:
                      channel:
                        type: string
                        enum:
                          - instagram
                          - facebook
                      account_id:
                        type: string
                      name:
                        type: string
                      state:
                        description: >-
                          Whether this account can answer now. active: it can.
                          account_not_subscribed: Meta sends it no comment or
                          message events; the user retries auto-reply setup in
                          Replier. account_needs_reconnect: Meta rejected its
                          token; the user reconnects it in Replier.
                          account_disconnected: it is no longer connected.
                        type: string
                        enum:
                          - active
                          - account_not_subscribed
                          - account_needs_reconnect
                          - account_disconnected
                    required:
                      - channel
                      - account_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
                  active_automations:
                    description: >-
                      Turned-on automations with a target on this account.
                      Unless account.state is active, none of them answer from
                      this account.
                    type: integer
                    minimum: 0
                    maximum: 9007199254740991
                  performance:
                    type: object
                    properties:
                      dm_attempts:
                        description: >-
                          Runs that started in the period and reached the DM
                          step: dms_sent + dms_failed + dms_skipped + dms_queued
                          + dms_gated. A multi-message flow run counts once.
                          Matched comments skipped before a DM was created (for
                          example own comments or duplicates) are not included.
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                      dms_sent:
                        description: >-
                          Runs whose main DM was delivered. Not the dashboard's
                          DMs sent, which counts every message of a flow: see
                          messages_sent in `GET
                          /v1/workspaces/{workspace_id}/performance`.
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                      dms_failed:
                        description: >-
                          Runs whose main DM send errored. Excludes Meta
                          refusals and Free Plan limit stops, which are in
                          dms_skipped.
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                      dms_skipped:
                        description: >-
                          Runs not sent because Meta refused this recipient or
                          comment (cannot receive messages, comment deleted,
                          already replied privately) or the Free Plan monthly
                          allowance was used up. Not send failures.
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                      dms_queued:
                        description: >-
                          Runs whose main DM has not gone out yet and are not
                          waiting on the recipient. Excludes dms_gated.
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                      dms_gated:
                        description: >-
                          Runs paused at a gate the recipient must complete
                          before the main DM is sent: Follow Gate (follow, then
                          tap the button), an opening button to tap, or an email
                          reply. The gate prompt was delivered, so these count
                          as delivered interactions. Not a failure or a backlog;
                          they complete only if the recipient responds.
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                      link_clicks:
                        description: >-
                          Clicks on links in any message of these runs,
                          including repeats.
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                      clicked_messages:
                        description: Runs in which the recipient clicked at least one link.
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                      unique_clickers:
                        description: >-
                          Distinct clicking recipients. Recipient IDs are scoped
                          per channel account, so one person clicking on both
                          Instagram and Facebook counts twice.
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                      send_rate:
                        description: >-
                          dms_sent / dm_attempts. dms_gated, dms_skipped and
                          dms_queued lower it without being failures; use
                          dms_failed for actual send errors.
                        type: number
                        minimum: 0
                      message_click_through_rate:
                        description: clicked_messages / dms_sent.
                        type: number
                        minimum: 0
                      clicks_per_sent_dm:
                        description: link_clicks / dms_sent.
                        type: number
                        minimum: 0
                    required:
                      - dm_attempts
                      - dms_sent
                      - dms_failed
                      - dms_skipped
                      - dms_queued
                      - dms_gated
                      - link_clicks
                      - clicked_messages
                      - unique_clickers
                      - send_rate
                      - message_click_through_rate
                      - clicks_per_sent_dm
                  interaction_metrics:
                    description: >-
                      The numbers the Replier dashboard shows for this scope,
                      counted from interactions that started in the period.
                    type: object
                    properties:
                      previous_start:
                        description: Start of the previous period; it ends at period.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))$
                      interactions:
                        description: >-
                          Runs whose first message, a gate prompt or the DM, was
                          delivered. A multi-message flow run counts once.
                        type: object
                        properties:
                          value:
                            type: number
                            minimum: 0
                          previous:
                            description: >-
                              The same metric for the equally long period just
                              before.
                            type: number
                            minimum: 0
                        required:
                          - value
                          - previous
                      people_reached:
                        description: >-
                          Distinct recipients of those interactions; people
                          whose run failed or was skipped before a message
                          reached them are not counted. Recipient IDs are scoped
                          per channel account, so one person on Instagram and
                          Facebook counts twice.
                        type: object
                        properties:
                          value:
                            type: number
                            minimum: 0
                          previous:
                            description: >-
                              The same metric for the equally long period just
                              before.
                            type: number
                            minimum: 0
                        required:
                          - value
                          - previous
                      link_click_rate:
                        description: >-
                          Share (0-1) of interactions that sent a link in which
                          the recipient clicked one.
                        type: object
                        properties:
                          value:
                            type: number
                            minimum: 0
                          previous:
                            description: >-
                              The same metric for the equally long period just
                              before.
                            type: number
                            minimum: 0
                        required:
                          - value
                          - previous
                      link_interactions:
                        description: >-
                          Interactions that sent a link. When it is 0,
                          link_click_rate has nothing to measure; it is not a
                          poor result.
                        type: object
                        properties:
                          value:
                            type: number
                            minimum: 0
                          previous:
                            description: >-
                              The same metric for the equally long period just
                              before.
                            type: number
                            minimum: 0
                        required:
                          - value
                          - previous
                      completion_rate:
                        description: >-
                          Share (0-1) of interactions whose main DM was sent.
                          The rest are waiting at a gate or stopped before the
                          DM.
                        type: object
                        properties:
                          value:
                            type: number
                            minimum: 0
                          previous:
                            description: >-
                              The same metric for the equally long period just
                              before.
                            type: number
                            minimum: 0
                        required:
                          - value
                          - previous
                    required:
                      - previous_start
                      - interactions
                      - people_reached
                      - link_click_rate
                      - link_interactions
                      - completion_rate
                  top_automations:
                    description: >-
                      Up to 5 automations with the most interactions in the
                      period, as on the dashboard.
                    type: array
                    items:
                      type: object
                      properties:
                        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)$
                        name:
                          type: string
                        interactions:
                          type: integer
                          minimum: 0
                          maximum: 9007199254740991
                        messages_sent:
                          description: >-
                            Messages sent in those interactions, each flow
                            message counted.
                          type: integer
                          minimum: 0
                          maximum: 9007199254740991
                        link_clicks:
                          type: integer
                          minimum: 0
                          maximum: 9007199254740991
                      required:
                        - automation_id
                        - name
                        - interactions
                        - messages_sent
                        - link_clicks
                required:
                  - workspace
                  - account
                  - period
                  - active_automations
                  - performance
                  - interaction_metrics
                  - top_automations
        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.