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

# Ver métricas do post

> Retorna as métricas salvas de cada destino ativo do post: o último retrato diário que o PostClean coletou da rede. Nenhuma chamada é feita à rede. LinkedIn, Página do LinkedIn, Telegram, Discord e Google Business não entram nas análises.



## OpenAPI

````yaml /openapi.json get /posts/{post}/metrics
openapi: 3.1.0
info:
  title: PostClean API
  version: 2.0.0
  description: >-
    API REST do PostClean. Autentique com uma chave de API do workspace, enviada
    como token Bearer no cabeçalho `Authorization`.
servers:
  - url: https://post.chatclean.com.br/api
    description: PostClean
security:
  - bearerAuth: []
tags:
  - name: Posts
    description: Criar, ler, atualizar, excluir e pré-visualizar posts.
  - name: Post notes
    description: Notas internas de um post, visíveis aos membros do workspace.
  - name: Approvals
    description: Aprovar ou rejeitar posts que aguardam aprovação.
  - name: Recurrence
    description: Fazer um post se repetir numa frequência.
  - name: Media and uploads
    description: Enviar arquivos e anexar mídia aos posts.
  - name: Social accounts
    description: Contas sociais conectadas e as opções de cada rede.
  - name: Channels
    description: Horários de postagem e fila de um canal.
  - name: Ideas
    description: Ideias do quadro Criar.
  - name: Idea stages
    description: As colunas (etapas) do quadro de ideias.
  - name: Analytics
    description: Métricas do workspace e dos canais.
  - name: Labels
    description: Etiquetas para organizar posts e ideias.
  - name: Signatures
    description: Textos reutilizáveis para adicionar aos posts.
  - name: Workspace
    description: O workspace ao qual a chave de API pertence.
  - name: API keys
    description: Chaves de API pessoais deste workspace.
  - name: Webhooks
    description: Webhooks de saída e os registros de entrega.
  - name: Repurposes
    description: Automações que republicam vídeos postados fora do PostClean.
  - name: Platform
    description: Recursos de cada plataforma e tipos de conteúdo.
