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

# Obter insights do template

> Retorna os números de entrega e engajamento da Meta para um template nos últimos `days` dias (7, 30 ou 90; padrão 30): totais de enviadas, entregues e lidas, `readRate` (lidas / entregues, `null` quando nada foi entregue), cliques em botões e uma série diária.

Os dados vêm das análises de templates da Meta: granularidade diária, só os últimos 90 dias, e os dias mais recentes ainda podem estar sendo preenchidos. A primeira chamada para uma conta do WhatsApp Business pode ativar os insights de templates nessa conta, na Meta.

Só templates enviados à Meta têm insights (caso contrário, `409 TEMPLATE_NOT_ON_META`). A Meta não fornece insights de templates para números do app WhatsApp Business / coexistência (`422 TEMPLATE_INSIGHTS_UNAVAILABLE_SMB`). Mesmo acesso do `GET /v1/templates/{id}`: permissão `templates:read`; uma chave com escopo de número só vê templates dos seus números.

**Requer uma chave com escopo de número.**



## OpenAPI

````yaml openapi.pt.json GET /v1/templates/{id}/insights
openapi: 3.1.0
info:
  title: API Pilot Status
  version: 1.0.0
  license:
    name: Pilot Status Terms of Service
    url: https://pilotstatus.com.br/terms
  description: >-
    API REST pública do Pilot Status. Autentique com o header `x-api-key:
    ps_...` (ou `x-api-key-id`). Base URL: https://pilotstatus.com.br
servers:
  - url: https://pilotstatus.com.br
security:
  - apiKey: []
  - apiKeyId: []
