Partner Reports

E-commerce (GA4)

Os eventos de e-commerce que o site enviou ao Google Analytics 4 para o evento — funil de compra item a item, com a origem de tráfego da sessão.

Listar eventos de e-commerce do evento

GET/v1/reports/organizations/{organizationId}/events/{eventId}/ecommerce-items

Página dos eventos de e-commerce enviados ao GA4 — view_item, add_to_cart, begin_checkout, add_payment_info e purchase —, 1 linha por item de cada evento, do mais recente para o mais antigo, com a origem de tráfego da sessão (traffic_* = último clique da sessão; collected_* = UTM coletada no próprio evento). A fonte é recarregada de hora em hora conforme a diária do export do GA4 chega (D+1, entre 08h e 24h BRT).

A resposta usa o envelope de paginação { items, total, page, page_size }, como /events e /orders.

ParâmetroTipoDescrição
pageOpcional
integerPágina a retornar. Padrão 1.
page_sizeOpcional
integerItens por página. Padrão 20, máximo 200 (acima é rebaixado).
date_fromOpcional
stringInício da janela sobre event_date, YYYY-MM-DD, inclusivo. Sem date_from vale a janela default: os últimos 30 dias (UTC, hoje incluído). Para o histórico completo, informe date_from explícito — o export começa em 2026-08-17.
date_toOpcional
stringFim da janela sobre event_date, YYYY-MM-DD, inclusivo.
event_nameOpcional
stringFiltra por um dos cinco nomes: view_item, add_to_cart, begin_checkout, add_payment_info, purchase. Outro valor retorna 400 listando os aceitos.

Sem modo cursor — incremental é pela janela de datas

O GA4 não tem id de linha, então não existe chave única para um cursor retomar — limit/cursor neste endpoint retornam 400. Para leitura incremental use date_from/date_to: o GA4 reescreve a diária por até 2 dias além de hoje, então reler os últimos 3 dias a cada ciclo cobre os eventos atrasados. Dentro de um dia a ordenação é determinística, então páginas adjacentes não se sobrepõem.

Janela default de 30 dias

A janela de datas é a alavanca de custo da consulta: sem date_from, a API aplica os últimos 30 dias automaticamente. Prefira sempre janelas explícitas e curtas — elas cobrem o período de venda da maioria dos eventos e mantêm a chamada rápida conforme a base cresce.

Objeto de item de e-commerce

CampoTipoDescrição
event_date
stringDia do export do GA4 (YYYY-MM-DD) — é sobre ele que date_from/date_to filtram.
event_timestamp
integerInstante do evento no GA4, em microssegundos UTC desde a época (valor cru).
event_at
stringO mesmo instante como TIMESTAMP UTC com sufixo +00 — o formato de /tickets e /bundles —, para quem não quer converter microssegundos.
event_name
stringUm dos cinco: view_item, add_to_cart, begin_checkout, add_payment_info, purchase.
user_pseudo_id
stringClient id pseudônimo do GA4. Com ga_session_id, identifica a sessão.
user_id
stringId do usuário logado no site — o mesmo identificador que /orders já expõe. É o único dado pessoal deste relatório.
ga_session_id
integerId da sessão do GA4.
device_category
stringCategoria do dispositivo (ex.: mobile, desktop).
geo_country
stringPaís da sessão segundo o GA4.
transaction_id
stringId da transação nos eventos de compra, quando houver.
traffic_source
stringOrigem de tráfego da sessão — último clique (source).
traffic_medium
stringOrigem de tráfego da sessão — último clique (medium).
traffic_campaign_name
stringOrigem de tráfego da sessão — último clique (campanha).
traffic_content
stringOrigem de tráfego da sessão — último clique (content).
traffic_term
stringOrigem de tráfego da sessão — último clique (term).
collected_campaign_name
stringUTM coletada no próprio evento (campanha).
collected_content
stringUTM coletada no próprio evento (content).
collected_term
stringUTM coletada no próprio evento (term).
currency
stringMoeda de event_value e price (ex.: BRL).
event_value
numberValor do EVENTO (carrinho/pedido), decimal na moeda de currency, repetido em cada linha de item — não some por linha; agregue por (user_pseudo_id, event_timestamp, event_name).
platform
stringDe qual site a linha veio: awa ou legacy.
legacy_event_id
integerId legado do evento (0 no AWA).
event_id
stringId AWA do evento — o mesmo de /events, inclusive para evento legado migrado.
item_name
stringNome do item (ingresso/combo/produto) enviado ao GA4.
item_variant
stringVariante do item (ex.: lote).
item_category
stringCategoria do item no GA4 (níveis 1 a 5 em item_category…item_category5).
item_category2 … item_category5
stringDemais níveis da categoria, quando enviados.
price
numberPreço unitário do ITEM, decimal na moeda de currency.
quantity
integerQuantidade do item no evento.

Valores decimais — exceção à convenção de centavos

Diferente dos demais relatórios (que usam inteiros em centavos), price e event_value vêm como decimais na moeda indicada em currency, como o GA4 os registra: R$ 150,00 = 150.0.

Exemplo

Compras de um período, 1 linha por item
GET .../ecommerce-items?event_name=purchase&date_from=2026-09-01&date_to=2026-09-03&page_size=200

{
  "items": [
    {
      "event_date": "2026-09-03",
      "event_timestamp": 1788470142123456,
      "event_at": "2026-09-03 21:15:42.123456+00",
      "event_name": "purchase",
      "user_pseudo_id": "1234567890.1726000000",
      "user_id": "98765",
      "ga_session_id": 1726000001,
      "device_category": "mobile",
      "geo_country": "Brazil",
      "transaction_id": "9b8c7d6e-5f4a-4b3c-8d2e-1f0a9b8c7d6e",
      "traffic_source": "instagram",
      "traffic_medium": "paid_social",
      "traffic_campaign_name": "lancamento-festival-2026",
      "traffic_content": "stories-video",
      "traffic_term": "",
      "collected_campaign_name": "lancamento-festival-2026",
      "collected_content": "stories-video",
      "collected_term": "",
      "currency": "BRL",
      "event_value": 300.0,
      "platform": "awa",
      "legacy_event_id": 0,
      "event_id": "3e5f7a90-1b2c-4d6e-8f90-a1b2c3d4e5f6",
      "item_name": "Pista Inteira",
      "item_variant": "1º Lote",
      "item_category": "Pista",
      "item_category2": "",
      "item_category3": "",
      "item_category4": "",
      "item_category5": "",
      "price": 150.0,
      "quantity": 2
    }
  ],
  "total": 1234,
  "page": 1,
  "page_size": 200
}