Measure logo
REST API ReferenceDashboard APIApps

Fetch the values one filter key can be set to

GET/apps/{id}/filters/values

Fetches the values a single key in an entity can be set to, narrowed by search.

For keys backed by app data, values are read from the entity's own rows, most recently seen first, with rows where the key is unset excluded. For keys with a fixed set of values, such as mapping_type, values come from the set the key declares, which a filter cannot go outside.

Only keys with a value_suggestion_mode of full_list or sample can be listed.

Authorization

bearerAuth
AuthorizationBearer <token>

User access token issued at sign-in. Sent as Authorization: Bearer <access-token> unless cookies are used to send tokens. The /auth/refresh and /auth/signout endpoints expect the session's refresh token in the same header format instead.

In: header

Path Parameters

id*string

App's UUID.

Formatuuid

Query Parameters

entity*"builds"

Name of the entity the key belongs to.

Value in

  • "builds"
key_name*string

Name of the key to list values for, as returned by /apps/{id}/filters/keys.

search?string

Substring to narrow values by. Values containing it are returned.

limit?integer

Number of values to return. Defaults to 50, cannot be more than 200.

Response Body

application/json

curl -X GET "https://example.com/apps/497f6eca-6276-4993-bfeb-53cbbbba6f08/filters/values?entity=builds&key_name=string"
{  "values": [    {      "text": "1.2.0"    },    {      "text": "1.1.9"    },    {      "text": "1.1.8-SNAPSHOT.debug"    }  ],  "truncated": false}

Think this page can be better?

Open an issue