Skip to main content
GET
/
cabinet
/
admin
/
referral-network
/
scoped
Get Scoped Referral Network
curl --request GET \
  --url https://api.example.com/cabinet/admin/referral-network/scoped \
  --header 'Authorization: Bearer <token>'
{
  "users": [
    {
      "id": 123,
      "tg_id": 123,
      "username": "<string>",
      "email": "<string>",
      "display_name": "<string>",
      "is_partner": true,
      "referrer_id": 123,
      "campaign_id": 123,
      "direct_referrals": 123,
      "total_branch_users": 123,
      "branch_revenue_kopeks": 123,
      "personal_revenue_kopeks": 123,
      "personal_spent_kopeks": 123,
      "subscription_name": "<string>",
      "subscription_end": "<string>",
      "registered_at": "<string>"
    }
  ],
  "campaigns": [
    {
      "id": 123,
      "name": "<string>",
      "start_parameter": "<string>",
      "is_active": true,
      "direct_users": 123,
      "total_network_users": 123,
      "total_revenue_kopeks": 123,
      "conversion_rate": 123,
      "avg_check_kopeks": 123,
      "top_referrers": [
        {
          "user_id": 123,
          "username": "<string>",
          "referral_count": 123
        }
      ]
    }
  ],
  "edges": [
    {
      "source": "<string>",
      "target": "<string>",
      "type": "<string>"
    }
  ],
  "total_users": 123,
  "total_referrers": 123,
  "total_campaigns": 123,
  "total_earnings_kopeks": 123
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

campaign_ids
integer[]
Maximum array length: 50
partner_ids
integer[]
Maximum array length: 50
user_ids
integer[]
Maximum array length: 50

Response

Successful Response

users
NetworkUserNode · object[]
required
campaigns
NetworkCampaignNode · object[]
required
edges
NetworkEdge · object[]
required
total_users
integer
required
total_referrers
integer
required
total_campaigns
integer
required
total_earnings_kopeks
integer
required