Skip to main content
GET
/
statistics
curl --location 'https://api.bleeprs.com/api/statistics' \
--header 'Authorization: Bearer YOUR_API_KEY'

{
  "gatewayStatus": "<string>",
  "gatewayMessage": "<string>",
  "requestReference": "<string>",
  "data": {},
  "account_balance": {},
  "account_balance.amount": "<string>",
  "account_balance.available_for": "<string>",
  "account_balance.currency": "<string>",
  "account_balance.last_updated": "<string>",
  "period": {},
  "period.current_week_start": "<string>",
  "period.current_week_end": "<string>",
  "period.previous_week_start": "<string>",
  "period.previous_week_end": "<string>",
  "statistics": {},
  "statistics.successful": {},
  "statistics.successful.value": 123,
  "statistics.successful.rate": "<string>",
  "statistics.successful.is_positive": true,
  "statistics.failed": {},
  "statistics.failed.value": 123,
  "statistics.failed.rate": "<string>",
  "statistics.failed.is_positive": true,
  "total_amount": {},
  "total_amount.value": "<string>",
  "total_amount.change": "<string>",
  "total_amount.is_positive": true,
  "total_transactions": {},
  "total_transactions.value": 123,
  "total_transactions.change": "<string>",
  "total_transactions.is_positive": true
}

​
Overview

Retrieve comprehensive statistics about your vending activities, including account balance, transaction metrics, and performance data.

​
Request

curl --location 'https://api.bleeprs.com/api/statistics' \
--header 'Authorization: Bearer YOUR_API_KEY'

​
Parameters

No parameters required for this endpoint.

​
Response

​
gatewayStatus
string
Status code indicating success (“00”) or error
​
gatewayMessage
string
Human-readable status message
​
requestReference
string
Unique reference ID for tracking this request
​
data
object
Statistics and account information

​
Data Object Fields

​
account_balance
object
Account balance information
​
account_balance.amount
string
Current account balance (e.g., “N7450.00”)
​
account_balance.available_for
string
What the balance is available for (e.g., “vending”)
​
account_balance.currency
string
Currency code (e.g., “NGN”)
​
account_balance.last_updated
string
Last balance update timestamp
​
period
object
Time period information for statistics
​
period.current_week_start
string
Start date of current week
​
period.current_week_end
string
End date of current week
​
period.previous_week_start
string
Start date of previous week
​
period.previous_week_end
string
End date of previous week
​
statistics
object
Transaction statistics
​
statistics.successful
object
Successful transaction metrics
​
statistics.successful.value
number
Number of successful transactions
​
statistics.successful.rate
string
Success rate compared to previous week
​
statistics.successful.is_positive
boolean
Whether the trend is positive
​
statistics.failed
object
Failed transaction metrics
​
statistics.failed.value
number
Number of failed transactions
​
statistics.failed.rate
string
Failure rate compared to previous week
​
statistics.failed.is_positive
boolean
Whether the trend is positive (false for failures)
​
total_amount
object
Total transaction amount metrics
​
total_amount.value
string
Total amount in current period (e.g., “N3850.00”)
​
total_amount.change
string
Percentage change from previous week
​
total_amount.is_positive
boolean
Whether the trend is positive
​
total_transactions
object
Total transaction count metrics
​
total_transactions.value
number
Total number of transactions
​
total_transactions.change
string
Percentage change from previous week
​
total_transactions.is_positive
boolean
Whether the trend is positive

​
Example Response

{
  "gatewayStatus": "00",
  "gatewayMessage": "Successfully Processed",
  "requestReference": "ESzHw13F3Xa93uizdop6",
  "data": {
    "account_balance": {
      "amount": "N7450.00",
      "available_for": "vending",
      "currency": "NGN",
      "last_updated": "9/18/2025, 8:22:50 AM"
    },
    "period": {
      "current_week_end": "2025-09-18",
      "current_week_start": "2025-09-11",
      "previous_week_end": "2025-09-11",
      "previous_week_start": "2025-09-04"
    },
    "statistics": {
      "failed": {
        "is_positive": false,
        "rate": "70.8% failure rate from last week",
        "value": 17
      },
      "successful": {
        "is_positive": true,
        "rate": "0.0% success rate from last week",
        "value": 7
      }
    },
    "total_amount": {
      "change": "0.0% change from last week",
      "is_positive": true,
      "value": "N3850.00"
    },
    "total_transactions": {
      "change": "0.0% of total from last week",
      "is_positive": true,
      "value": 24
    }
  }
}

​
Notes

  • Statistics are calculated based on weekly periods
  • All monetary values are in Nigerian Naira (NGN)
  • Trends compare current week to previous week
  • Account balance is updated in real-time
  • Use this endpoint to monitor your vending performance and account status