API: Módulo Relatórios (visits)

Ler os mesmos relatórios de visitas, comportamento e resultados da tela #visit.main.

Publicado em 22/08/2026
Atualizado em 08/10/2026
Equipe do Interago

O módulo visits devolve os mesmos dados da tela #visit.main (extensão Relatórios de Visitas).

⚠️ A API precisa estar habilitada para utilizá-la. Veja o passo a passo em API - Como habilitar.

Endpoint: https://app.interago.com.br/App/Api/index.php

Todas as chamadas são POST com:

Cabeçalho Authorization: Bearer SEU_TOKEN
websiteId no corpo
module e method identificando o recurso

Ative a API e gere o token em #api.main?general (veja API - Como habilitar). Limite: 60 requisições autenticadas por minuto por website. Trate o token como senha.

No painel, o testador e a documentação do método ficam em #api.main?{módulo}&{método}.

Métodos

Método	Para que serve
`listReports`	Catálogo dos relatórios com `periodType`, `defaultPeriod` e `available` (site, blog ou loja).
`getReport`	Dados de um relatório (mesmo JSON interno da tela), em `data`.

Período

month — thisMonth ou YYYY-MM
year — thisYear ou YYYY
range — thisMonth, last2Months, last3Months ou YYYY-MM
none — últimos 12 meses, sem period

Se period vier vazio, a API usa o padrão da tela. Relatórios de loja exigem websiteType=1 ou ext. 10; de blog, ext. 4. Sem a extensão 1 a API responde 403 VISITS_EXTENSION_REQUIRED.

Relatórios possíveis

Use o valor da coluna report em getReport. listReports devolve o mesmo catálogo e marca available conforme o site (blog = ext. 4; loja = websiteType=1 ou ext. 10).

Site (sempre)

report	Nome	O que mostra
`monthlyGrow`	Variação por meses	Visitantes únicos mês a mês no ano, com variação percentual acima ou abaixo da média.
`monthlyVisit`	Visitas	Visitantes, páginas vistas e eventos importantes ao longo do ano.
`uniqueVisitors`	Visitantes Únicos	Visitantes únicos e páginas vistas dia a dia no mês.
`origin`	Origem de visitas	De onde vieram as visitas no mês (Google, redes, IA, direto e outros).
`originYear`	Google e outros Links	Visitas do Google versus outros links, mês a mês no ano.
`eventsOrigin`	Origem de eventos	Canal de origem dos eventos de contato no ano.
`events`	Eventos	Eventos de contato no mês: WhatsApp, formulário, e-mail, telefone e localização.
`eventsYear`	Eventos por ano	Eventos importantes mês a mês no ano.
`read`	Leitura	Quem ficou mais de 15 segundos na página e quem rolou até o fim.
`mobile`	Celular	Quanto do tráfego do mês veio de celular.
`links`	Páginas	Páginas mais vistas no mês. Aceita `filter` para recortar a lista.
`leads`	Origem de leads	De onde vieram os leads no mês.
`leadsYear`	Leads por ano	Leads acumulados mês a mês no ano.
`resume`	Relatório mensal	Resumo do mês: visitantes, páginas, origem, mobile, leitura e eventos.

Blog / notícias (ext. 4)

report	Nome	O que mostra
`articleViews`	Visualizações de artigos	Artigos mais vistos no mês.
`articleQtd`	Notícias por redator	Quantas notícias cada redator publicou no mês.
`tagViews`	Visualizações por categoria	Visualizações agrupadas por categoria do blog.
`authorViews`	Visualizações por redator	Visualizações agrupadas por redator.
`aiUsage`	Créditos de AI	Consumo de créditos de AI no mês.

Loja virtual (websiteType=1 ou ext. 10)

report	Nome	O que mostra
`visitsRevenueYear`	Receita total	Receita mês a mês no ano.
`visitsRevenue`	Receita (dia-a-dia)	Receita dia a dia no mês.
`visitsOrders`	Pedidos	Pedidos do mês.
`visitsIntentionToBuy`	Fluxo de compra	Funil do mês: visita, intenção, checkout e compra.
`ticketMedio`	Ticket médio	Ticket médio dos últimos 12 meses (sem `period`).
`topSkusSold`	SKUs mais vendidos	SKUs que mais venderam no intervalo.
`pedidosCancelados`	Pedidos cancelados	Pedidos cancelados nos últimos 12 meses (sem `period`).
`cancelRate`	Taxa de cancelamento	Percentual de cancelamento no ano.
`ordersByRegion`	Pedidos por região	Pedidos e receita por estado ou região.
`recurringCustomers`	Clientes e receita	Quantidade de clientes e receita no intervalo.
`newVsReturning`	Novos vs. recorrentes	Clientes novos versus recorrentes no ano.
`checkoutConversion`	Conversão do Checkout	Inícios de checkout versus pedidos finalizados (últimos 12 meses, sem `period`).
`conversionRate`	Taxa de conversão geral	Taxa visita para pedido no ano.
`abandonedCartValue`	Carrinho abandonado	Valor deixado em carrinhos abandonados (últimos 12 meses, sem `period`).
`revenuePerVisitor`	Receita por visitante	Receita média por visitante no ano.
`orderOrigin`	Origem dos pedidos	Canal de origem dos pedidos no mês.
`revenueByChannel`	Receita por canal (R$)	Receita em reais por canal no ano.
`paidVsOrganic`	Pago vs. orgânico	Pedidos e receita de mídia paga versus orgânico no ano.

curl -X POST 'https://app.interago.com.br/App/Api/index.php' \ -H 'Authorization: Bearer SEU_TOKEN' \ -H 'Content-Type: application/x-www-form-urlencoded' \ -d 'websiteId=SEU_WEBSITE_ID&module=visits&method=listReports'

Este artigo foi útil?