> ## 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 insights do canal

> Retorna os insights de um canal para um período: as métricas que ele informa, o resumo e as séries de métricas do período e do período anterior. Os dias são dias corridos no fuso horário do usuário dono da chave de API. Etiquetas, `untagged` e tipos filtram as métricas de posts; os seguidores continuam valendo para a conta inteira. Canais do LinkedIn, páginas do LinkedIn, Telegram, Discord e Google Business não têm insights e retornam `404`. Com `custom` (ou `start`/`end` sem `range`), as datas são limitadas aos dias com dados deste canal (`summary.bounds`). Sem nenhum dado ainda, as datas são ignoradas e os últimos 30 dias são retornados. Sem `end`, vale o último dia com dados; sem `start`, 29 dias antes de `end`. Veja em `filters.start` e `filters.end` na resposta os dias realmente usados.



## OpenAPI

````yaml /openapi.json get /channels/{account}/insights
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:
    parameters:
      - $ref: '#/components/parameters/AccountId'
    get:
      tags:
        - Analytics
      summary: Ver insights do canal
      description: >-
        Retorna os insights de um canal para um período: as métricas que ele
        informa, o resumo e as séries de métricas do período e do período
        anterior. Os dias são dias corridos no fuso horário do usuário dono da
        chave de API. Etiquetas, `untagged` e tipos filtram as métricas de
        posts; os seguidores continuam valendo para a conta inteira. Canais do
        LinkedIn, páginas do LinkedIn, Telegram, Discord e Google Business não
        têm insights e retornam `404`. Com `custom` (ou `start`/`end` sem
        `range`), as datas são limitadas aos dias com dados deste canal
        (`summary.bounds`). Sem nenhum dado ainda, as datas são ignoradas e os
        últimos 30 dias são retornados. Sem `end`, vale o último dia com dados;
        sem `start`, 29 dias antes de `end`. Veja em `filters.start` e
        `filters.end` na resposta os dias realmente usados.
      operationId: getChannelInsights
      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: >-
            Aceito para manter igual à lista de posts; aqui só volta repetido em
            `filters`.
          schema:
            type: string
            enum:
              - current
              - previous
            default: current
        - name: sort
          in: query
          required: false
          description: >-
            Aceito para manter igual à lista de posts; aqui só volta repetido em
            `filters`.
          schema:
            type: string
            enum:
              - reactions
              - comments
              - engagement_rate
              - views
              - impressions
              - shares
              - saves
              - reach
      responses:
        '200':
          description: Os insights do canal.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChannelInsights'
              example:
                filters:
                  range: 30d
                  start: '2026-09-09'
                  end: '2026-10-08'
                  period: current
                  sort: reactions
                  labels: []
                  untagged: false
                  types: []
                available_metrics:
                  - followers
                  - net_followers
                  - posts
                  - reactions
                  - comments
                  - engagement_rate
                  - views
                  - impressions
                  - reposts
                  - quotes
                  - clicks
                summary:
                  bounds:
                    min: '2026-04-11'
                    max: '2026-10-08'
                  range:
                    start: '2026-09-09'
                    end: '2026-10-08'
                  previous_range:
                    start: '2026-08-10'
                    end: '2026-09-08'
                  summary:
                    posts:
                      value: 18
                      previous: 15
                      change: 20
                    followers:
                      value: 12480
                      previous: 12160
                      change: 320
                    net_followers:
                      value: 320
                      previous: 250
                      change: 28
                    reactions:
                      value: 2140
                      previous: 1890
                      change: 13.23
                    comments:
                      value: 188
                      previous: 205
                      change: -8.29
                    engagement_rate:
                      value: 4.12
                      previous: 3.85
                      change: 7.01
                    views:
                      value: 48210
                      previous: 39900
                      change: 20.83
                    impressions:
                      value: 61300
                      previous: 52010
                      change: 17.86
                    clicks:
                      value: 512
                      previous: 430
                      change: 19.07
                    reposts:
                      value: 96
                      previous: 80
                      change: 20
                    quotes:
                      value: 12
                      previous: 9
                      change: 33.33
                    reach:
                      value: 30120
                      previous: 27400
                      change: 9.93
                    shares:
                      value: 140
                      previous: 118
                      change: 18.64
                    saves:
                      value: 210
                      previous: 175
                      change: 20
                    watch_time_minutes:
                      value: 1830.5
                      previous: 1502.25
                      change: 21.85
                    average_watch_time_seconds:
                      value: 14.2
                      previous: 12.8
                      change: 10.94
                    follows_gained:
                      value: 41
                      previous: 37
                      change: 10.81
                  followers:
                    total: 12480
                    accounts:
                      - social_account_key: 9c8b7a65-4d3e-4f2a-8b1c-0d9e8f7a6b54
                        social_account_id: 9c8b7a65-4d3e-4f2a-8b1c-0d9e8f7a6b54
                        platform: x
                        network: x
                        name: PostClean
                        username: postclean
                        avatar_url: >-
                          https://pbs.twimg.com/profile_images/1790000000000000000/avatar_400x400.jpg
                        value: 12480
                        growth: 320
                        net: 320
                        provenance: provider
                        status: connected
                    series:
                      - date: '2026-10-02'
                        accounts:
                          9c8b7a65-4d3e-4f2a-8b1c-0d9e8f7a6b54: 12160
                      - date: '2026-10-08'
                        accounts:
                          9c8b7a65-4d3e-4f2a-8b1c-0d9e8f7a6b54: 12480
                  posts:
                    resolution: weekly
                    accounts:
                      - social_account_key: 9c8b7a65-4d3e-4f2a-8b1c-0d9e8f7a6b54
                        platform: x
                        name: PostClean
                        username: postclean
                        avatar_url: >-
                          https://pbs.twimg.com/profile_images/1790000000000000000/avatar_400x400.jpg
                        count: 18
                        status: connected
                    buckets:
                      - start: '2026-09-28'
                        end: '2026-10-04'
                        accounts:
                          9c8b7a65-4d3e-4f2a-8b1c-0d9e8f7a6b54: 3
                        total: 3
                  top_posts:
                    reactions:
                      - id: 9d4a0b1c-2d3e-4f5a-8b6c-7d8e9f0a1b2c
                        post_id: 9d3c1f2a-6b4e-4c8a-9f1e-2a7b5c8d0e41
                        social_account_key: 9c8b7a65-4d3e-4f2a-8b1c-0d9e8f7a6b54
                        platform: x
                        name: PostClean
                        username: postclean
                        avatar_url: >-
                          https://pbs.twimg.com/profile_images/1790000000000000000/avatar_400x400.jpg
                        origin: trypost
                        content_type: image
                        availability: available
                        published_at: '2026-10-02 14:00:00'
                        permalink: https://x.com/postclean/status/1841234567890123456
                        excerpt: >-
                          We just shipped scheduled threads. Here is how they
                          work.
                        preview_metadata: null
                        reactions: 412
                        comments: 38
                        status: connected
                    comments:
                      - id: 9d4a0b1c-2d3e-4f5a-8b6c-7d8e9f0a1b2c
                        post_id: 9d3c1f2a-6b4e-4c8a-9f1e-2a7b5c8d0e41
                        social_account_key: 9c8b7a65-4d3e-4f2a-8b1c-0d9e8f7a6b54
                        platform: x
                        name: PostClean
                        username: postclean
                        avatar_url: >-
                          https://pbs.twimg.com/profile_images/1790000000000000000/avatar_400x400.jpg
                        origin: trypost
                        content_type: image
                        availability: available
                        published_at: '2026-10-02 14:00:00'
                        permalink: https://x.com/postclean/status/1841234567890123456
                        excerpt: >-
                          We just shipped scheduled threads. Here is how they
                          work.
                        preview_metadata: null
                        reactions: 412
                        comments: 38
                        status: connected
                  performance:
                    - social_account_key: 9c8b7a65-4d3e-4f2a-8b1c-0d9e8f7a6b54
                      platform: x
                      name: PostClean
                      username: postclean
                      avatar_url: >-
                        https://pbs.twimg.com/profile_images/1790000000000000000/avatar_400x400.jpg
                      posts:
                        value: 18
                        previous: 15
                        change: 20
                      reactions:
                        value: 2140
                        previous: 1890
                        change: 13.23
                      comments:
                        value: 188
                        previous: 205
                        change: -8.29
                      engagement_rate:
                        value: 4.12
                        previous: 3.85
                        change: 7.01
                      reposts:
                        value: 96
                        previous: 80
                        change: 20
                      impressions:
                        value: 61300
                        previous: 52010
                        change: 17.86
                      clicks:
                        value: 512
                        previous: 430
                        change: 19.07
                      views:
                        value: 48210
                        previous: 39900
                        change: 20.83
                      shares:
                        value: 140
                        previous: 118
                        change: 18.64
                      saves:
                        value: 210
                        previous: 175
                        change: 20
                      follows_gained:
                        value: 41
                        previous: 37
                        change: 10.81
                      reach:
                        value: 30120
                        previous: 27400
                        change: 9.93
                      watch_time_minutes:
                        value: 1830.5
                        previous: 1502.25
                        change: 21.85
                      average_watch_time_seconds:
                        value: 14.2
                        previous: 12.8
                        change: 10.94
                      status: connected
                  coverage:
                    - social_account_id: 9c8b7a65-4d3e-4f2a-8b1c-0d9e8f7a6b54
                      collector: publication_backfill
                      status: complete
                      target_since: '2026-04-11T00:00:00.000000Z'
                      oldest_reached_at: '2026-04-11T09:12:00.000000Z'
                      high_watermark_at: '2026-10-08T06:00:00.000000Z'
                      last_success_at: '2026-10-08T06:00:00.000000Z'
                      last_error_category: null
                metric_series:
                  resolution: daily
                  metrics:
                    - posts
                    - followers
                    - net_followers
                    - views
                    - impressions
                  range:
                    start: '2026-09-09'
                    end: '2026-10-08'
                  previous_range:
                    start: '2026-08-10'
                    end: '2026-09-08'
                  current:
                    - start: '2026-09-09'
                      end: '2026-09-09'
                      values:
                        posts: 1
                        followers: 12160
                        net_followers: 4
                        views: 2300
                        impressions: 2900
                  previous:
                    - start: '2026-08-10'
                      end: '2026-08-10'
                      values:
                        posts: 0
                        followers: 11900
                        net_followers: 3
                        views: 0
                        impressions: 0
                  totals:
                    current:
                      posts: 18
                      followers: 12480
                      net_followers: 320
                      views: 48210
                      impressions: 61300
                    previous:
                      posts: 15
                      followers: 12160
                      net_followers: 250
                      views: 39900
                      impressions: 52010
                  growth:
                    range:
                      start: '2025-11-01'
                      end: '2026-10-08'
                    months:
                      - month: 2026-10
                        start: '2026-10-01'
                        end: '2026-10-08'
                        followers: 12480
                        rate: 1.4
                    latest: 1.4
                    previous: null
        '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.
    ChannelInsights:
      type: object
      properties:
        filters:
          $ref: '#/components/schemas/ChannelInsightsFilters'
        available_metrics:
          type: array
          items:
            type: string
          description: >-
            Métricas que este canal informa, na ordem de exibição (`followers`,
            `net_followers`, `posts`, `reactions`, `comments`,
            `engagement_rate`, `views`, `impressions`, `shares`, `reposts`,
            `quotes`, `saves`, `clicks`, `follows_gained`, `reach`,
            `watch_time_minutes`, `average_watch_time_seconds`).
        summary:
          $ref: '#/components/schemas/WorkspaceAnalyticsReport'
          description: >-
            O mesmo formato do relatório do workspace, limitado a este canal.
            Etiquetas, `untagged` e tipos filtram as métricas de posts; os
            seguidores continuam valendo para a conta inteira.
        metric_series:
          type: object
          description: >-
            Séries por intervalo no período e no período anterior. `posts`,
            `reach`, `views`, `impressions` e `profile_visits` são totais dos
            posts publicados em cada intervalo, não totais diários da conta.
            `followers` é a contagem no fim de cada intervalo; `net_followers` é
            acumulado desde o início do período.
          properties:
            resolution:
              type: string
              enum:
                - daily
                - weekly
              description: >-
                Diário até 92 dias e semanal acima disso (as semanas começam no
                início de semana do usuário dono da chave de API).
            metrics:
              type: array
              items:
                type: string
                enum:
                  - posts
                  - followers
                  - net_followers
                  - reach
                  - views
                  - impressions
                  - profile_visits
            range:
              $ref: '#/components/schemas/AnalyticsDateRange'
            previous_range:
              $ref: '#/components/schemas/AnalyticsDateRange'
            current:
              type: array
              items:
                type: object
                properties:
                  start:
                    type: string
                    format: date
                  end:
                    type: string
                    format: date
                  values:
                    type: object
                    additionalProperties:
                      type:
                        - number
                        - 'null'
                    description: >-
                      Valor de cada métrica no intervalo. Sempre traz `posts`,
                      `followers` e `net_followers`, mais as métricas de posts
                      de `metrics`.
            previous:
              type: array
              items:
                type: object
                properties:
                  start:
                    type: string
                    format: date
                  end:
                    type: string
                    format: date
                  values:
                    type: object
                    additionalProperties:
                      type:
                        - number
                        - 'null'
                    description: >-
                      Valor de cada métrica no intervalo. Sempre traz `posts`,
                      `followers` e `net_followers`, mais as métricas de posts
                      de `metrics`.
            totals:
              type: object
              properties:
                current:
                  type: object
                  additionalProperties:
                    type:
                      - number
                      - 'null'
                previous:
                  type: object
                  additionalProperties:
                    type:
                      - number
                      - 'null'
            growth:
              type:
                - object
                - 'null'
              description: >-
                Taxa mensal de crescimento de seguidores nos últimos 12 meses.
                Ignora o período e os filtros de posts. `null` enquanto o
                PostClean não tiver pelo menos duas contagens diárias de
                seguidores do canal.
              properties:
                range:
                  $ref: '#/components/schemas/AnalyticsDateRange'
                months:
                  type: array
                  items:
                    type: object
                    properties:
                      month:
                        type: string
                        examples:
                          - 2026-10
                      start:
                        type: string
                        format: date
                      end:
                        type: string
                        format: date
                      followers:
                        type:
                          - integer
                          - 'null'
                      rate:
                        type:
                          - number
                          - 'null'
                latest:
                  type:
                    - number
                    - 'null'
                  description: Última taxa mensal de crescimento não nula, em percentual.
                previous:
                  type:
                    - number
                    - 'null'
                  description: >-
                    Taxa mensal de crescimento não nula anterior a essa, em
                    percentual.
    ErrorBody:
      type: object
      properties:
        message:
          type: string
      description: Corpo de erro com uma mensagem.
    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.
    WorkspaceAnalyticsReport:
      type: object
      properties:
        bounds:
          type: object
          description: >-
            Primeiro e último dia com dados de análises no escopo (`null` quando
            não há nenhum).
          properties:
            min:
              type:
                - string
                - 'null'
              format: date
            max:
              type:
                - string
                - 'null'
              format: date
        range:
          $ref: '#/components/schemas/AnalyticsDateRange'
        previous_range:
          $ref: '#/components/schemas/AnalyticsDateRange'
        summary:
          $ref: '#/components/schemas/AnalyticsSummary'
        followers:
          type: object
          properties:
            total:
              type:
                - integer
                - 'null'
              description: >-
                `null` quando algum canal conectado do escopo ainda não tem
                contagem de seguidores no período.
            accounts:
              type: array
              items:
                allOf:
                  - $ref: '#/components/schemas/AnalyticsAccountRef'
                  - type: object
                    properties:
                      social_account_id:
                        type:
                          - string
                          - 'null'
                        format: uuid
                        description: >-
                          Id da conta social, ou `null` quando a conta não
                          existe mais.
                      network:
                        type: string
                        description: >-
                          Rede do canal. Variantes da mesma rede têm o mesmo
                          valor: Instagram direto e via Facebook são
                          `instagram`, perfil e página do LinkedIn são
                          `linkedin`.
                      value:
                        type:
                          - integer
                          - 'null'
                        description: Seguidores no fim do período.
                      growth:
                        type:
                          - integer
                          - 'null'
                        description: >-
                          Seguidores ganhos entre a primeira e a última contagem
                          do período.
                      net:
                        type:
                          - integer
                          - 'null'
                        description: >-
                          Saldo de seguidores no período: a última contagem do
                          período menos a última contagem antes dele (ou a
                          primeira do período, quando não há anterior).
                      provenance:
                        type:
                          - string
                          - 'null'
                        enum:
                          - actual
                          - carried_forward
                          - null
                        description: >-
                          `actual` quando a contagem do último dia veio da rede,
                          `carried_forward` quando repete a última contagem
                          conhecida.
            series:
              type: array
              description: >-
                Um ponto por dia do período: seguidores de cada canal, pela
                chave `social_account_key` (`null` num dia sem contagem).
              items:
                type: object
                properties:
                  date:
                    type: string
                    format: date
                  accounts:
                    type: object
                    additionalProperties:
                      type:
                        - integer
                        - 'null'
        posts:
          type: object
          properties:
            resolution:
              type: string
              enum:
                - daily
                - weekly
                - monthly
              description: >-
                Diário até 14 dias, semanal até 90 dias e mensal acima disso. As
                semanas começam no início de semana do usuário dono da chave de
                API.
            accounts:
              type: array
              items:
                allOf:
                  - $ref: '#/components/schemas/AnalyticsAccountRef'
                  - type: object
                    properties:
                      count:
                        type: integer
                        description: Posts publicados no período.
              description: Canais com pelo menos um post no período.
            buckets:
              type: array
              items:
                type: object
                properties:
                  start:
                    type: string
                    format: date
                  end:
                    type: string
                    format: date
                  accounts:
                    type: object
                    additionalProperties:
                      type: integer
                    description: Posts por canal, pela chave `social_account_key`.
                  total:
                    type: integer
        top_posts:
          type: object
          description: >-
            Até 5 posts do período com mais reações e até 5 com mais
            comentários.
          properties:
            reactions:
              type: array
              items:
                $ref: '#/components/schemas/AnalyticsTopPost'
            comments:
              type: array
              items:
                $ref: '#/components/schemas/AnalyticsTopPost'
        performance:
          type: array
          description: >-
            Uma linha por canal com pelo menos um post no período, com cada
            métrica comparada ao período anterior.
          items:
            allOf:
              - $ref: '#/components/schemas/AnalyticsAccountRef'
              - type: object
                properties:
                  posts:
                    $ref: '#/components/schemas/MetricComparison'
                  reactions:
                    $ref: '#/components/schemas/MetricComparison'
                  comments:
                    $ref: '#/components/schemas/MetricComparison'
                  engagement_rate:
                    $ref: '#/components/schemas/MetricComparison'
                  reposts:
                    $ref: '#/components/schemas/MetricComparison'
                  impressions:
                    $ref: '#/components/schemas/MetricComparison'
                  clicks:
                    $ref: '#/components/schemas/MetricComparison'
                  views:
                    $ref: '#/components/schemas/MetricComparison'
                  shares:
                    $ref: '#/components/schemas/MetricComparison'
                  saves:
                    $ref: '#/components/schemas/MetricComparison'
                  follows_gained:
                    $ref: '#/components/schemas/MetricComparison'
                  reach:
                    $ref: '#/components/schemas/MetricComparison'
                  watch_time_minutes:
                    $ref: '#/components/schemas/MetricComparison'
                  average_watch_time_seconds:
                    $ref: '#/components/schemas/MetricComparison'
        coverage:
          type: array
          description: >-
            Até onde as análises já foram coletadas em cada canal conectado.
            Cada canal pode ter uma linha por coletor.
          items:
            type: object
            properties:
              social_account_id:
                type: string
                format: uuid
              collector:
                type: string
                enum:
                  - publication_backfill
                  - publication_discovery
                description: >-
                  `publication_backfill` busca posts antigos;
                  `publication_discovery` acha posts novos.
              status:
                type: string
                enum:
                  - pending
                  - running
                  - complete
                  - partial
                  - provider_limited
                  - failed
              target_since:
                type:
                  - string
                  - 'null'
                format: date-time
                description: >-
                  ISO 8601, em UTC, com microssegundos
                  (`2026-04-11T00:00:00.000000Z`).
              oldest_reached_at:
                type:
                  - string
                  - 'null'
                format: date-time
                description: >-
                  ISO 8601, em UTC, com microssegundos
                  (`2026-04-11T00:00:00.000000Z`).
              high_watermark_at:
                type:
                  - string
                  - 'null'
                format: date-time
                description: >-
                  ISO 8601, em UTC, com microssegundos
                  (`2026-04-11T00:00:00.000000Z`).
              last_success_at:
                type:
                  - string
                  - 'null'
                format: date-time
                description: >-
                  ISO 8601, em UTC, com microssegundos
                  (`2026-04-11T00:00:00.000000Z`).
              last_error_category:
                type:
                  - string
                  - 'null'
                description: Categoria do último erro da coleta, ou `null`.
    AnalyticsDateRange:
      type: object
      description: >-
        Dias corridos no fuso horário do usuário dono da chave de API (as duas
        pontas incluídas).
      properties:
        start:
          type: string
          format: date
        end:
          type: string
          format: date
    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.
    AnalyticsSummary:
      type: object
      description: >-
        Totais do período comparados com o período anterior. `posts` conta os
        posts publicados no período (feitos no PostClean ou não).
        `engagement_rate` é um percentual. `watch_time_minutes` e
        `average_watch_time_seconds` valem para vídeos.
      properties:
        posts:
          $ref: '#/components/schemas/MetricComparison'
        net_followers:
          $ref: '#/components/schemas/MetricComparison'
        reactions:
          $ref: '#/components/schemas/MetricComparison'
        comments:
          $ref: '#/components/schemas/MetricComparison'
        engagement_rate:
          $ref: '#/components/schemas/MetricComparison'
        views:
          $ref: '#/components/schemas/MetricComparison'
        impressions:
          $ref: '#/components/schemas/MetricComparison'
        clicks:
          $ref: '#/components/schemas/MetricComparison'
        reposts:
          $ref: '#/components/schemas/MetricComparison'
        quotes:
          $ref: '#/components/schemas/MetricComparison'
        reach:
          $ref: '#/components/schemas/MetricComparison'
        shares:
          $ref: '#/components/schemas/MetricComparison'
        saves:
          $ref: '#/components/schemas/MetricComparison'
        watch_time_minutes:
          $ref: '#/components/schemas/MetricComparison'
        average_watch_time_seconds:
          $ref: '#/components/schemas/MetricComparison'
        follows_gained:
          $ref: '#/components/schemas/MetricComparison'
        followers:
          type: object
          description: >-
            Seguidores no fim do período. Diferente das outras métricas,
            `change` é a diferença em seguidores, não um percentual. `value` é
            `null` quando algum canal conectado do escopo ainda não tem contagem
            de seguidores no período.
          properties:
            value:
              type:
                - integer
                - 'null'
            previous:
              type:
                - integer
                - 'null'
            change:
              type:
                - integer
                - 'null'
    AnalyticsAccountRef:
      type: object
      description: Identificação de um canal numa linha de análises.
      properties:
        social_account_key:
          type: string
          description: >-
            Chave fixa do canal nas análises. Num canal conectado, é o id da
            conta social.
        platform:
          $ref: '#/components/schemas/Platform'
        name:
          type:
            - string
            - 'null'
        username:
          type:
            - string
            - 'null'
        avatar_url:
          type:
            - string
            - 'null'
        status:
          type:
            - string
            - 'null'
          enum:
            - connected
            - disconnected
            - token_expired
            - null
          description: >-
            Status atual da conexão. `null` quando o canal não está mais no
            workspace.
    AnalyticsTopPost:
      allOf:
        - $ref: '#/components/schemas/AnalyticsAccountRef'
        - type: object
          properties:
            id:
              type: string
              format: uuid
              description: >-
                Id da publicação nas análises. Veja o detalhe com `GET
                /analytics/publications/{publication}`.
            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.
            post_id:
              type:
                - string
                - 'null'
              format: uuid
              description: Post do PostClean, ou `null` num post feito fora do PostClean.
            origin:
              type: string
              enum:
                - trypost
                - external
              description: >-
                `trypost` (publicado pelo PostClean) ou `external` (feito fora
                dele).
            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`, ...).
            availability:
              type: string
              enum:
                - available
                - deleted
                - unavailable
            published_at:
              type:
                - string
                - 'null'
              description: Quando a rede publicou, em UTC, `Y-m-d H:i:s`.
            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`). Os links de miniatura das redes podem expirar.
            reactions:
              type:
                - integer
                - 'null'
              description: Reações na última contagem.
            comments:
              type:
                - integer
                - 'null'
              description: Comentários na última contagem.
    MetricComparison:
      type: object
      description: Uma métrica no período e no período anterior de mesmo tamanho.
      properties:
        value:
          type:
            - number
            - 'null'
          description: >-
            Valor no período. `null` quando nenhum canal do escopo informa esta
            métrica.
        previous:
          type:
            - number
            - 'null'
          description: Valor no período anterior.
        change:
          type:
            - number
            - 'null'
          description: >-
            Variação percentual de `previous` para `value`, arredondada em 2
            casas. `null` quando um dos dois é `null` ou `previous` é 0.
    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.
  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.