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

# Taxa de conversão por campanha

> Percentual de conversão de cada campanha: conversões ÷ mensagens enviadas × 100, já calculado

Retorna, para cada campanha, a **taxa de conversão em percentual** — conversões ÷ mensagens enviadas × 100, arredondada em duas casas: `{ "items": [{ "campaignId": 12, "campaignName": "Volte a pedir!", "value": 4.19 }] }`.

<Info>
  Esta métrica cobre o **histórico completo** da campanha e não aceita `from`/`to`. Campanhas sem mensagens enviadas retornam `value: 0`.
</Info>

<Tip>
  É o atalho para "qual campanha converte melhor?" — sem precisar cruzar [Conversões](/crm-parceiro/conversoes) com [Estatísticas de campanha](/crm-parceiro/estatisticas-de-campanha) por conta própria.
</Tip>

## Erros

| HTTP  | `code` no corpo | Quando acontece                            | O que fazer                                                            |
| ----- | --------------- | ------------------------------------------ | ---------------------------------------------------------------------- |
| `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="Campanhas" icon="megaphone" href="/crm-parceiro/campanhas">
  O cadastro por trás de cada `campaignId`.
</Card>


## OpenAPI

````yaml openapi.yaml GET /v1/stores/{merchantId}/metrics/campaign-conversion-rate
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/campaign-conversion-rate:
    get:
      tags:
        - Métricas
      summary: Taxa de conversão por campanha
      description: >-
        Taxa de conversão de cada campanha em percentual — conversões ÷
        mensagens enviadas × 100, arredondada em duas casas. Histórico completo;
        não aceita from/to.
      operationId: getMetricCampaignConversionRate
      parameters:
        - $ref: '#/components/parameters/MerchantIdPath'
      responses:
        '200':
          description: Taxa de conversão por campanha, em percentual.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CampaignMetricDecimalResponse'
              example:
                items:
                  - campaignId: 12
                    campaignName: Volte a pedir!
                    value: 4.19
        '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
  schemas:
    CampaignMetricDecimalResponse:
      type: object
      properties:
        items:
          type: array
          items:
            type: object
            properties:
              campaignId:
                type: integer
                format: int32
              campaignName:
                type: string
              value:
                type: number
    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:
    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>`.

````