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.

Objetivos da API

A API foi projetada para atender simultaneamente aos seguintes objetivos:

• Permitir a consulta de métricas agregadas de um seller, de uma campanha ou de um produto específico dentro de uma campanha, em um intervalo de datas.
• Permitir a consulta da série histórica (dia a dia) dessas mesmas métricas, com paginação por cursor.
• Detalhar volume de impressões, cliques e compras, incluindo os valores efetivamente cobrados e o gasto em anúncios atribuído a cada evento.
• Expor métricas de desempenho de leilão (auctions) no nível de seller.
• Calcular indicadores consolidados de eficiência: ROAS, ACOS, CTR, CVR e CPC médio.

Domínios da Solução

Domínio	Descrição
MetricsReport	Métricas agregadas de um seller ou de uma campanha em um intervalo de datas.
ProductMetricsReport	Métricas agregadas de um produto específico dentro de uma campanha.
DailyMetricsPage	Página paginada por cursor com a quebra dia a dia das métricas.
DailyMetricsReport	Métricas de um único dia dentro de um intervalo de datas.
EventMetrics	Contagem de um evento (impressão ou clique) e os valores monetários associados.
PurchaseMetrics	Volume e valor das compras atribuídas aos anúncios.
AuctionMetrics	Resultado dos leilões de anúncios disputados pelo seller.
Money	Valor monetário representado em unidades inteiras, sempre em Reais (BRL).

Detalhamento dos Campos

MetricsReport

Campo	Tipo	Descrição
impressions	EventMetrics	Métricas de impressões dos anúncios.
clicks	EventMetrics	Métricas de cliques nos anúncios.
purchases	PurchaseMetrics	Métricas de compras atribuídas aos anúncios.
auctions	AuctionMetrics	Resultado dos leilões disputados (apenas na consulta por seller).
roas	Number	Retorno sobre o investimento em anúncios (Return on Ad Spend).
acos	Number	Custo de publicidade sobre a venda (Advertising Cost of Sale).
ctr	Number	Taxa de cliques (Click-Through Rate).
cvr	Number	Taxa de conversão (Conversion Rate).
cpc	Money	Custo médio por clique.

ProductMetricsReport

Campo	Tipo	Descrição
productId	String	Identificador (SKU) do produto.
impressions	EventMetrics	Métricas de impressões dos anúncios do produto.
clicks	EventMetrics	Métricas de cliques nos anúncios do produto.
purchases	PurchaseMetrics	Métricas de compras atribuídas ao produto.
roas	Number	Retorno sobre o investimento em anúncios.
acos	Number	Custo de publicidade sobre a venda.
ctr	Number	Taxa de cliques.
cvr	Number	Taxa de conversão.
cpc	Money	Custo médio por clique.

DailyMetricsPage

Campo	Tipo	Descrição
items	Array<DailyMetricsReport>	Lista de relatórios diários dentro da página atual.
nextPage	String	Cursor opaco para buscar a próxima página, quando houver.

DailyMetricsReport

Campo	Tipo	Descrição
date	String (data)	Dia a que as métricas se referem.
impressions	EventMetrics	Métricas de impressões do dia.
clicks	EventMetrics	Métricas de cliques do dia.
purchases	PurchaseMetrics	Métricas de compras do dia.
roas	Number	Retorno sobre o investimento em anúncios no dia.
acos	Number	Custo de publicidade sobre a venda no dia.
ctr	Number	Taxa de cliques no dia.
cvr	Number	Taxa de conversão no dia.
cpc	Money	Custo médio por clique no dia.

EventMetrics

Campo	Tipo	Descrição
total	Integer	Número total de vezes que o evento ocorreu.
charged	Money	Valor efetivamente cobrado pelo evento.
adSpent	Money	Gasto em anúncios atribuído ao evento.

PurchaseMetrics

Campo	Tipo	Descrição
amount	Money	Valor total de compras atribuído aos anúncios.
quantityEvents	Integer	Número de eventos de compra.
quantityItems	Integer	Número de itens comprados nesses eventos.

AuctionMetrics

Campo	Tipo	Descrição
percentageWon	Number	Percentual de leilões vencidos, como razão entre 0 e 1.
won	Integer	Número de leilões vencidos.
lost	Integer	Número de leilões perdidos.

Money

Campo	Tipo	Descrição
currencyCode	String	Moeda do valor. Atualmente restrita a BRL.
amount	Integer	Valor monetário representado em unidades inteiras.

Ambientes

Ambientes disponíveis: Ambientes