Skip to main content
GET
Receita gerada
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, já calculada.
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.
Para separar quanto veio de clientes reativados e quanto veio de clientes já ativos, use Receita recuperada e Receita recorrente — as duas somadas cobrem o mesmo universo desta métrica.

Erros

Receita por campanha

A mesma receita, quebrada por campanha.

Autorizações

Authorization
string
header
obrigatório

Token de acesso emitido por POST /od/v2/oauth/token (fluxo client_credentials). Envie no header Authorization como Bearer <token>.

Parâmetros de caminho

merchantId
string<uuid>
obrigatório

Identificador (UUID) do merchant — o mesmo id de GET /od/v2/merchants.

Parâmetros de consulta

from
string<date>
obrigatório

Início do período (data, inclusive). Obrigatório.

to
string<date>
obrigatório

Fim do período (data, inclusive). Obrigatório.

Resposta

Receita das conversões do período.

value
number

Valor da métrica, em reais ou percentual conforme a rota.