Quem é a chave
GET/me
Conta, plano, níveis da chave e quantos sites ela alcança. Bom para testar a integração.
{
"account": { "id": "acc_…", "name": "Loja X", "plan": "Empresa" },
"key": { "id": "key_…", "name": "BI interno", "prefix": "bu_live_7Kx2", "scopes": ["read"], "expires_at": null },
"sites": 3
}Listar sites
GET/sites
Sites que a chave alcança, com o índice de saúde da última auditoria e os achados em aberto.
{
"data": [{
"id": "cmw…",
"domain": "loja.com.br",
"url": "https://www.loja.com.br/",
"status": "monitoring",
"client": null,
"monitor": { "frequency": "daily", "hour": 6, "next_audit_at": "2026-11-19T09:00:00.000Z" },
"health": { "score": 86, "band": "attention" },
"open_findings": { "bad": 1, "warn": 2 },
"last_audit_at": "2026-11-18T09:03:12.000Z"
}]
}Detalhe do site
GET/sites/{id}
Tudo da lista, mais ferramentas detectadas (com IDs), resumo da jornada de compra, endereços (subdomínios) e containers do GTM.
Índice de saúde
GET/sites/{id}/health?days=30
Índice atual, a série das auditorias no período (1 a 365 dias) e a situação por área (instalação, consentimento, jornada…).
{
"site_id": "cmw…",
"current": { "score": 86, "band": "attention" },
"series": [{ "audit_id": "cmx…", "at": "2026-11-18T09:03:12.000Z", "score": 86, "band": "attention" }],
"by_area": [{ "area": "Consentimento", "ok": 3, "attention": 1, "problems": 0 }]
}Achados
GET/sites/{id}/findings?status=open&severity=problem
status: open (padrão), in_progress, ignored ou resolved. severity: problem ou attention. Inclui responsável, prazo e evidências.
{
"data": [{
"id": "cmy…",
"check": "SITE-JRN-META",
"area": "Jornada de compra",
"severity": "problem",
"title": "Meta Pixel: eventos de compra faltando na jornada",
"detail": "Faltou AddToCart. …",
"evidence": ["adicionar ao carrinho: nenhum envio"],
"status": "in_progress",
"assignee": { "email": "ana@loja.com.br", "name": "Ana" },
"due_date": "2026-11-22",
"first_seen_at": "2026-11-17T09:02:41.000Z"
}],
"next_before": null
}Auditorias do site
GET/sites/{id}/audits
Da mais recente para a mais antiga, com situação, índice e resumo de cada uma.
Uma auditoria
GET/audits/{id}
Concluída, traz o relatório completo: checagens com evidências, ferramentas, consentimento por cenário, jornada passo a passo, cobertura e GTM.
Alertas
GET/alerts?site={id}
Mudanças confirmadas pelo monitor em todos os sites da chave (ou de um site).