VIvivino
lists

Get rank range of the list

Get rank range of the list. Either from_top or from_bottom must be supplied

Required security scopes:

  • api:read
get/lists/{list_id}/range

Request

Path parameters

list_idstring required

The ID of the list to apply the operation on. Can be a to z (both upper/lower case), 0 to 9 or one of these characters _-.

Query parameters

from_bottominteger

First result will be at this rank from the bottom of the list.

from_topinteger

First result will be at this rank from the top of the list.

limitinteger

Number of results to return

Response

OK

from_bottominteger required

Element rank in list from bottom. Bottom element has value 0.

from_topinteger required

Element rank in list from top. Top element has value 0.

idinteger required

ID of element

list_idstring required

The ID of the list to apply the operation on. Can be a to z (both upper/lower case), 0 to 9 or one of these characters _-.

payloadobject required

Custom payload. Stored untouched. On updates null means do not update. {} is the empty value.

scoreinteger required

Score of the element. Higher score gives higher placement.

tie_breakerinteger required

Tie breaker, used if score matches for consistent sorting. Higher value = higher placement if score is equal.

updated_atstring date-time required

Date of last update

Example response

[
  {
    "from_bottom": 4000,
    "from_top": 50,
    "id": 100,
    "list_id": "highscore-list",
    "payload": {
      "country": "dk",
      "name": "Mark Anthony"
    },
    "score": 100,
    "tie_breaker": 2000,
    "updated_at": "1996-11-22T14:02:34Z"
  },
  {
    "from_bottom": 4000,
    "from_top": 50,
    "id": 100,
    "list_id": "highscore-list",
    "payload": {
      "country": "dk",
      "name": "Mark Anthony"
    },
    "score": 100,
    "tie_breaker": 2000,
    "updated_at": "1996-11-22T14:02:34Z"
  },
  {
    "from_bottom": 4000,
    "from_top": 50,
    "id": 100,
    "list_id": "highscore-list",
    "payload": {
      "country": "dk",
      "name": "Mark Anthony"
    },
    "score": 100,
    "tie_breaker": 2000,
    "updated_at": "1996-11-22T14:02:34Z"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.