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

# Receita gerada

> Soma do valor das conversões no período — quanto o relacionamento com o cliente vendeu

Retorna a **soma do valor das conversões** da loja no período: `{ "value": 12874.50 }`. É a receita atribuída ao relacionamento com o cliente — a soma dos `amount` de [Conversões](/crm-parceiro/conversoes), já calculada.

<Info>
  `from` e `to` são **obrigatórios** (datas, inclusivas nas duas pontas). O valor é decimal em reais — diferente do Open Delivery, aqui **não** é em centavos.
</Info>

<Tip>
  Para separar quanto veio de clientes reativados e quanto veio de clientes já ativos, use [Receita recuperada](/metricas/receita-recuperada) e [Receita recorrente](/metricas/receita-recorrente) — as duas somadas cobrem o mesmo universo desta métrica.
</Tip>

## Erros

| HTTP  | `code` no corpo | Quando acontece                                          | O que fazer                                                            |
| ----- | --------------- | -------------------------------------------------------- | ---------------------------------------------------------------------- |
| `400` | `BAD_REQUEST`   | `from`/`to` ausentes, mal formatados ou janela invertida | Corrija o parâmetro indicado em `details`                              |
| `401` | `UNAUTHORIZED`  | Token ausente, inválido ou expirado                      | Gere um novo token em [Obter token](/open-delivery/obter-token)        |
| `403` | `FORBIDDEN`     | Token sem o escopo exigido pela rota                     | Confirme as permissões da credencial com a Repediu                     |
| `404` | `NOT_FOUND`     | Merchant inexistente **ou fora do escopo**               | Confirme o `id` em [Listar merchants](/open-delivery/listar-merchants) |

<Card title="Receita por campanha" icon="chart-column" href="/metricas/receita-por-campanha">
  A mesma receita, quebrada por campanha.
</Card>


## OpenAPI

````yaml openapi.yaml GET /v1/stores/{merchantId}/metrics/total-revenue-generated
openapi: 3.0.1
info:
  title: Repediu — API de integração
  description: >-
    API de integração da Repediu: rotas Open Delivery 2.0 (capabilities CRM),
    dado bruto do CRM do parceiro (/v1/stores) e métricas agregadas
    (/v1/stores/.../metrics). A autenticação usa o fluxo client_credentials: o
    token identifica a aplicação integradora e dá acesso a todos os
    estabelecimentos (merchants) que ativaram a integração.
  version: v2
servers:
  - url: https://public-api.repediu.com.br
    description: Produção
security:
  - Bearer: []
paths:
  /v1/stores/{merchantId}/metrics/total-revenue-generated:
    get:
      tags:
        - Métricas
      summary: Receita gerada
      description: Soma do valor das conversões no período, em reais (decimal).
      operationId: getMetricTotalRevenueGenerated
      parameters:
        - $ref: '#/components/parameters/MerchantIdPath'
        - $ref: '#/components/parameters/MetricsFrom'
        - $ref: '#/components/parameters/MetricsTo'
      responses:
        '200':
          description: Receita das conversões do período.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetricDecimalValueResponse'
              example:
                value: 12874.5
        '400':
          $ref: '#/components/responses/MetricsPeriodRequired'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/InsufficientScope'
        '404':
          $ref: '#/components/responses/MerchantNotFound'
components:
  parameters:
    MerchantIdPath:
      name: merchantId
      in: path
      required: true
      description: Identificador (UUID) do merchant — o mesmo id de GET /od/v2/merchants.
      schema:
        type: string
        format: uuid
    MetricsFrom:
      name: from
      in: query
      required: true
      description: Início do período (data, inclusive). Obrigatório.
      schema:
        type: string
        format: date
    MetricsTo:
      name: to
      in: query
      required: true
      description: Fim do período (data, inclusive). Obrigatório.
      schema:
        type: string
        format: date
  schemas:
    MetricDecimalValueResponse:
      type: object
      properties:
        value:
          type: number
          description: Valor da métrica, em reais ou percentual conforme a rota.
    ErrorResponse:
      type: object
      properties:
        code:
          type: string
          description: >-
            Código do erro (BAD_REQUEST, UNAUTHORIZED, FORBIDDEN, NOT_FOUND,
            INTERNAL_SERVER_ERROR).
        message:
          type: string
        details:
          type: array
          nullable: true
          description: Lista de mensagens de validação, quando aplicável.
          items:
            type: string
  responses:
    MetricsPeriodRequired:
      description: from/to ausentes, mal formatados ou janela invertida.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            code: BAD_REQUEST
            message: One or more validation errors occurred
            details:
              - from is required
              - to is required
    Unauthorized:
      description: Token ausente, inválido ou expirado.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            code: UNAUTHORIZED
            message: Invalid client credentials.
            details: null
    InsufficientScope:
      description: Token sem o escopo exigido pela rota.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            code: FORBIDDEN
            message: The access token does not have the required scope.
            details: null
    MerchantNotFound:
      description: Merchant inexistente ou fora do escopo da aplicação.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            code: NOT_FOUND
            message: Merchant not found.
            details: null
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Token de acesso emitido por POST /od/v2/oauth/token (fluxo
        client_credentials). Envie no header Authorization como `Bearer
        <token>`.

````