Skip to main content
GET
/
analytics
/
engagement
/
partners
Partner engagement leaderboard
curl --request GET \
  --url https://api.journeybee.io/v1/analytics/engagement/partners \
  --header 'Authorization: Bearer <token>'
[
  {
    "name": "<string>",
    "logo_uuid": "<string>",
    "unique_users": 0,
    "total_sessions": 0,
    "total_page_views": 0,
    "avg_session_duration_seconds": 123
  }
]

Authorizations

​
Authorization
string
header
required

API key authentication. Use "Bearer <api_key>" or "Api-Key <api_key>".

Query Parameters

​
period
enum<string>

Reporting period (resolved to a date range server-side). Defaults to current_year. Ignored when start_date + end_date are both supplied.

Available options:
current_year,
last_year,
current_quarter,
last_quarter,
current_month,
last_month,
last_30_days,
last_90_days,
last_6_months,
last_12_months
​
start_date
string

ISO date for a custom range start (use with end_date).

​
end_date
string

ISO date for a custom range end (use with start_date).

​
partner_type
enum<string>

Limit to one partner type; omit to include all partners.

Available options:
referral,
reseller,
distributor
​
lead_direction
enum<string>

For referral partners, which lead direction to count.

Available options:
received,
sent,
all
​
partner_uuids

Restrict to these partnerships (uuids). Pass a single uuid for one partner's scorecard.

​
category_uuids

Restrict to partners in these categories (uuids).

​
tier_uuids

Restrict to partners in these tiers (uuids).

​
stage_uuids

Restrict to partners in these partnership stages (uuids).

​
limit
integer

Max rows for list/leaderboard endpoints (default per endpoint).

Required range: 1 <= x <= 100

Response

200 - application/json

Default Response

​
name
string
required
​
logo_uuid
string | null
required
​
partner_type
enum<string>
required
Available options:
referral,
reseller,
distributor
​
unique_users
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
​
total_sessions
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
​
total_page_views
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
​
avg_session_duration_seconds
number
required