Vixiees API

Sections

Theme switcher

Retrieves dashboard leaderboard

Header Parameters

X-Api-Keystring

Query Parameters

playbook_idstring Required

ID of the playbook to filter by

periodstring

Time period (e.g. this_week, this_month, last_week, last_month, last_two_months, last_7_days, last_14_days, last_30_days, custom)

start_datestring

Start date for custom period (ISO 8601)

end_datestring

End date for custom period (ISO 8601)

Response

200
Object

leaderboard data returned

Response Attributes

top_metricsarray

Show child attributes

usersarray

Show child attributes

averagesobject
status_summaryobject
401
Object

unauthorized

404
Object

playbook not found or playbook_id missing

422
Object

date range exceeds limit

Was this section helpful?

GET

/

Select
1

Response

Was this section helpful?