Metrics
Métricas do Eduzz pela API
Seu cliente conecta a conta do Eduzz e seu produto consulta 16 métricas pelo mesmo endpoint das outras plataformas. Cada métrica tem um identificador (reference_key) que vai na chamada.
POST /api/metrics/get-data
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
{
"customer_integration": "<connection uuid>",
"start": "2026-10-01",
"end": "2026-10-31",
"comparison_start": "2026-09-01",
"comparison_end": "2026-09-30",
"metrics": [
{
"id": "m1",
"reference_key": "edz:total_sales",
"component": "number_v1",
"metrics": [
"sales"
]
}
]
}Mais exemplos de chamadas no Eduzz
O mesmo endpoint para cada tipo de métrica. Os campos metrics e dimensions de cada item vêm do catálogo da plataforma (GET /api/metrics/{integration_slug}).
Gráfico
Vendas ao longo do tempo
Vendas concluídas ao longo do tempo no período selecionado.
POST /api/metrics/get-data
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
{
"customer_integration": "<connection uuid>",
"start": "2026-10-01",
"end": "2026-10-31",
"metrics": [
{
"id": "m1",
"reference_key": "edz:sales_over_time",
"component": "chart_v1",
"metrics": [
"sales"
],
"dimensions": [
"date"
]
}
]
}Tabela
Produtos
Lista de produtos com status, preço e vendas no período selecionado.
POST /api/metrics/get-data
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
{
"customer_integration": "<connection uuid>",
"start": "2026-10-01",
"end": "2026-10-31",
"metrics": [
{
"id": "m1",
"reference_key": "edz:products_table",
"component": "datatable_v1",
"metrics": [
"status",
"price",
"sales"
],
"dimensions": [
"products"
]
}
]
}Número
Receita bruta
Receita bruta total das vendas pagas no período selecionado.
POST /api/metrics/get-data
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
{
"customer_integration": "<connection uuid>",
"start": "2026-10-01",
"end": "2026-10-31",
"metrics": [
{
"id": "m1",
"reference_key": "edz:revenue_total",
"component": "number_v1",
"metrics": [
"revenue_total"
]
}
]
}Números
8 métricas
Total de vendas
Número total de vendas concluídas no período selecionado.
edz:total_salesReceita bruta
Receita bruta total das vendas pagas no período selecionado.
edz:revenue_totalReceita líquida
Receita líquida total das vendas pagas no período selecionado
edz:revenue_netReembolsos
Número total de reembolsos no período selecionado.
edz:refunds_totalFaturas pagas
Número total de faturas pagas no período selecionado.
edz:invoices_paidFaturas reembolsadas
Número total de faturas reembolsadas no período selecionado.
edz:invoices_refundedFaturas canceladas
Número total de faturas canceladas no período selecionado.
edz:invoices_canceledTaxa de reembolso
Reembolsos divididos pelas vendas totais.
edz:refund_rate
Gráficos
5 métricas
Vendas ao longo do tempo
Vendas concluídas ao longo do tempo no período selecionado.
edz:sales_over_timeVendas por método de pagamento ao longo do tempo
Vendas concluídas ao longo do tempo divididas por método de pagamento.
edz:sales_by_payment_over_timeTipos de pagamento em vendas concluídas
Distribuição das vendas concluídas por método de pagamento.
edz:payment_types_barOrigem das vendas
Distribuição das vendas concluídas por origem (produto vs afiliado).
edz:sales_origin_pieTipo de produto principal
Distribuição das vendas por tipo de produto.
edz:top_product_type_pie
Tabelas
3 métricas
Produtos
Lista de produtos com status, preço e vendas no período selecionado.
edz:products_tableAfiliados
Afiliados vinculados a produtos com dados de comissão.
edz:affiliates_tableComissões de afiliados pagas
Comissões pagas agrupadas por afiliado.
edz:affiliate_commissions_paid
Veja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
