Skip to main content
GET
https://api.centralcart.com.br
/
v1
/
app
/
affiliate
/
{affiliate-id}
/
metrics
Get Affiliate Metrics
curl --request GET \
  --url https://api.centralcart.com.br/v1/app/affiliate/{affiliate-id}/metrics
{
  "affiliate": {
    "id": 1,
    "name": "Afiliado Exemplo",
    "ref_code": "AFFILIATE001",
    "balance": 150.00
  },
  "commissions": {
    "total_count": 25,
    "total_value": 500.00,
    "graph": [
      {
        "date": "2024-01-01T00:00:00.000Z",
        "count": 5,
        "total": 100.00
      },
      {
        "date": "2024-01-02T00:00:00.000Z",
        "count": 3,
        "total": 60.00
      }
    ]
  },
  "withdraws": {
    "total_count": 2,
    "total_value": 200.00,
    "graph": [
      {
        "date": "2024-01-01T00:00:00.000Z",
        "count": 1,
        "total": 100.00
      },
      {
        "date": "2024-01-02T00:00:00.000Z",
        "count": 1,
        "total": 100.00
      }
    ]
  },
  "store_revenue": {
    "total_count": 50,
    "total_value": 5000.00,
    "graph": [
      {
        "date": "2024-01-01T00:00:00.000Z",
        "count": 10,
        "total": 1000.00
      },
      {
        "date": "2024-01-02T00:00:00.000Z",
        "count": 8,
        "total": 800.00
      }
    ]
  }
}
​
affiliate-id
string
required
O ID do afiliado
​
from
string
required
Data inicial do período no formato YYYY-MM-DD
​
to
string
required
Data final do período no formato YYYY-MM-DD
O período máximo permitido é de 3 meses (90 dias). Para períodos de até 60 dias, os dados são agrupados por dia. Para períodos maiores, são agrupados por mês.

​
Resposta

A resposta contém as seguintes métricas:
  • commissions: Faturamento do afiliado (comissões recebidas)
  • withdraws: Saques realizados ou pendentes
  • store_revenue: Valor total gerado para a loja através do afiliado
Cada métrica inclui:
  • total_count: Quantidade total de operações
  • total_value: Valor total em reais
  • graph: Array de dados para construção de gráfico
{
  "affiliate": {
    "id": 1,
    "name": "Afiliado Exemplo",
    "ref_code": "AFFILIATE001",
    "balance": 150.00
  },
  "commissions": {
    "total_count": 25,
    "total_value": 500.00,
    "graph": [
      {
        "date": "2024-01-01T00:00:00.000Z",
        "count": 5,
        "total": 100.00
      },
      {
        "date": "2024-01-02T00:00:00.000Z",
        "count": 3,
        "total": 60.00
      }
    ]
  },
  "withdraws": {
    "total_count": 2,
    "total_value": 200.00,
    "graph": [
      {
        "date": "2024-01-01T00:00:00.000Z",
        "count": 1,
        "total": 100.00
      },
      {
        "date": "2024-01-02T00:00:00.000Z",
        "count": 1,
        "total": 100.00
      }
    ]
  },
  "store_revenue": {
    "total_count": 50,
    "total_value": 5000.00,
    "graph": [
      {
        "date": "2024-01-01T00:00:00.000Z",
        "count": 10,
        "total": 1000.00
      },
      {
        "date": "2024-01-02T00:00:00.000Z",
        "count": 8,
        "total": 800.00
      }
    ]
  }
}