Voltar para API Keys
Benchmark API

Documentacao da API de benchmarks

Consulte benchmarks por nicho, plataforma e periodo usando uma API key criada dentro da Erizon.

Abrir endpoint
Autenticacao

Envie a key no header x-erizon-key ou no query param key.

Rate limit

O limite por hora varia conforme o plano da key: free 100, pro 1000 e enterprise 10000.

Endpoint

GET /api/public/benchmarks

Parametros

CampoValoresPadrao
nichetexto livre para filtrar nichoopcional
metriccpl, roas, ctr, frequency, allall
period7d, 30d, 90d30d
platformmeta, google, tiktok, linkedin, allmeta
percentilep25, p50, p75, allall

Exemplo com curl

curl "https://app.erizonai.com.br/api/public/benchmarks?niche=arquitetura&metric=cpl&period=30d&platform=meta" \
  -H "x-erizon-key: SUA_KEY_AQUI"

Exemplo de resposta

{
  "ok": true,
  "query": {
    "niche": "arquitetura",
    "metric": "cpl",
    "period": "30d",
    "platform": "meta",
    "percentile": "all"
  },
  "count": 1,
  "benchmarks": [
    {
      "niche": "arquitetura",
      "platform": "meta",
      "period": "30d",
      "sample_size": 18,
      "metrics": {
        "cpl": {
          "p25": 24.7,
          "p50": 31.9,
          "p75": 44.3,
          "unit": "BRL"
        }
      }
    }
  ],
  "generated_at": "2026-04-15T09:00:00.000Z",
  "docs": "/docs/api/benchmarks"
}

Codigos de status

200 consulta processada.

401 key ausente ou invalida.

429 limite horario excedido.

500 erro interno temporario.

Boas praticas

Use cache de 15 a 60 minutos para dashboards externos.

Evite expor sua API key no navegador; prefira chamadas server-side.

Use sample_size para decidir se o benchmark tem massa suficiente.

Exemplo em TypeScript

const res = await fetch(
  "https://app.erizonai.com.br/api/public/benchmarks?niche=imobiliario&period=30d&platform=meta",
  { headers: { "x-erizon-key": process.env.ERIZON_API_KEY! } }
);

if (!res.ok) throw new Error("Falha ao buscar benchmark");

const data = await res.json();
const cplMediano = data.benchmarks[0]?.metrics?.cpl?.p50;
Use esta API para integracoes com n8n, dashboards externos, agentes e automacoes que precisem comparar uma conta com a media do nicho sem depender da interface da Erizon.