Lucratividade

Clientes novos vs. recorrentes ao longo do tempo

GET
/v1/profitability/new-vs-recurring

Retorna uma série temporal com clientes novos (primeira compra no período do ponto) e recorrentes (já tinham comprado antes) que fizeram pedido. Ideal para gráficos de barras empilhadas ou de área.

  • Períodos de até 31 dias retornam pontos diários, respeitando exatamente startDate–endDate.
  • Períodos maiores, ou sem datas, retornam pontos mensais, com o período expandido para meses inteiros.
  • O campo granularity informa qual granularidade foi usada.

Autorização

ClientIdAuthClientSecretAuth
headerx-client-id<token>

Client ID

headerx-client-secret<token>

Client secret

Parâmetros de query

organizationId*string

Identificador da organização (obrigatório)

startDate?string

Primeiro dia do período, inclusivo (YYYY-MM-DD). Só é aplicado junto com endDate; sem os dois, a API considera todo o histórico.

Formatodate
endDate?string

Último dia do período, inclusivo (YYYY-MM-DD). Só é aplicado junto com startDate; sem os dois, a API considera todo o histórico.

Formatodate

Corpo da resposta

Dados de novos vs recorrentes obtidos com sucesso

application/json
  1. response
data*array<>

Detalhamento de clientes novos vs recorrentes por período (mês ou dia, veja granularity)

granularity?string

Granularidade da série, definida pelo tamanho do período: daily para até 31 dias, monthly para períodos maiores ou sem datas.

Valor em"monthly""daily"
curl -X GET "https://example.com/v1/profitability/new-vs-recurring?organizationId=c0ad4763-173e-4a05-9cff-5208c8ea5f6a&startDate=2025-01-01&endDate=2025-12-31"
{  "data": [    {      "month": "2025-10-01",      "newCustomers": 210,      "recurringCustomers": 140,      "totalCustomers": 350    },    {      "month": "2025-11-01",      "newCustomers": 195,      "recurringCustomers": 158,      "totalCustomers": 353    }  ],  "granularity": "monthly"}