Endpoint
- Method:
GET - Path:
/affiliates/{id}/stats - Edition: Core
- Controller:
AffiliateController@getOverviewStats - Route source:
app/Http/Routes/api.php
GET Get Affiliate Stats
GET
/affiliates/{id}/stats
Get summary stats for an affiliate.
Controller: AffiliateController@getOverviewStats
Route source: app/Http/Routes/api.php
Authorizations
ApplicationPasswords
WordPress Application Passwords — use Basic auth with username:application_password.
Type
API Key (header: Authorization)
Parameters
Path Parameters
id*
The id.
Type
Requiredinteger
Responses
Successful response
application/json
JSON
{
"stats": {
"total_paid": {
"title": "string",
"amount": "string",
"is_currency": true
},
"total_unpaid": {
"title": "string",
"amount": "string",
"is_currency": true
},
"total_order_value": {
"title": "string",
"amount": "string",
"is_currency": true
},
"conversion_rate": {
"title": "string",
"amount": "string",
"is_number": true
},
"total_visits": {
"title": "string",
"amount": 0,
"is_number": true
},
"total_referrals": {
"title": "string",
"amount": 0,
"is_number": true
}
}
}