Orishare
API reference

List leaderboard programs

GET
/leaderboards

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Query Parameters

limit?integer
Range1 <= value <= 100
Default50
cursor?string
Lengthlength <= 2048
status?string

Value in

  • "draft"
  • "active"
  • "paused"
  • "ended"
  • "archived"

Header Parameters

X-Orishare-Environment?string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length
X-Orishare-Audit-Reason?string

Required for staff authorization. Records the reason for staff access.

Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/leaderboards"
{  "data": [    {      "id": "string",      "environment_id": "string",      "kind": "leaderboard",      "key": "string",      "name": "string",      "status": "draft",      "active_version_id": "string",      "authority": "legacy",      "legacy_table": "string",      "version": -9007199254740991,      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z",      "archived_at": "2019-08-24T14:15:22Z"    }  ],  "next_cursor": "string",  "has_more": true}

Read a leaderboard program

GET
/leaderboards/{id}

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Path Parameters

id*string
Length1 <= length

Header Parameters

X-Orishare-Environment?string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length
X-Orishare-Audit-Reason?string

Required for staff authorization. Records the reason for staff access.

Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/leaderboards/string"
{  "id": "string",  "environment_id": "string",  "kind": "leaderboard",  "key": "string",  "name": "string",  "status": "draft",  "active_version_id": "string",  "authority": "legacy",  "legacy_table": "string",  "version": -9007199254740991,  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "archived_at": "2019-08-24T14:15:22Z"}

List leaderboard seasons and scopes

GET
/leaderboards/{id}/boards

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Path Parameters

id*string
Length1 <= length

Query Parameters

limit?integer
Range1 <= value <= 100
Default50
cursor?string
Lengthlength <= 2048

Header Parameters

X-Orishare-Environment?string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length
X-Orishare-Audit-Reason?string

Required for staff authorization. Records the reason for staff access.

Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/leaderboards/string/boards"
{  "data": [    {      "id": "string",      "program_id": "string",      "program_version_id": "string",      "season_occurrence_id": "string",      "status": "string",      "source_revision": "string",      "privacy_generation": "string",      "current_revision_id": "string",      "payout_generation": "string"    }  ],  "next_cursor": "string",  "has_more": true}

Read leaderboard standings

GET
/leaderboards/{id}/boards/{board_id}/standings

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Path Parameters

id*string
Length1 <= length
board_id*string
Length1 <= length

Query Parameters

limit?integer
Range1 <= value <= 100
Default50
cursor?string
Lengthlength <= 2048
mode?string
Default"live"

Value in

  • "live"
  • "frozen"
revision_id?string
Length1 <= length <= 255
neighbors?integer
Range0 <= value <= 49

Header Parameters

X-Orishare-Environment?string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length
X-Orishare-Audit-Reason?string

Required for staff authorization. Records the reason for staff access.

Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/leaderboards/string/boards/string/standings"
{  "data": [    {      "entry_id": "string",      "pseudonym": "string",      "ordinal": "string",      "score": "string"    }  ],  "own_rank": {    "ordinal": "string",    "score": "string"  },  "revision_id": "string",  "next_cursor": "string",  "has_more": true}

Read a board's entries, or one customer's entry

GET
/leaderboards/{id}/boards/{board_id}/entries

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Path Parameters

id*string
Length1 <= length
board_id*string
Length1 <= length

Query Parameters

limit?integer
Range1 <= value <= 100
Default50
cursor?string
Lengthlength <= 2048
customer_id?string
Length1 <= length <= 255

Header Parameters

X-Orishare-Environment?string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length
X-Orishare-Audit-Reason?string

Required for staff authorization. Records the reason for staff access.

Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/leaderboards/string/boards/string/entries"
{  "data": [    {      "entry_id": "string",      "board_id": "string",      "customer_id": "string",      "participation_id": "string",      "state_revision": "string",      "generation": "string",      "score": "string",      "standing": "current"    }  ],  "next_cursor": "string",  "has_more": true}

Contribute an authenticated leaderboard score

POST
/leaderboards/{id}/contributions

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Path Parameters

id*string
Length1 <= length

Header Parameters

Idempotency-Key*string

Required. Official clients generate a UUID when omitted by the caller.

Length1 <= length <= 255
X-Orishare-Environment?string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length
X-Orishare-Audit-Reason?string

Required for staff authorization. Records the reason for staff access.

Length1 <= length
If-Match*string

Required revision, checked in the owning transaction.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/leaderboards/string/contributions" \  -H "Idempotency-Key: string" \  -H "If-Match: string" \  -H "Content-Type: application/json" \  -d '{    "customer_id": "cust_example",    "program_revision": 2,    "operation_key": "operation-example",    "event_id": "evt_example",    "slot": "score",    "value": "10"  }'
{  "id": "string",  "program_id": "string",  "program_version_id": "string",  "customer_id": "string",  "participation_id": "string",  "board_id": "string",  "entry_id": "string",  "state_revision": 0,  "source_revision": "string",  "score": "string",  "occurrence": "string"}

Correct a verified leaderboard contribution

POST
/leaderboards/{id}/corrections

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Path Parameters

id*string
Length1 <= length

Header Parameters

Idempotency-Key*string

Required. Official clients generate a UUID when omitted by the caller.

Length1 <= length <= 255
X-Orishare-Environment?string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length
X-Orishare-Audit-Reason?string

Required for staff authorization. Records the reason for staff access.

Length1 <= length
If-Match*string

Required revision, checked in the owning transaction.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/leaderboards/string/corrections" \  -H "Idempotency-Key: string" \  -H "If-Match: string" \  -H "Content-Type: application/json" \  -d '{    "customer_id": "cust_example",    "program_revision": 2,    "operation_key": "operation-example",    "contribution_id": "pc_example",    "fraction": "1",    "reason": "refund",    "generation": "0"  }'
{  "id": "string",  "program_id": "string",  "program_version_id": "string",  "customer_id": "string",  "participation_id": "string",  "board_id": "string",  "entry_id": "string",  "state_revision": 0,  "source_revision": "string",  "score": "string",  "occurrence": "string"}

Fence a leaderboard correction generation

POST
/leaderboards/{id}/boards/{board_id}/correction_generations

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Path Parameters

id*string
Length1 <= length
board_id*string
Length1 <= length <= 128

Header Parameters

Idempotency-Key*string

Required. Official clients generate a UUID when omitted by the caller.

Length1 <= length <= 255
X-Orishare-Environment?string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length
X-Orishare-Audit-Reason?string

Required for staff authorization. Records the reason for staff access.

Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/leaderboards/string/boards/string/correction_generations" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "expected_generation": "0"  }'
{  "board_id": "string",  "payout_generation": "string",  "revision_id": "string",  "build_generation": "string"}

Start a leaderboard standing build

POST
/leaderboards/{id}/boards/{board_id}/standing_builds

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Path Parameters

id*string
Length1 <= length
board_id*string
Length1 <= length <= 128

Header Parameters

Idempotency-Key*string

Required. Official clients generate a UUID when omitted by the caller.

Length1 <= length <= 255
X-Orishare-Environment?string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length
X-Orishare-Audit-Reason?string

Required for staff authorization. Records the reason for staff access.

Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/leaderboards/string/boards/string/standing_builds" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "expected_generation": "0"  }'
{  "board_id": "string",  "payout_generation": "string",  "revision_id": "string",  "build_generation": "string"}

Imports

Customer and balance imports from another loyalty program: chunked upload, dry run, run and reconciliation.

Leagues

Weekly cohorts on a tier ladder with promotion, demotion and rank rewards.