Skip to main content
GET
Partner portal visits

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).

page
integer
default:1
Required range: 1 <= x <= 10000
per_page
integer
default:25
Required range: 1 <= x <= 100
visited
boolean

Filter on the selected range: true = only partners with at least one portal session in the period, false = only partners with none.

last_visit_before
string<date-time>

ISO timestamp. Only partners whose most recent portal session started before this instant are returned — including partners that have never visited. Answers 'which partners have not logged in since X'.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

Response

200 - application/json

Default Response

data
object[]
required
pagination
object
required
period
object
required