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

# Todos os produtos

> Vendas, acessos e conversão da conta inteira, dia a dia e por produto.

#### Escopo

```bash theme={null}
    read analytics
```

Comparação automática com o período anterior de mesmo tamanho. A lista `products` traz os 200 produtos que mais faturaram; `productCount` diz quantos tiveram movimento. Para o detalhe de um produto, use [Analytics de um produto](https://docs.cakto.com.br/api-reference/analytics/product.md). Veja a [visão geral](https://docs.cakto.com.br/api-reference/analytics/overview.md) para o que muda com o Meta Ads conectado.


## OpenAPI

````yaml GET /public_api/analytics/
openapi: 3.0.3
info:
  title: Cakto API
  version: 1.0.0
  description: Documentação da API pública do Cakto.
servers:
  - url: https://api.cakto.com.br
    description: Cakto API
security: []
paths:
  /public_api/analytics/:
    get:
      tags:
        - analytics
      summary: Analytics de todos os produtos
      description: >-
        Vendas, acessos ao checkout e conversão da conta inteira no período,
        comparados com o período anterior de mesmo tamanho, dia a dia e por
        produto (os 200 que mais faturaram; `productCount` diz quantos tiveram
        movimento). Até 12 meses por consulta. Toda resposta traz `metaAds`, o
        indicador da conexão com o Meta Ads.
      operationId: analytics_overview
      parameters:
        - in: query
          name: startDate
          schema:
            type: string
            format: date
          description: >-
            Primeiro dia do período (`AAAA-MM-DD`, horário de Brasília). Sem
            ele, o período termina em `endDate` e tem 30 dias.
        - in: query
          name: endDate
          schema:
            type: string
            format: date
          description: >-
            Último dia do período, incluído (`AAAA-MM-DD`). Sem ele, hoje. O
            período vai até 12 meses (366 dias).
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnalyticsOverview'
              examples:
                Conta com o Meta conectado:
                  $ref: '#/components/examples/AnalyticsOverviewExample'
          description: ''
        '400':
          description: Período ou plataforma inválidos.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnalyticsError'
              examples:
                Data inválida:
                  value:
                    detail: Datas inválidas. Use YYYY-MM-DD.
                Período invertido:
                  value:
                    detail: startDate maior que endDate.
                Acima de 12 meses:
                  value:
                    detail: Intervalo máximo de 366 dias.
                Plataforma inválida:
                  value:
                    detail: Plataforma inválida.
        '401':
          description: Request não autenticado devido à ausência ou invalidez do token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
              examples:
                Token ausente ou inválido:
                  $ref: '#/components/examples/UnauthenticatedErrorExample'
        '403':
          description: >-
            O token não tem o escopo `analytics`, ou o Cakto Analytics não está
            liberado para a conta.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnalyticsError'
              examples:
                Analytics não liberado:
                  value:
                    detail: Cakto Analytics não liberado para esta conta.
        '429':
          description: >-
            Passou do limite de 60 consultas por minuto. Espere os segundos do
            cabeçalho `Retry-After`.
        '503':
          description: A consulta passou do tempo. Tente de novo ou peça um período menor.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnalyticsError'
              examples:
                Demorou demais:
                  value:
                    detail: >-
                      A visão geral demorou demais. Tente de novo ou um período
                      menor.
      security:
        - OAuth Token: []
components:
  schemas:
    AnalyticsOverview:
      type: object
      properties:
        period:
          $ref: '#/components/schemas/AnalyticsPeriod'
        totals:
          $ref: '#/components/schemas/AnalyticsOverviewTotals'
        previousTotals:
          $ref: '#/components/schemas/AnalyticsOverviewTotals'
        daily:
          type: array
          description: Um item por dia do período, inclusive os dias sem movimento.
          items:
            $ref: '#/components/schemas/AnalyticsOverviewDay'
        products:
          type: array
          description: >-
            Os produtos com acesso ou venda em um dos dois períodos, do que mais
            faturou para o que menos faturou. No máximo 200.
          items:
            $ref: '#/components/schemas/AnalyticsOverviewProduct'
        productCount:
          type: integer
          description: >-
            Quantos produtos tiveram movimento, inclusive os que passaram dos
            200 da lista.
        metaAds:
          $ref: '#/components/schemas/AnalyticsMetaAds'
    AnalyticsError:
      type: object
      properties:
        detail:
          type: string
        code:
          type: string
          description: >-
            `PRO_REQUIRED` quando a rota é do Cakto Analytics Pro e a conta não
            o tem.
    UnauthenticatedError:
      type: object
      properties:
        detail:
          type: string
    AnalyticsPeriod:
      type: object
      description: >-
        O período consultado e o anterior, de mesmo tamanho, usado na
        comparação.
      properties:
        startDate:
          type: string
          format: date
        endDate:
          type: string
          format: date
        previousStartDate:
          type: string
          format: date
        previousEndDate:
          type: string
          format: date
    AnalyticsOverviewTotals:
      type: object
      description: >-
        Totais da oferta principal (order bump, upsell e downsell ficam no
        produto onde o comprador entrou). Valores em reais; venda em outra moeda
        conta no número de vendas, não no faturamento.
      properties:
        checkoutViews:
          type: integer
          description: Acessos ao checkout.
        pageViews:
          type: integer
          description: >-
            Acessos à página de vendas com o script do Analytics. Zero sem o
            script.
        paidCount:
          type: integer
          description: Vendas aprovadas.
        grossAmount:
          type: number
          description: Faturamento bruto das vendas aprovadas, em reais.
        refundCount:
          type: integer
        refundAmount:
          type: number
        chargebackCount:
          type: integer
        conversionRate:
          type: number
          description: Vendas sobre acessos ao checkout, em percentual.
        averageTicket:
          type: number
          description: Ticket médio, em reais.
    AnalyticsOverviewDay:
      type: object
      properties:
        date:
          type: string
          format: date
        checkoutViews:
          type: integer
        pageViews:
          type: integer
        paidCount:
          type: integer
        grossAmount:
          type: number
        conversionRate:
          type: number
    AnalyticsOverviewProduct:
      allOf:
        - $ref: '#/components/schemas/AnalyticsOverviewTotals'
        - type: object
          properties:
            id:
              type: string
              description: >-
                Id do produto. Use em
                `/public_api/analytics/products/{product_id}/`.
            name:
              type: string
            image:
              type: string
              nullable: true
            previousPaidCount:
              type: integer
            previousGrossAmount:
              type: number
    AnalyticsMetaAds:
      type: object
      description: >-
        Indicador da conexão com o Meta Ads. Vem em toda resposta de Analytics,
        com ou sem conexão.
      properties:
        connected:
          type: boolean
          description: >-
            `true` quando a conta tem o Meta Ads conectado e o custo dos
            anúncios entra nas campanhas. Com `false`, os números de venda vêm
            inteiros e só o custo fica de fora.
        status:
          type: string
          nullable: true
          enum:
            - active
            - expired
            - null
          description: >-
            `active`: a leitura do gasto está em dia. `expired`: o Meta recusou
            o token (venceu, senha trocada, permissão removida) e é preciso
            reconectar no painel; o gasto já lido continua valendo até
            `lastSyncedAt`. `null` sem conexão.
        adAccounts:
          type: array
          description: Contas de anúncio lidas da conexão.
          items:
            $ref: '#/components/schemas/AnalyticsMetaAdAccount'
        adAccount:
          type: string
          nullable: true
          description: >-
            A conta de anúncio filtrada em `adAccount`, quando ela é da conexão.
            `null` = todas.
        lastSyncedAt:
          type: string
          format: date-time
          nullable: true
          description: >-
            Última leitura do gasto no Meta. O gasto dos três últimos dias é
            relido de hora em hora, porque o Meta ainda o ajusta.
      required:
        - connected
        - status
        - adAccounts
        - adAccount
        - lastSyncedAt
    AnalyticsMetaAdAccount:
      type: object
      properties:
        id:
          type: string
          description: Id da conta de anúncio no Meta (`act_...`).
        name:
          type: string
        currency:
          type: string
          description: Moeda da conta de anúncio (ISO 4217).
  examples:
    AnalyticsOverviewExample:
      summary: Conta com o Meta conectado
      value:
        period:
          startDate: '2026-11-01'
          endDate: '2026-11-02'
          previousStartDate: '2026-10-30'
          previousEndDate: '2026-10-31'
        totals:
          checkoutViews: 1840
          pageViews: 5210
          paidCount: 92
          grossAmount: 18308
          refundCount: 3
          refundAmount: 597
          chargebackCount: 0
          conversionRate: 5
          averageTicket: 199
        previousTotals:
          checkoutViews: 1702
          pageViews: 4980
          paidCount: 81
          grossAmount: 16119
          refundCount: 2
          refundAmount: 398
          chargebackCount: 1
          conversionRate: 4.76
          averageTicket: 199
        daily:
          - date: '2026-11-01'
            checkoutViews: 950
            pageViews: 2700
            paidCount: 49
            grossAmount: 9751
            conversionRate: 5.16
          - date: '2026-11-02'
            checkoutViews: 890
            pageViews: 2510
            paidCount: 43
            grossAmount: 8557
            conversionRate: 4.83
        products:
          - id: 4f1c2a9e-7d1b-4e34-9a7e-1c2b3d4e5f60
            name: Curso Completo
            image: null
            checkoutViews: 1840
            pageViews: 5210
            paidCount: 92
            grossAmount: 18308
            refundCount: 3
            refundAmount: 597
            chargebackCount: 0
            conversionRate: 5
            averageTicket: 199
            previousPaidCount: 81
            previousGrossAmount: 16119
        productCount: 1
        metaAds:
          connected: true
          status: active
          adAccounts:
            - id: act_123456789
              name: Conta principal
              currency: BRL
          adAccount: null
          lastSyncedAt: '2026-11-02T21:00:04.112Z'
    UnauthenticatedErrorExample:
      summary: Token ausente ou inválido
      description: Token ausente ou inválido
      value:
        detail: As credenciais de autenticação não foram fornecidas.
  securitySchemes:
    OAuth Token:
      type: http
      scheme: bearer
      in: header
      name: Authorization
      description: >-
        Token de autenticação do tipo `Bearer {access_token}`, onde
        `{access_token}` é o token obtido no fluxo de
        [autenticação](/authentication).

````

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