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

# Listar desempenho dos posts do canal

> Classifica os posts do canal no período (feitos no PostClean ou não) por uma métrica, do melhor para o pior, e retorna os 50 primeiros, uma página por vez. O tamanho da página é definido pelo servidor: leia `meta.per_page`. A resposta também traz os `filters` que o servidor aplicou. Posts sem a métrica ficam por último. Mesmo fuso horário, filtros, limite de datas e regra de `404` de `GET /channels/{account}/insights`.



## OpenAPI

````yaml /openapi.json get /channels/{account}/insights/publications
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:
  /channels/{account}/insights/publications:
    parameters:
      - $ref: '#/components/parameters/AccountId'
    get:
      tags:
        - Analytics
      summary: Listar desempenho dos posts do canal
      description: >-
        Classifica os posts do canal no período (feitos no PostClean ou não) por
        uma métrica, do melhor para o pior, e retorna os 50 primeiros, uma
        página por vez. O tamanho da página é definido pelo servidor: leia
        `meta.per_page`. A resposta também traz os `filters` que o servidor
        aplicou. Posts sem a métrica ficam por último. Mesmo fuso horário,
        filtros, limite de datas e regra de `404` de `GET
        /channels/{account}/insights`.
      operationId: listChannelPostPerformance
      parameters:
        - name: range
          in: query
          required: false
          description: >-
            `7d` (últimos 7 dias), `30d` (últimos 30 dias, o padrão), `mtd` (mês
            até hoje) ou `custom`. Os dias são dias corridos no fuso horário do
            usuário dono da chave de API, incluindo hoje.
          schema:
            type: string
            enum:
              - 7d
              - 30d
              - mtd
              - custom
            default: 30d
        - name: start
          in: query
          required: false
          description: >-
            Primeiro dia, `Y-m-d`. Obrigatório com `range=custom` e ignorado nos
            outros períodos prontos. Enviar `start` e `end` sem `range` equivale
            a `custom`.
          schema:
            type: string
            format: date
        - name: end
          in: query
          required: false
          description: >-
            Último dia, `Y-m-d`, igual ou depois de `start`. Obrigatório com
            `range=custom`.
          schema:
            type: string
            format: date
        - name: labels[]
          in: query
          required: false
          style: form
          explode: true
          description: >-
            Só posts com alguma destas etiquetas (etiquetas deste workspace).
            Etiquetas desconhecidas ou apagadas retornam `422`.
          schema:
            type: array
            items:
              type: string
              format: uuid
        - name: untagged
          in: query
          required: false
          description: >-
            Inclui (ou mostra só) posts sem etiqueta. Posts feitos fora do
            PostClean não têm etiquetas. Envie `1` ou `0`; `true` e `false` são
            recusados com `422`.
          schema:
            type: string
            enum:
              - '1'
              - '0'
        - name: types[]
          in: query
          required: false
          style: form
          explode: true
          description: Só estes tipos de conteúdo. Eles precisam ser da rede do canal.
          schema:
            type: array
            items:
              $ref: '#/components/schemas/ContentType'
        - name: period
          in: query
          required: false
          description: '`previous` classifica os posts do período anterior de mesmo tamanho.'
          schema:
            type: string
            enum:
              - current
              - previous
            default: current
        - name: sort
          in: query
          required: false
          description: >-
            Métrica usada na classificação. Quando o canal não informa essa
            métrica (ou ela não é enviada), vale a primeira desta lista que o
            canal informa; `filters.sort` mostra qual.
          schema:
            type: string
            enum:
              - reactions
              - comments
              - engagement_rate
              - views
              - impressions
              - shares
              - saves
              - reach
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            default: 1
      responses:
        '200':
          description: Uma página de posts classificados.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ChannelPostPerformance'
                  links:
                    $ref: '#/components/schemas/PaginationLinks'
                  meta:
                    $ref: '#/components/schemas/PaginationMeta'
                  filters:
                    $ref: '#/components/schemas/ChannelInsightsFilters'
              example:
                data:
                  - id: 9d4a0b1c-2d3e-4f5a-8b6c-7d8e9f0a1b2c
                    rank: 1
                    post_id: 9d3c1f2a-6b4e-4c8a-9f1e-2a7b5c8d0e41
                    excerpt: We just shipped scheduled threads. Here is how they work.
                    thumbnail_url: >-
                      https://example.com/medias/9d3c1f30-8a9b-4c0d-9e1f-2a3b4c5d6e7f.jpg
                    permalink: https://x.com/postclean/status/1841234567890123456
                    published_at: '2026-10-02T14:00:00+00:00'
                    content_type: image
                    metrics:
                      reactions: 412
                      comments: 38
                      engagement_rate: 5.31
                      views: 9120
                      impressions: 10230
                      shares: null
                      reposts: 41
                      quotes: 6
                      saves: null
                      clicks: 133
                      follows_gained: null
                      reach: null
                      watch_time_minutes: null
                      average_watch_time_seconds: null
                links:
                  first: >-
                    https://post.chatclean.com.br/api/channels/9c8b7a65-4d3e-4f2a-8b1c-0d9e8f7a6b54/insights/publications?page=1
                  last: >-
                    https://post.chatclean.com.br/api/channels/9c8b7a65-4d3e-4f2a-8b1c-0d9e8f7a6b54/insights/publications?page=1
                  prev: null
                  next: null
                meta:
                  current_page: 1
                  from: 1
                  last_page: 1
                  links:
                    - url: null
                      label: '« Previous'
                      page: null
                      active: false
                    - url: >-
                        https://post.chatclean.com.br/api/channels/9c8b7a65-4d3e-4f2a-8b1c-0d9e8f7a6b54/insights/publications?page=1
                      label: '1'
                      page: 1
                      active: true
                    - url: null
                      label: Next »
                      page: null
                      active: false
                  path: >-
                    https://post.chatclean.com.br/api/channels/9c8b7a65-4d3e-4f2a-8b1c-0d9e8f7a6b54/insights/publications
                  per_page: 25
                  to: 1
                  total: 1
                filters:
                  range: 30d
                  start: '2026-09-09'
                  end: '2026-10-08'
                  period: current
                  sort: reactions
                  labels: []
                  untagged: false
                  types: []
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/PaymentRequired'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: >-
            O canal não existe neste workspace ou é de uma rede sem insights
            (LinkedIn, páginas do LinkedIn, Telegram, Discord e Google
            Business).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '422':
          $ref: '#/components/responses/ValidationError'
        '429':
          $ref: '#/components/responses/TooManyRequests'
