Skip to main content
GET
List the values one caller-defined metadata key takes

Authorizations

Authorization
string
header
required

A Recursion API key, created in the console under API keys.

Query Parameters

key
string
required

The caller-defined metadata key whose values to list. Same alphabet as on startSession: letters, digits, '_', '.', and '-', up to 64 characters.

q
string

Case-sensitive prefix the returned values must start with, up to 512 characters. Omit to list every value up to limit.

limit
integer
default:50

Most distinct values to return. When more match, truncated is true; narrow q rather than asking for more.

Required range: 1 <= x <= 200

Response

Response body of GET /v1/sessions/metadata-values: the distinct values one caller-defined metadata key takes across the sessions the caller may list.

Response body of GET /v1/sessions/metadata-values: the distinct values one caller-defined metadata key takes across the sessions the caller may list.

values
string[]
required

Distinct values the key takes on sessions the caller may list, sorted, narrowed to the q prefix when one was given. Always an array; empty when nothing matches.

truncated
boolean

True when more distinct values match than limit allowed. The list is sorted, so narrow with a longer q prefix rather than paging.