paths:
  /v1/templates/{id}/insights:
    get:
      tags:
        - Templates
      summary: Obter insights do template
      description: >-
        Retorna os números de entrega e engajamento da Meta para um template nos
        últimos `days` dias (7, 30 ou 90; padrão 30): totais de enviadas,
        entregues e lidas, `readRate` (lidas / entregues, `null` quando nada foi
        entregue), cliques em botões e uma série diária.


        Os dados vêm das análises de templates da Meta: granularidade diária, só
        os últimos 90 dias, e os dias mais recentes ainda podem estar sendo
        preenchidos. A primeira chamada para uma conta do WhatsApp Business pode
        ativar os insights de templates nessa conta, na Meta.


        Só templates enviados à Meta têm insights (caso contrário, `409
        TEMPLATE_NOT_ON_META`). A Meta não fornece insights de templates para
        números do app WhatsApp Business / coexistência (`422
        TEMPLATE_INSIGHTS_UNAVAILABLE_SMB`). Mesmo acesso do `GET
        /v1/templates/{id}`: permissão `templates:read`; uma chave com escopo de
        número só vê templates dos seus números.


        **Requer uma chave com escopo de número.**
      operationId: get_templates_id_insights
      parameters:
        - name: id
          in: path
          required: true
          description: Id ou nome do template.
          schema:
            type: string
          example: boas_vindas
        - name: days
          in: query
          required: false
          description: >-
            Janela em dias: `7`, `30` ou `90`. Padrão `30`. Qualquer outro valor
            retorna `400 INVALID_DAYS`.
          schema:
            type: integer
            enum:
              - 7
              - 30
              - 90
            default: 30
          example: 30
      responses:
        '200':
          description: Insights do template
          content:
            application/json:
              schema:
                type: object
                required:
                  - templateId
                  - template
                  - days
                  - totals
                  - readRate
                  - clicks
                  - daily
                properties:
                  templateId:
                    type: string
                    description: Id do template.
                  template:
                    type: object
                    description: >-
                      Nome, status, categoria, idioma e nota de qualidade da
                      Meta do template.
                    properties:
                      name:
                        type: string
                      status:
                        type: string
                        description: >-
                          Status do template na Meta. `"UNKNOWN"` quando nem a
                          Meta nem a cópia local informam.
                      category:
                        type: string
                      language:
                        type: string
                        description: >-
                          Idioma do template. `""` (texto vazio) quando nem a
                          Meta nem a cópia local informam.
                      qualityScore:
                        type:
                          - string
                          - 'null'
                        description: >-
                          Nota de qualidade da Meta (ex.: `GREEN`, `YELLOW`,
                          `RED`), ou `null` quando a Meta ainda não avaliou.
                  days:
                    type: integer
                    enum:
                      - 7
                      - 30
                      - 90
                    description: A janela usada.
                  totals:
                    type: object
                    description: Somas na janela.
                    properties:
                      sent:
                        type: integer
                        description: Mensagens enviadas.
                      delivered:
                        type: integer
                        description: Mensagens entregues.
                      read:
                        type: integer
                        description: Mensagens lidas.
                  readRate:
                    type:
                      - number
                      - 'null'
                    description: >-
                      `read / delivered`, de 0 a 1. `null` quando `delivered` é
                      0.
                  clicks:
                    type: array
                    description: Cliques em botões na janela, uma entrada por botão.
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          description: >-
                            Tipo do botão informado pela Meta (ex.:
                            `quick_reply_button`, `url_button`).
                        buttonContent:
                          type: string
                          description: Texto (ou URL) do botão, como a Meta informa.
                        count:
                          type: integer
                          description: Cliques.
                  daily:
                    type: array
                    description: >-
                      Uma entrada por dia da janela, do mais antigo ao mais
                      recente.
                    items:
                      type: object
                      properties:
                        date:
                          type: string
                          format: date
                          description: Dia (UTC), `YYYY-MM-DD`.
                        sent:
                          type: integer
                          description: Mensagens enviadas.
                        delivered:
                          type: integer
                          description: Mensagens entregues.
                        read:
                          type: integer
                          description: Mensagens lidas.
              example:
                templateId: tpl_01HZX...
                template:
                  name: boas_vindas
                  status: APPROVED
                  category: UTILITY
                  language: pt_BR
                  qualityScore: GREEN
                days: 7
                totals:
                  sent: 1240
                  delivered: 1198
                  read: 873
                readRate: 0.7287
                clicks:
                  - type: quick_reply_button
                    buttonContent: Quero saber mais
                    count: 112
                  - type: url_button
                    buttonContent: https://exemplo.com.br/oferta
                    count: 64
                daily:
                  - date: '2026-10-22'
                    sent: 180
                    delivered: 175
                    read: 130
                  - date: '2026-10-23'
                    sent: 172
                    delivered: 166
                    read: 121
                  - date: '2026-10-24'
                    sent: 190
                    delivered: 184
                    read: 139
                  - date: '2026-10-25'
                    sent: 160
                    delivered: 155
                    read: 110
                  - date: '2026-10-26'
                    sent: 178
                    delivered: 171
                    read: 124
                  - date: '2026-10-27'
                    sent: 185
                    delivered: 180
                    read: 129
                  - date: '2026-10-28'
                    sent: 175
                    delivered: 167
                    read: 120
        '400':
          description: '`days` não é 7, 30 nem 90'
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
                    enum:
                      - INVALID_DAYS
              example:
                error: days must be one of 7, 30 or 90. | days deve ser 7, 30 ou 90.
                code: INVALID_DAYS
        '401':
          description: Header `x-api-key` / `x-api-key-id` ausente ou inválido
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Unauthorized
        '403':
          description: Chave com escopo de tenant usada em endpoint com escopo de número
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Tenant-scoped keys cannot call number endpoints
                code: TENANT_SCOPE_NOT_ALLOWED
        '404':
          description: Template não encontrado no escopo da chave
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
                    enum:
                      - TEMPLATE_NOT_FOUND
              example:
                error: Template not found. | Template não encontrado.
                code: TEMPLATE_NOT_FOUND
        '409':
          description: >-
            O template não está na Meta, ou não há número Meta conectado para a
            conta do WhatsApp Business dele
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
                    enum:
                      - TEMPLATE_NOT_ON_META
                      - NO_META_NUMBER_FOR_WABA
              examples:
                TEMPLATE_NOT_ON_META:
                  summary: Template não enviado à Meta
                  value:
                    error: >-
                      This template was not submitted to Meta, so it has no
                      insights. | Este template não foi enviado à Meta, então
                      não tem insights.
                    code: TEMPLATE_NOT_ON_META
                NO_META_NUMBER_FOR_WABA:
                  summary: Nenhum número Meta para a WABA do template
                  value:
                    error: >-
                      No connected Meta number on this template's WABA.
                      Reconnect a number to view insights. | Nenhum número Meta
                      conectado na WABA deste template. Reconecte um número para
                      ver os insights.
                    code: NO_META_NUMBER_FOR_WABA
        '422':
          description: A Meta não fornece insights para esta conta, ou recusou o pedido
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
                    enum:
                      - TEMPLATE_INSIGHTS_UNAVAILABLE_SMB
                      - META_REJECTED
              examples:
                TEMPLATE_INSIGHTS_UNAVAILABLE_SMB:
                  summary: Conta do app WhatsApp Business / coexistência
                  value:
                    error: >-
                      Meta does not provide template insights for WhatsApp
                      Business App (SMB / coexistence) accounts. | A Meta não
                      oferece insights de template para contas do WhatsApp
                      Business App (SMB / coexistência).
                    code: TEMPLATE_INSIGHTS_UNAVAILABLE_SMB
                META_REJECTED:
                  summary: A Meta recusou o pedido
                  value:
                    error: >-
                      Meta rejected the template insights request: (#100)
                      Invalid parameter | A Meta recusou o pedido de insights do
                      template.
                    code: META_REJECTED
        '429':
          description: Limite de taxa excedido
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Too many requests
        '500':
          description: Erro interno
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
                    enum:
                      - INTERNAL_ERROR
              example:
                error: Internal server error | Erro interno do servidor
                code: INTERNAL_ERROR
        '503':
          description: A Meta está temporariamente indisponível — tente de novo mais tarde
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
                    enum:
                      - META_UNAVAILABLE
              example:
                error: >-
                  Meta is unavailable right now. Try again in a few minutes. | A
                  Meta está indisponível no momento. Tente novamente em alguns
                  minutos.
                code: META_UNAVAILABLE
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: Sua chave de API ps_
    apiKeyId:
      type: apiKey
      in: header
      name: x-api-key-id
      description: Id da chave de API (alternativa ao x-api-key)

````

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