REST API ReferenceDashboard APIApps
Fetch what an entity can be filtered by
GET
/apps/{id}/filters/keysFetches the keys available in an entity, in display order. Each key
includes its label and description, the type of value it accepts, the
operators that type supports, and where its values come from.
key_groups lists the groups the keys fall into, also in display order.
Unrelated to /apps/{id}/filters, which serves the older fixed set of
app filters.
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.
Format
uuidQuery Parameters
entity*"builds"
Name of the entity to describe.
Value in
- "builds"
Response Body
application/json
curl -X GET "https://example.com/apps/497f6eca-6276-4993-bfeb-53cbbbba6f08/filters/keys?entity=builds"{ "key_groups": [ "Version", "Build" ], "keys": [ { "name": "version_name", "label": "App version", "description": "The version of the app.", "key_group": "Version", "value_type": "string", "operators": [ "in", "not_in", "contains", "starts_with" ], "value_suggestion_mode": "sample" }, { "name": "mapping_type", "label": "Mapping type", "description": "The kind of symbol file uploaded: proguard, dSYM, ELF debug or JS bundle.", "key_group": "Build", "value_type": "enum", "operators": [ "in", "not_in" ], "value_suggestion_mode": "full_list" }, { "name": "patch_id", "label": "Patch id", "description": "The id of an Over-The-Air patch.", "key_group": "Version", "value_type": "uuid", "operators": [ "in", "not_in", "is_set", "is_not_set" ], "value_suggestion_mode": "sample" } ]}Think this page can be better?
Open an issue