Skip to main content
GET
/
api
/
v1
/
dashboard
Get dashboard metrics
curl --request GET \
  --url http://localhost:7701/api/v1/dashboard \
  --header 'Authorization: Bearer <token>'
{
  "total_processed_amount": 1500000,
  "total_transactions": 320,
  "approval_rate": 87.5,
  "recovered_payments": 12,
  "conversion_by_gateway": [
    {
      "gateway": "pagarme",
      "total": 200,
      "approved": 175,
      "rate": 87.5
    }
  ],
  "failure_reasons": [
    {
      "reason": "Insufficient funds",
      "count": 18
    }
  ],
  "last_transactions": [
    {}
  ]
}

Authorizations

Authorization
string
header
required

User JWT token — obtained from /api/v1/auth/login or /api/v1/auth/register.

Query Parameters

start_date
string<date>
Example:

"2026-01-01"

end_date
string<date>
Example:

"2026-12-31"

Response

Dashboard metrics

total_processed_amount
integer
Example:

1500000

total_transactions
integer
Example:

320

approval_rate
number<float>
Example:

87.5

recovered_payments
integer
Example:

12

conversion_by_gateway
object[]
failure_reasons
object[]
last_transactions
object[]