paths:
  /posts/{post}/metrics:
    parameters:
      - $ref: '#/components/parameters/PostId'
    get:
      tags:
        - Posts
      summary: Ver métricas do post
      description: >-
        Retorna as métricas salvas de cada destino ativo do post: o último
        retrato diário que o PostClean coletou da rede. Nenhuma chamada é feita
        à rede. LinkedIn, Página do LinkedIn, Telegram, Discord e Google
        Business não entram nas análises.
      operationId: getPostMetrics
      responses:
        '200':
          description: As métricas do post.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostMetrics'
              example:
                post_id: 9d3c1f2a-6b4e-4c8a-9f1e-2a7b5c8d0e41
                platforms:
                  - post_platform_id: 9d3c1f2b-1a2b-4c3d-8e4f-5a6b7c8d9e0f
                    platform: x
                    status: published
                    platform_post_id: '1843921066571337728'
                    platform_url: https://x.com/postclean/status/1843921066571337728
                    metrics:
                      available: true
                      reason: null
                      publication:
                        id: 9d4a0b1c-2d3e-4f5a-8b6c-7d8e9f0a1b2c
                        post_platform_id: 9d3c1f2b-1a2b-4c3d-8e4f-5a6b7c8d9e0f
                        social_account_key: 9c8b7a65-4d3e-4f2a-8b1c-0d9e8f7a6b54
                        platform: x
                        origin: trypost
                        content_type: text
                        availability: available
                        provider_published_at: '2026-11-12T14:00:03+00:00'
                        permalink: https://x.com/postclean/status/1843921066571337728
                        excerpt: Agora dá para agendar fios no X.
                        preview_metadata: null
                        account_display_name: PostClean
                        account_username: postclean
                        account_avatar_url: null
                      snapshot:
                        date: '2026-11-14'
                        collected_at: '2026-11-14T06:10:00+00:00'
                        provider_observed_at: '2026-11-14T06:09:58+00:00'
                        reactions_count: 42
                        comments_count: 5
                        shares_count: 7
                        saves_count: 3
                        views_count: null
                        impressions_count: 3120
                        reach_count: null
                        engagement_count: 57
                        exposure_count: 3120
                        exposure_kind: impressions
                        watch_time_milliseconds: null
                        average_watch_time_milliseconds: null
                      metrics:
                        impressions:
                          value: 3120
                          unit: count
                          time_basis: lifetime
                          precision: exact
                          availability: available
                          provider_metric: impression_count
                          period_start: null
                          period_end: null
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/PaymentRequired'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
components:
  parameters:
    PostId:
      name: post
      in: path
      required: true
      description: Id do post. Um post de outro workspace devolve `404`.
      schema:
        type: string
        format: uuid
      example: 9d3c1f2a-6b4e-4c8a-9f1e-2a7b5c8d0e41
  schemas:
    PostMetrics:
      type: object
      description: Métricas salvas do post, uma entrada por destino ativo.
      properties:
        post_id:
          type: string
          format: uuid
        platforms:
          type: array
          items:
            type: object
            properties:
              post_platform_id:
                type: string
                format: uuid
                description: Id do destino (`platforms[].id` do post).
              platform:
                $ref: '#/components/schemas/Platform'
              status:
                type: string
                enum:
                  - pending
                  - publishing
                  - retrying
                  - pending_review
                  - published
                  - failed
                  - rejected
                description: Estado da publicação na rede (veja `PostPlatform.status`).
              platform_post_id:
                type:
                  - string
                  - 'null'
                description: Id do post na rede.
              platform_url:
                type:
                  - string
                  - 'null'
              metrics:
                description: >-
                  As métricas salvas, ou `{unsupported: true, reason}` quando
                  não há: `not_published` (ainda não publicado),
                  `platform_not_supported` (LinkedIn, Página do LinkedIn,
                  Telegram, Discord e Google Business não entram nas análises)
                  ou `not_collected` (ainda não coletado).
                oneOf:
                  - $ref: '#/components/schemas/PublicationAnalytics'
                  - type: object
                    title: Indisponível
                    properties:
                      unsupported:
                        type: boolean
                        const: true
                      reason:
                        type: string
                        enum:
                          - not_published
                          - platform_not_supported
                          - not_collected
    Platform:
      type: string
      enum:
        - linkedin
        - linkedin-page
        - x
        - tiktok
        - youtube
        - facebook
        - instagram
        - instagram-facebook
        - threads
        - pinterest
        - bluesky
        - mastodon
        - telegram
        - discord
        - google_business
      description: >-
        Rede de uma conta social. `linkedin-page` é uma página de empresa no
        LinkedIn, e `instagram-facebook` é uma conta do Instagram conectada por
        uma Página do Facebook.
    PublicationAnalytics:
      type: object
      description: >-
        Análises salvas de uma publicação: a contagem diária mais recente
        coletada da rede.
      properties:
        available:
          type: boolean
          description: Sempre `true` em `GET /analytics/publications/{publication}`.
        reason:
          type:
            - string
            - 'null'
          description: Sempre `null` em `GET /analytics/publications/{publication}`.
        publication:
          type: object
          properties:
            id:
              type: string
              format: uuid
            post_platform_id:
              type:
                - string
                - 'null'
              format: uuid
              description: >-
                Destino do post no PostClean que gerou esta publicação, ou
                `null` num post feito fora do PostClean.
            social_account_key:
              type:
                - string
                - 'null'
              description: >-
                Chave fixa do canal nas análises. Num canal conectado, é o id da
                conta social.
            platform:
              $ref: '#/components/schemas/Platform'
            origin:
              type: string
              enum:
                - trypost
                - external
              description: >-
                `trypost` (publicado pelo PostClean) ou `external` (feito fora
                dele).
            content_type:
              type: string
              enum:
                - text
                - image
                - carousel
                - video
                - reel
                - story
                - short
                - link
                - poll
                - unknown
              description: Tipo da publicação nas análises (`text`, `image`, `video`, ...).
            availability:
              type: string
              enum:
                - available
                - deleted
                - unavailable
              description: >-
                Sempre `available` em `GET
                /analytics/publications/{publication}`.
            provider_published_at:
              type:
                - string
                - 'null'
              format: date-time
              description: Quando a rede publicou, ISO 8601 em UTC (`+00:00`).
            permalink:
              type:
                - string
                - 'null'
            excerpt:
              type:
                - string
                - 'null'
            preview_metadata:
              type:
                - object
                - 'null'
              description: >-
                Dados de prévia que a rede devolveu (por exemplo
                `thumbnail_url`).
            account_display_name:
              type:
                - string
                - 'null'
            account_username:
              type:
                - string
                - 'null'
            account_avatar_url:
              type:
                - string
                - 'null'
              description: >-
                Foto atual da conta, ou a guardada na publicação quando a conta
                não existe mais.
        snapshot:
          type:
            - object
            - 'null'
          properties:
            date:
              type: string
              format: date
            collected_at:
              type:
                - string
                - 'null'
              format: date-time
            provider_observed_at:
              type:
                - string
                - 'null'
              format: date-time
            reactions_count:
              type:
                - integer
                - 'null'
            comments_count:
              type:
                - integer
                - 'null'
            shares_count:
              type:
                - integer
                - 'null'
            saves_count:
              type:
                - integer
                - 'null'
            views_count:
              type:
                - integer
                - 'null'
            impressions_count:
              type:
                - integer
                - 'null'
            reach_count:
              type:
                - integer
                - 'null'
            engagement_count:
              type:
                - integer
                - 'null'
              description: Total de interações usado na taxa de engajamento.
            exposure_count:
              type:
                - integer
                - 'null'
              description: >-
                Base da taxa de engajamento (alcance, impressões ou
                visualizações, conforme `exposure_kind`).
            exposure_kind:
              type:
                - string
                - 'null'
              enum:
                - reach
                - impressions
                - views
                - null
              description: >-
                O que `exposure_count` mede: alcance, impressões ou
                visualizações.
            watch_time_milliseconds:
              type:
                - integer
                - 'null'
            average_watch_time_milliseconds:
              type:
                - integer
                - 'null'
          description: >-
            A contagem diária mais recente, ou `null` enquanto nenhuma foi
            coletada.
        metrics:
          type:
            - object
            - array
          description: >-
            Métricas que a rede informa para esta publicação, pela chave da
            métrica (`reactions`, `comments`, `views`, `impressions`, `reach`,
            `engagement_rate`, ...). Cada valor é um objeto. Vem como lista
            vazia `[]` enquanto nenhuma contagem foi coletada. `engagement_rate`
            é calculado pelo PostClean quando há engajamento e alcance.
          additionalProperties:
            type: object
            properties:
              value:
                type:
                  - number
                  - 'null'
              unit:
                type: string
                enum:
                  - count
                  - milliseconds
                  - percent
              time_basis:
                type: string
                enum:
                  - lifetime
                  - range
                  - rolling_90_days
                  - snapshot
              precision:
                type: string
                enum:
                  - exact
                  - approximate
                  - estimated
                  - experimental
              availability:
                type: string
                enum:
                  - available
                  - unsupported
                  - unavailable
                  - delayed
                  - privacy_limited
              provider_metric:
                type:
                  - string
                  - 'null'
                description: Nome da métrica na API da rede.
              period_start:
                type:
                  - string
                  - 'null'
                format: date-time
              period_end:
                type:
                  - string
                  - 'null'
                format: date-time
          maxItems: 0
    ErrorBody:
      type: object
      properties:
        message:
          type: string
      description: Corpo de erro com uma mensagem.
    RateLimitErrorBody:
      type: object
      properties:
        name:
          type: string
          const: rate_limit_exceeded
        message:
          type: string
          examples:
            - Rate limit exceeded. Please retry after 30 seconds.
      description: Corpo devolvido quando o limite de requisições é excedido.
  responses:
    Unauthorized:
      description: >-
        Chave de API ausente, inválida, revogada ou expirada. Corpos possíveis:
        `Unauthenticated.` (sem chave, ou chave inválida ou revogada), `Token
        expired.` (passou do `expires_at`), `Token not found.` e `No workspace
        selected.` (a chave não está mais ligada a um workspace).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorBody'
          example:
            message: Unauthenticated.
    PaymentRequired:
      description: >-
        A conta do workspace não tem assinatura ativa nem período de teste.
        Corpo: `{"message": "Active subscription required."}`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorBody'
          example:
            message: Active subscription required.
    Forbidden:
      description: >-
        A requisição não é permitida. Chaves de API só funcionam para
        administradores do workspace (o dono da conta ou um membro marcado como
        administrador); fora isso, toda requisição devolve `Insufficient
        workspace permissions.`. Outros corpos: `Workspace access denied.` (o
        usuário da chave saiu do workspace), `Personal access token required.`
        (foi enviado um token OAuth do MCP) e `This action is unauthorized.`
        (por exemplo, a nota pertence a outro membro).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorBody'
    NotFound:
      description: O recurso não existe neste workspace.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorBody'
    TooManyRequests:
      description: 'Limite de requisições excedido: 60 por minuto por workspace.'
      headers:
        Retry-After:
          description: Segundos de espera antes de tentar de novo.
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RateLimitErrorBody'
          example:
            name: rate_limit_exceeded
            message: Rate limit exceeded. Please retry after 30 seconds.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Chave de API do workspace, criada em Configurações > Chaves de API.

````

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