VIvivino
lists

Return Single List

Return Single List. Note that top and bottom element will be omitted on empty lists.

Required security scopes:

  • api:read
get/lists/{list_id}

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

top_bottomboolean

Include top_element and bottom_element in result.

Response

OK

avg_segment_elementsnumber double required

Average number of elements per segment

cache_hitsinteger required

Cache hits while segments have been loaded.

cache_missesinteger required

Cache misses while segments have been loaded.

cache_percentnumber double required

Cache hit percentage while segments have been loaded.

elementsinteger required

Number of elements in 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 _-.

load_indexboolean required

Load Index on server startup

merge_sizeinteger required

Merge adjacent Segments with less than this number of entries

metadataobject required

Custom metadata. String to String hash.

segmentsinteger required

Number of segment in list

setstring required

Set used for storage

split_sizeinteger required

Split Segments larger than this number of entries

Example response

{
  "avg_segment_elements": 1005.5,
  "bottom_element": {
    "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"
  },
  "cache_hits": 643,
  "cache_misses": 123,
  "cache_percent": 64.56,
  "elements": 15000,
  "id": "highscore-list",
  "load_index": false,
  "merge_size": 500,
  "metadata": {
    "country": "dk",
    "game": "2"
  },
  "segments": 15,
  "set": "storage-set",
  "split_size": 2000,
  "top_element": {
    "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.