Search for events

GET

https://app.unleash-instance.example.com/api/admin/search/events

GET

/api/admin/search/events

$ curl https://app.unleash-instance.example.com/api/admin/search/events \
>      -H "Authorization: <apiKey>"

200Retrieved

1 {
2   "events": [
3     {
4       "id": 1,
5       "createdAt": "2023-07-05T12:56:00.000Z",
6       "type": "feature-created",
7       "createdBy": "johndoe",
8       "createdByUserId": 1337,
9       "environment": "development",
10       "project": "default",
11       "featureName": "my.first.feature",
12       "data": {
13         "name": "new-feature",
14         "description": "Flag description",
15         "type": "release",
16         "project": "my-project",
17         "stale": false,
18         "variants": [],
19         "createdAt": "2022-05-31T13:32:20.547Z",
20         "lastSeenAt": null,
21         "impressionData": true
22       },
23       "preData": {
24         "name": "new-feature",
25         "description": "Flag description",
26         "type": "release",
27         "project": "my-project",
28         "stale": false,
29         "variants": [],
30         "createdAt": "2022-05-31T13:32:20.547Z",
31         "lastSeenAt": null,
32         "impressionData": true
33       },
34       "tags": [
35         {
36           "value": "a-tag-value",
37           "type": "simple",
38           "color": "#FFFFFF"
39         }
40       ],
41       "label": "string",
42       "summary": "string",
43       "ip": "192.168.1.1",
44       "groupType": "change-request",
45       "groupId": "01HQVX5K8P9EXAMPLE123456"
46     }
47   ],
48   "total": 842
49 }

Allows searching for events that match the query parameter criteria.

Authentication

Authorizationstring

API key needed to access this API

AuthorizationBearer

API key needed to access this API, in Bearer token format

Query parameters

querystringOptional

Find events by a free-text search query. The query will be matched against the event data payload (if any).

idstringOptionalformat: "^(IS|IS_ANY_OF):(.*?)(,([0-9]+))*$"

Filter by event ID using supported operators: IS, IS_ANY_OF.

groupIdstringOptionalformat: "^(IS|IS_ANY_OF):(.*?)(,([0-9]+))*$"

Filter by group ID using supported operators: IS, IS_ANY_OF.

featurestringOptionalformat: "^(IS|IS_ANY_OF):(.*?)(,([a-zA-Z0-9_]+))*$"

Filter by feature name using supported operators: IS, IS_ANY_OF

projectstringOptionalformat: "^(IS|IS_ANY_OF):(.*?)(,([a-zA-Z0-9_]+))*$"

Filter by projects ID using supported operators: IS, IS_ANY_OF.

typestringOptionalformat: "^(IS|IS_ANY_OF):(.*?)(,([a-zA-Z0-9_]+))*$"

Filter by event type using supported operators: IS, IS_ANY_OF.

createdBystringOptionalformat: "^(IS|IS_ANY_OF):(.*?)(,([a-zA-Z0-9_]+))*$"

Filter by the ID of the event creator, using supported operators: IS, IS_ANY_OF.

fromstringOptionalformat: "^(IS):\d{4}-\d{2}-\d{2}$"

The starting date of the creation date range in IS:yyyy-MM-dd format

tostringOptionalformat: "^(IS):\d{4}-\d{2}-\d{2}$"

The ending date of the creation date range in IS:yyyy-MM-dd format

offsetstringOptionalDefaults to 0

The number of features to skip when returning a page. By default it is set to 0.

limitstringOptionalDefaults to 50

The number of feature environments to return in a page. By default it is set to 50. The maximum is 1000.

environmentstringOptionalformat: "^(IS|IS_ANY_OF):(.*?)(,([a-zA-Z0-9_]+))*$"

Filter by environment name using supported operators: IS, IS_ANY_OF.

Response

eventSearchResponseSchema

eventslist of objects

The list of events

totalinteger>=0

The total count of events