Get top affiliates

GET

/api/v2/analytics/top-affiliates

Request

Query Params

Header Params

Responses

🟢200

application/json

Success

Bodyapplication/json

🟠401

🟠422

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://aff-api.uppromote.com/api/v2/analytics/top-affiliates?from_date=2025-05-01T00%3A00%3A00Z&to_date=2025-05-31T23%3A59%3A59Z&exclude_network_sales=true&program_id=12&affiliate_email=jane%40example.com&sort_by=total_sales&order=desc&per_page=10&page=1' \
--header 'Accept: application/json' \
--header 'Authorization: <YOUR_API_KEY>' \
--header 'Content-Type: application/json'

Response Example

200 - Success

{
    "status": 200,
    "message": "success",
    "data": [
        {
            "affiliate_name": "Jane Doe",
            "email": "jane@example.com",
            "total_clicks": 1820,
            "total_referrals": 47,
            "total_sales": 12480.5,
            "total_commission": 1872.08,
            "last_order": "2025-05-29T14:03:11Z",
            "registration_time": "2024-11-02T08:15:00Z",
            "program_id": 12,
            "company": "Doe Media",
            "address": "12 Main St",
            "city": "Austin",
            "state": "TX",
            "country": "US",
            "zipcode": "73301",
            "phone": "+1 512 555 0100",
            "personal_details": "Beauty blogger",
            "website": "https://doemedia.example",
            "vat_number": "",
            "login_count": 36,
            "last_login": "2025-05-30T02:41:09Z",
            "conversion_rate": 2.58,
            "avg_order_value": 265.54,
            "commissions_per_click": 1.03,
            "return_on_investment": 666.67,
            "customer_acquisition_cost": 62.4,
            "new_customers": 30
        },
        {
            "affiliate_name": "John Smith",
            "email": "john@example.com",
            "total_clicks": 0,
            "total_referrals": 0,
            "total_sales": 0,
            "total_commission": 0,
            "last_order": null,
            "registration_time": "2025-04-18T10:22:47Z",
            "program_id": 12,
            "company": "",
            "address": "",
            "city": "",
            "state": "",
            "country": "",
            "zipcode": "",
            "phone": "",
            "personal_details": "",
            "website": "",
            "vat_number": "",
            "login_count": 0,
            "last_login": null,
            "conversion_rate": null,
            "avg_order_value": null,
            "commissions_per_click": null,
            "return_on_investment": null,
            "customer_acquisition_cost": null,
            "new_customers": 0
        }
    ]
}

Modified at 2026-08-18 08:37:40

Get referrals by tracking type

Get webhook subscriptions