Search for events
GET <your-unleash-url>/api/admin/search/events
Authorization
name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API
Allows searching for events matching the search criteria in the request body. This operation is deprecated. You should perform a GET request to the same endpoint with your query encoded as query parameters instead.
Request
Query Parameters
- query string
Find events by a free-text search query. The query will be matched against the event data payload (if any).
- feature string
Possible values: Value must match regular expression
^(IS|IS_ANY_OF):(.*?)(,([a-zA-Z0-9_]+))*$
Filter by feature name using supported operators: IS, IS_ANY_OF
- project string
Possible values: Value must match regular expression
^(IS|IS_ANY_OF):(.*?)(,([a-zA-Z0-9_]+))*$
Filter by projects ID using supported operators: IS, IS_ANY_OF.
- type string
Possible values: Value must match regular expression
^(IS|IS_ANY_OF):(.*?)(,([a-zA-Z0-9_]+))*$
Filter by event type using supported operators: IS, IS_ANY_OF.
- createdBy string
Possible values: Value must match regular expression
^(IS|IS_ANY_OF):(.*?)(,([a-zA-Z0-9_]+))*$
Filter by the ID of the event creator, using supported operators: IS, IS_ANY_OF.
- from string
Possible values: Value must match regular expression
^(IS):\d{4}-\d{2}-\d{2}$
The starting date of the creation date range in IS:yyyy-MM-dd format
- to string
Possible values: Value must match regular expression
^(IS):\d{4}-\d{2}-\d{2}$
The ending date of the creation date range in IS:yyyy-MM-dd format
- offset string
Default value:
0
The number of features to skip when returning a page. By default it is set to 0.
- limit string
Default value:
50
The number of feature environments to return in a page. By default it is set to 50. The maximum is 1000.
- 200
eventSearchResponseSchema
- application/json
- Schema
- Example (from schema)
Schema
events object[]required
- total integer required
The total count of events
{
"events": [
{
"id": 0,
"createdAt": "2023-07-05T12:56:00.000Z",
"type": "feature-created",
"createdBy": "johndoe",
"createdByUserId": 1337,
"environment": "development",
"project": "default",
"featureName": "my.first.feature",
"data": {
"name": "new-feature",
"description": "Flag description",
"type": "release",
"project": "my-project",
"stale": false,
"variants": [],
"createdAt": "2022-05-31T13:32:20.547Z",
"lastSeenAt": null,
"impressionData": true
},
"preData": {
"name": "new-feature",
"description": "Flag description",
"type": "release",
"project": "my-project",
"stale": false,
"variants": [],
"createdAt": "2022-05-31T13:32:20.547Z",
"lastSeenAt": null,
"impressionData": true
},
"tags": [
{
"value": "a-tag-value",
"type": "simple"
}
]
}
],
"total": 842
}
Authorization
name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API
Request
Request
curl -L -X GET '<your-unleash-url>/api/admin/search/events' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
curl -L -X GET '<your-unleash-url>/api/admin/search/events' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
curl -L -X GET '<your-unleash-url>/api/admin/search/events' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
curl -L -X GET '<your-unleash-url>/api/admin/search/events' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
curl -L -X GET '<your-unleash-url>/api/admin/search/events' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
curl -L -X GET '<your-unleash-url>/api/admin/search/events' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
curl -L -X GET '<your-unleash-url>/api/admin/search/events' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
curl -L -X GET '<your-unleash-url>/api/admin/search/events' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
curl -L -X GET '<your-unleash-url>/api/admin/search/events' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'