Endpoint
- Method:
GET - Path:
/reports/dashboard-stats - Edition: Core
- Controller:
DashboardController@getStats - Route source:
app/Http/Routes/api.php
GET Get Dashboard Stats
GET
/reports/dashboard-stats
Get dashboard KPI statistics.
Controller: DashboardController@getStats
Route source: app/Http/Routes/api.php
Authorizations
ApplicationPasswords
WordPress Application Passwords — use Basic auth with username:application_password.
Type
API Key (header: Authorization)
Responses
Successful response
application/json
JSON
{
"stats": {
"affiliates": {
"title": "string",
"count": 0,
"is_money": true
},
"pending": {
"title": "string",
"count": 0,
"is_money": true
},
"paid": {
"title": "string",
"count": 0,
"is_money": true
},
"unpaid": {
"title": "string",
"count": 0,
"is_money": true
},
"visits": {
"title": "string",
"count": 0,
"is_money": true
},
"paid_transactions": {
"title": "string",
"count": 0,
"is_money": true
},
"pending_payout": {
"title": "string",
"count": 0,
"is_money": true
}
},
"recent_referrals": [
{
"id": 0,
"affiliate_id": 0,
"visit_id": 0,
"order_id": "string",
"status": "string",
"amount": "string",
"currency": "string",
"provider": "string",
"provider_url": "string",
"created_at": "string",
"updated_at": "string"
}
],
"top_affiliates": [
{
"id": 0,
"user_id": 0,
"status": "string",
"affiliate_code": "string",
"rate": "string",
"rate_type": "string",
"earnings_balance": "string",
"total_paid": "string",
"total_unpaid": "string",
"created_at": "string",
"updated_at": "string"
}
],
"recent_visits": [
{
"id": 0,
"affiliate_id": 0,
"url": "string",
"ip": "string",
"created_at": "string",
"referrals": [
{
"id": 0,
"visit_id": 0,
"status": "string",
"amount": "string",
"currency": "string"
}
]
}
],
"recent_payouts": [
{
"id": 0,
"status": "string",
"amount": "string",
"currency": "string",
"referrals_count": 0,
"transactions_count": 0,
"affiliates_count": 0,
"created_at": "string",
"updated_at": "string"
}
]
}