List Metadata

{ "metadata": [ { "value": true, "key": "has_beta_access", "type": "bool", "tags": [] }, { "value": "xXx_ProGamer9000_xXx", "key": "preferred_nickname", "type": "string", "tags": [ "foo" ] }, { "value": 35, "key": "player_age", "type": "number", "tags": [ "foo", "bar", "baz" ] }, { "value": { "key": "value", "properties": { "tutorial_complete": true, "chapter_one_complete": true } }, "key": "game_state", "type": "json", "tags": [] }, { "value": { "content_type": "image/jpeg", "content": "iVBORw0KGgoAAAANSUhEUgAAAAgAAAAIAQMAAAD+wSzIAAAABlBMVEX///+/v7+jQ3Y5AAAADklEQVQI12P4AIX8EAgALgAD/aNpbtEAAAAASUVORK5CYII=" }, "key": "chosen_icon", "type": "base64", "tags": [] } ], "pagination": { "errors": null, "per_page": 10, "offset": 0, "total": 5, "last_page": 1, "current_page": 1, "next_page": null, "prev_page": null } }

Request

Path Params

source

string

required

Source can be any of the supported features.
Example: leaderboard,reward, catalog_item,currency, progression, player

Example:

reward

source_id

string

required

Example:

01J3ZEYRX4QVFZ0QC4DF4J1SST

Query Params

page

string

optional

Page you want to see.

Example:

per_page

string

optional

Number of items you want to see per page (max 100)

Example:

key

string

optional

A specific metadata item identified by key (supercedes all other search parameters)

Example:

has_beta_access

tags

array[string]

required

type

enum<string>

required

Defines the type of metadata value you are passing in.

All types are self-explanatory with the notable exception of base64, which requires you follow this specific value format:

{
    "content-type": "<some content type, e.g. image/jpeg>",
    "content": "<some base64 value>"
}

Allowed values:

jsonbase64numberstringbool

value

Metadata Value

required

The actual value of the metadata.

pagination

object (Offset Pagination)

required

errors

array [object {2}]

required

If the values provided don't allow for pagination to happen, errors will be indicated within this array.

per_page

integer

required

offset

integer

required

How far you are within the total set of records.

total

integer

required

How many items total were found.

last_page

integer

required

current_page

integer

required

next_page

integer | null

required

prev_page

integer | null

required

Request

Responses