Skip to main content
GET
JavaScript

Authorizations

Authorization
string
header
required

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

Query Parameters

suite
string
required
Minimum string length: 1
suiteVersion
string
Minimum string length: 1
conditionKey
string
sortBy
string
Minimum string length: 1
order
enum<string>
Available options:
asc,
desc
metrics
string

Comma-separated metric keys to project per row. Defaults to the headline set.

limit
integer
default:20

Maximum number of records to return (default: 20, max: 100)

Required range: 1 <= x <= 100
offset
integer
default:0

Pagination offset

Required range: x >= 0

Response

One ranked page of the leaderboard

data
object[]
required
suite
string
required
suiteVersion
string
required

The version actually read, after defaulting.

conditionKey
string
required
sortedBy
object
required

The ranking this page was produced under

pagination
object
required