API atual/Referência completa/Indicadores e relatórios

GETConfiguração de métricas

Mostra quais status de pedido contam nas métricas do seller e quais cartões do painel estão visíveis.

A configuração de métricas vem do tempo da plataforma anterior: define quais status de pedido entram nos números do resumo da conta e quais cartões o painel exibe. É uma rota de leitura para o seller; quem edita é o administrador da loja. Funciona apenas quando o módulo metrics-config está ligado na loja.

GET/api/v1/vendor/metrics-configSeller

Ler configuração de métricas

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso do usuário seller (veja Tokens).

Exemplo de requisição

bash

curl -X GET "$BASE_URL/api/v1/vendor/metrics-config" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Configuração

json

{
  "vendor_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
  "included_statuses": [
    "B",
    "C",
    "G",
    "H",
    "K",
    "P"
  ],
  "cards": {
    "revenue": true,
    "orders": true,
    "customers": true,
    "ticket": true,
    "repurchase": true,
    "ltv": true,
    "avg_days": true,
    "rfm": true,
    "sales_evolution": true,
    "customer_donut": true,
    "weekday": true,
    "growth": true,
    "status_donut": true,
    "heatmap": true,
    "order_search": true,
    "top_customers": true,
    "recent_orders": true
  },
  "has_own_config": false
}

Campos da resposta

vendor_iduuid

Seller (UUID).

included_statusesstring[]

Letras de status contadas nas métricas. Sem configuração própria nem padrão da loja, vale B,C,G,H,K,P, letras herdadas da plataforma antiga que podem não existir no alfabeto da sua loja.

cardsobject

Mapa cartão para visível (true/false). Chaves: revenue, orders, customers, ticket, repurchase, ltv, avg_days, rfm, sales_evolution, customer_donut, weekday, growth, status_donut, heatmap, order_search, top_customers, recent_orders.

has_own_configboolean

true se o seller tem configuração própria; false se herda a padrão da loja.

default_source_vendor_idstring

Seller de onde a configuração padrão da loja foi copiada, quando existe.

Erros

Status	Quando	Corpo de exemplo
401	Token ausente, inválido, expirado ou revogado.	`invalid or expired token`
403	Módulo `metrics-config` desligado nesta loja.	`{"error":"module_disabled","module":"metrics-config"}`
403	Token que não é de seller, ou usuário sem seller.	`{"error":"no vendor account"}`

Veja também

Resumo da conta