Leaderboard Manifest
GET/api/v1/leaderboards
Authorization
bearer_token In: header
Query Parameters
Conditions as filter[][]=. Conditions on different fields all apply. in (any of) and all (every one of, on fields holding several values) take a comma-separated list (\, for a literal comma). exists takes true or false. Datetimes are RFC 3339, now, or a time before now such as -30m, -6h or -7d.
Full-text search over this list's searchable fields.
1 <= length <= 200Comma-separated sort keys, - for descending, at most 1. Keys: entry_count, created_at. Default: -created_at.
Rows per page, 1 to 100 (default 25).
1 <= value <= 100The page.next_cursor of the previous page. Cannot be combined with page.
A 1-based page number, for jumping. Cannot be combined with cursor.
1 <= valueSet to true to include the number of matching rows in page.total.
Response Body
application/json
curl -X GET "https://example.com/api/v1/leaderboards"{ "leaderboards": [ { "active": true, "created_at": "2019-08-24T14:15:22Z", "description": "string", "entry_count": 0, "id": "string", "max_entries": 0, "name": "string", "owner_id": "string", "tags": { "property1": "string", "property2": "string" }, "updated_at": "2019-08-24T14:15:22Z" } ], "page": { "has_more": true, "next_cursor": "string", "page": 0, "total": 0 }}POST/api/v1/leaderboards
Authorization
bearer_token In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Request to create a new leaderboard
Response Body
application/json
curl -X POST "https://example.com/api/v1/leaderboards" \ -H "Content-Type: application/json" \ -d '{ "name": "string" }'{ "created_at": "2019-08-24T14:15:22Z", "id": "string", "name": "string"}GET/api/v1/leaderboards/{id}
Authorization
bearer_token In: header
Path Parameters
Leaderboard ID
Response Body
application/json
curl -X GET "https://example.com/api/v1/leaderboards/string"{ "active": true, "created_at": "2019-08-24T14:15:22Z", "description": "string", "entry_count": 0, "id": "string", "max_entries": 0, "name": "string", "owner_id": "string", "tags": { "property1": "string", "property2": "string" }, "updated_at": "2019-08-24T14:15:22Z"}DELETE/api/v1/leaderboards/{id}
Authorization
bearer_token In: header
Path Parameters
Leaderboard ID to delete
Response Body
application/json
curl -X DELETE "https://example.com/api/v1/leaderboards/string"{ "message": "string", "ok": true}PUT/api/v1/leaderboards/{id}
Authorization
bearer_token In: header
Path Parameters
Leaderboard ID
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Request to update an existing leaderboard
Response Body
application/json
curl -X PUT "https://example.com/api/v1/leaderboards/string" \ -H "Content-Type: application/json" \ -d '{}'{ "active": true, "created_at": "2019-08-24T14:15:22Z", "description": "string", "entry_count": 0, "id": "string", "max_entries": 0, "name": "string", "owner_id": "string", "tags": { "property1": "string", "property2": "string" }, "updated_at": "2019-08-24T14:15:22Z"}