POST
Join a leaderboard metric

Authorizations

Authorization
string
header
required

The end user's JWT access token, sent as Authorization: Bearer <token>.

Obtain one from POST /partner/customers or POST /partner/customers/login — both return it as token. It identifies which of your users a call is made for, and is sent alongside your X-API-Key on every authenticated endpoint.

Event discovery, categories, subcategories and scores are public and need no token.

Body

application/json
metric_name
enum<string>
required

The leaderboard metric to join.

Available options:
volume,
projected_pnl,
predictions
Example:

"volume"

Response

Successfully joined the leaderboard.

success
boolean
required
Example:

true

message
string
required
Example:

"Successfully joined the leaderboard"