Métricas

O que é

A API de Métricas do Magalu Ads permite consultar o desempenho de campanhas publicitárias gerenciadas na plataforma de anúncios do Magalu. Ela expõe métricas agregadas e diárias em três granularidades: por seller, por campanha e por produto dentro de uma campanha.

Com essa API, você pode:

• Consultar as métricas agregadas de um intervalo de datas, informado em start_date e end_date (formato AAAA-MM-DD). As duas datas são inclusivas, e um intervalo de um único dia é aceito (start_date igual a end_date).
• Acompanhar a série histórica, dia a dia, com paginação por cursor (o campo next indica a próxima página).
• Detalhar impressões, cliques e compras, incluindo os valores efetivamente cobrados e o gasto em anúncios atribuído a cada evento.
• Avaliar os leilões (auctions) disputados pelo seller.
• Acompanhar indicadores consolidados de eficiência, descritos abaixo.

Os campos seguem o padrão snake_case, e os valores monetários são em Reais (BRL), em centavos. Por exemplo, 1050 equivale a R$ 10,50.

Em caso de falha, a resposta segue a estrutura de erros das APIs do portal.

Escopos necessários

Para a utilização das APIs os seguintes escopos poderão ser necessários:

Valor	Descrição
open:ads-metrics-seller:read	Permite a leitura das métricas de desempenho de campanhas.

Se o token for válido mas a conta não tiver um seller de Ads habilitado, a API retorna 403.

Indicadores

Indicadores consolidados retornados em cada relatório de métricas:

Campo	Indicador
roas	Retorno sobre o investimento em anúncios (Return on Ad Spend).
acos	Custo de publicidade sobre a venda (Advertising Cost of Sale).
ctr	Taxa de cliques (Click-Through Rate).
cvr	Taxa de conversão (Conversion Rate).
cpc	Custo médio por clique, em valor monetário (centavos, em BRL).

Ambientes

Ambientes disponíveis: Ambientes