Skip to main content
GET
https://api.centralcart.com.br
/
v1
/
app
/
report
/
customers
Customers
curl --request GET \
  --url https://api.centralcart.com.br/v1/app/report/customers
{
  "meta": {
    "total": 25,
    "per_page": 15,
    "current_page": 1,
    "last_page": 2
  },
  "data": [
    {
      "name": "João Silva",
      "email": "joao@email.com",
      "client_identifier": "steam:1234567890",
      "total_net": 450.00,
      "total_gross": 500.00,
      "total_orders": 5
    }
  ]
}
from
string
Data de início do período (formato: YYYY-MM-DD)
to
string
Data de fim do período (formato: YYYY-MM-DD)
page
number
Página da listagem (padrão: 1)
limit
number
Limite de resultados por página (máximo: 15)
group_by
string
Agrupar clientes por IDENTIFIER ou por email (padrão: email)
order_by
string
Ordenar por revenue, net_revenue ou quantity (padrão: revenue)

Response

meta
object
Metadados de paginação
data
array
Lista de clientes com métricas
{
  "meta": {
    "total": 25,
    "per_page": 15,
    "current_page": 1,
    "last_page": 2
  },
  "data": [
    {
      "name": "João Silva",
      "email": "joao@email.com",
      "client_identifier": "steam:1234567890",
      "total_net": 450.00,
      "total_gross": 500.00,
      "total_orders": 5
    }
  ]
}