API — Reports

Documentacao tecnica gerada automaticamente a partir da especificacao OpenAPI.

GET /api/reports/sales

Get Sales Report

Parametros:

Nome	Tipo	Obrigatorio	Descricao
period	string	Nao	—
group_by	string	Nao	—

Exemplo resposta (200):

{
  "data": [
    "..."
  ],
  "totals": {
    "revenue": 0,
    "orders": 0,
    "avg": 0
  }
}

Erros possiveis: 422 Validation Error

Get Products Report

Parametros:

Nome	Tipo	Obrigatorio	Descricao
period	string	Nao	—
limit	integer	Nao	—
sort_by	string	Nao	—

Exemplo resposta (200):

{
  "data": [
    "..."
  ]
}

Erros possiveis: 422 Validation Error

Get Categories Report

Parametros:

Nome	Tipo	Obrigatorio	Descricao
period	string	Nao	—

Exemplo resposta (200):

{
  "data": [
    "..."
  ]
}

Erros possiveis: 422 Validation Error

Get Customers Report

Parametros:

Nome	Tipo	Obrigatorio	Descricao
period	string	Nao	—

Exemplo resposta (200):

{
  "new_customers": 0,
  "returning_customers": 0,
  "repeat_rate": 0,
  "avg_ltv": 0,
  "top_customers": [
    "..."
  ]
}

Erros possiveis: 422 Validation Error

Export Report

Parametros:

Nome	Tipo	Obrigatorio	Descricao
type	string	Sim	—
period	string	Nao	—
format	string	Nao	—

Exemplo resposta (200):

{}

Erros possiveis: 422 Validation Error

Documentacao gerada automaticamente.