v2

OpenAPI 3.1.02026-07-314524165.2 KB

Obter receita por período

Retorna a receita total, total de transações e transações por dia em um período específico. Os dados são cacheados por 1 hora (3600 segundos) para melhor performance. A data de fim deve ser posterior à data de início.

get/public-mrr/revenue

Query parameters

startDatestring date required
Example:2024-01-01

Data de início do período (formato YYYY-MM-DD)

endDatestring date required
Example:2024-01-31

Data de fim do período (formato YYYY-MM-DD)

Response

Dados de receita retornados com sucesso.

errorstring nullable
successboolean

Se a requisição obteve sucesso ou não.

Example response

{
  "data": {
    "totalRevenue": 150000,
    "totalTransactions": 45,
    "transactionsPerDay": {
      "2024-01-15": {
        "amount": 5000,
        "count": 3
      },
      "2024-01-16": {
        "amount": 3000,
        "count": 2
      }
    }
  },
  "success": true
}