components:
  parameters:
    AccountId:
      name: account
      in: path
      required: true
      description: Id da conta social (canal). Uma conta de outro workspace devolve `404`.
      schema:
        type: string
        format: uuid
      example: 9c8b7a65-4d3e-4f2a-8b1c-0d9e8f7a6b54
  schemas:
    ContentType:
      type: string
      enum:
        - instagram_feed
        - instagram_reel
        - instagram_story
        - linkedin_post
        - linkedin_page_post
        - facebook_post
        - facebook_reel
        - facebook_story
        - tiktok_video
        - tiktok_photo
        - youtube_short
        - x_post
        - threads_post
        - threads_ghost_post
        - pinterest_pin
        - pinterest_video_pin
        - pinterest_carousel
        - bluesky_post
        - mastodon_post
        - telegram_post
        - discord_message
        - google_business_post
      description: >-
        Formato do post numa rede. Precisa pertencer à rede do destino. `GET
        /content-types` lista os formatos de cada rede com as regras de mídia.
        Stories do Instagram e do Facebook não publicam texto.
    ChannelPostPerformance:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Id da publicação nas análises.
        rank:
          type: integer
          description: Posição pela métrica de `sort`, a partir de 1.
        post_id:
          type:
            - string
            - 'null'
          format: uuid
          description: Post do PostClean, ou `null` num post feito fora do PostClean.
        excerpt:
          type:
            - string
            - 'null'
          description: Começo do texto do post.
        thumbnail_url:
          type:
            - string
            - 'null'
          description: >-
            Miniatura que a rede devolveu (`preview_metadata.thumbnail_url`), só
            quando é `https`. Os links de miniatura das redes podem expirar.
        permalink:
          type:
            - string
            - 'null'
        published_at:
          type: string
          format: date-time
          description: Quando a rede publicou, ISO 8601 em UTC (`+00:00`).
        content_type:
          type:
            - string
            - 'null'
          enum:
            - text
            - image
            - carousel
            - video
            - reel
            - story
            - short
            - link
            - poll
            - unknown
            - null
          description: Tipo da publicação nas análises (`text`, `image`, `video`, ...).
        metrics:
          type: object
          description: >-
            `null` numa métrica que a rede não informa. `engagement_rate` é um
            percentual.
          properties:
            reactions:
              type:
                - number
                - 'null'
            comments:
              type:
                - number
                - 'null'
            engagement_rate:
              type:
                - number
                - 'null'
            views:
              type:
                - number
                - 'null'
            impressions:
              type:
                - number
                - 'null'
            shares:
              type:
                - number
                - 'null'
            reposts:
              type:
                - number
                - 'null'
            quotes:
              type:
                - number
                - 'null'
            saves:
              type:
                - number
                - 'null'
            clicks:
              type:
                - number
                - 'null'
            follows_gained:
              type:
                - number
                - 'null'
            reach:
              type:
                - number
                - 'null'
            watch_time_minutes:
              type:
                - number
                - 'null'
            average_watch_time_seconds:
              type:
                - number
                - 'null'
    PaginationLinks:
      type: object
      properties:
        first:
          type:
            - string
            - 'null'
        last:
          type:
            - string
            - 'null'
        prev:
          type:
            - string
            - 'null'
        next:
          type:
            - string
            - 'null'
      description: Links para a primeira, a última, a anterior e a próxima página.
    PaginationMeta:
      type: object
      properties:
        current_page:
          type: integer
          description: Página atual.
        from:
          type:
            - integer
            - 'null'
        last_page:
          type: integer
          description: Última página.
        links:
          type: array
          items:
            type: object
            properties:
              url:
                type:
                  - string
                  - 'null'
              label:
                type: string
              page:
                type:
                  - integer
                  - 'null'
              active:
                type: boolean
          description: Links de navegação entre páginas.
        path:
          type: string
        per_page:
          type: integer
          description: >-
            Tamanho da página definido pelo servidor (hoje 25). Leia o valor em
            vez de supor.
        to:
          type:
            - integer
            - 'null'
        total:
          type: integer
          description: Total de itens em todas as páginas.
      description: Dados da página atual de uma lista paginada.
    ChannelInsightsFilters:
      type: object
      description: Os filtros que o servidor aplicou, já com os valores padrão.
      properties:
        range:
          type: string
          enum:
            - 7d
            - 30d
            - mtd
            - custom
        start:
          type: string
          format: date
          description: Primeiro dia realmente usado.
        end:
          type: string
          format: date
          description: Último dia realmente usado.
        period:
          type: string
          enum:
            - current
            - previous
        sort:
          type: string
          description: >-
            A ordenação usada: a pedida, quando o canal informa essa métrica, ou
            a primeira métrica ordenável que ele informa.
        labels:
          type: array
          items:
            type: string
            format: uuid
          description: Etiquetas aplicadas.
        untagged:
          type: boolean
        types:
          type: array
          items:
            $ref: '#/components/schemas/ContentType'
          description: Tipos de conteúdo aplicados.
    ErrorBody:
      type: object
      properties:
        message:
          type: string
      description: Corpo de erro com uma mensagem.
    ValidationErrorBody:
      type: object
      properties:
        message:
          type: string
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
      description: Corpo de erro de validação. `errors` traz as mensagens por campo.
    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'
    ValidationError:
      description: A validação falhou. Cada campo com erro aparece em `errors`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ValidationErrorBody'
    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.