Search for events

GET 
<your-unleash-url>/api/admin/search/events

Allows searching for events that match the query parameter criteria.

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
The number of features to skip when returning a page. By default it is set to 0.
Default value: 0
limit string
The number of feature environments to return in a page. By default it is set to 50. The maximum is 1000.
Default value: 50

Responses

200

eventSearchResponseSchema

application/json

Schema

Schema

events object[]required
The list of events
Array [
idintegerrequired
The ID of the event. An increasing natural number.
Possible values: >= 1
createdAtdate-timerequired
The time the event happened as a RFC 3339-conformant timestamp.
Example: 2023-07-05T12:56:00.000Z
typestringrequired
What type of event this is
Possible values: [application-created, feature-created, feature-deleted, feature-updated, feature-metadata-updated, feature-variants-updated, feature-environment-variants-updated, feature-project-change, feature-archived, feature-revived, feature-import, feature-tagged, feature-tag-import, feature-strategy-update, feature-strategy-add, feature-strategy-remove, feature-type-updated, feature-completed, feature-uncompleted, strategy-order-changed, drop-feature-tags, feature-untagged, feature-stale-on, feature-stale-off, drop-features, feature-environment-enabled, feature-environment-disabled, strategy-created, strategy-deleted, strategy-deprecated, strategy-reactivated, strategy-updated, strategy-import, drop-strategies, context-field-created, context-field-updated, context-field-deleted, project-access-added, project-access-user-roles-updated, project-access-group-roles-updated, project-access-user-roles-deleted, project-access-group-roles-deleted, project-access-updated, project-created, project-updated, project-deleted, project-archived, project-revived, project-import, project-user-added, project-user-removed, project-user-role-changed, project-group-role-changed, project-group-added, project-group-removed, role-created, role-updated, role-deleted, drop-projects, tag-created, tag-deleted, tag-import, drop-tags, tag-type-created, tag-type-deleted, tag-type-updated, tag-type-import, drop-tag-types, addon-config-created, addon-config-updated, addon-config-deleted, db-pool-update, user-created, user-updated, user-deleted, drop-environments, environment-import, environment-created, environment-updated, environment-deleted, segment-created, segment-updated, segment-deleted, group-created, group-updated, group-deleted, group-user-added, group-user-removed, setting-created, setting-updated, setting-deleted, client-metrics, client-register, pat-created, pat-deleted, public-signup-token-created, public-signup-token-user-added, public-signup-token-updated, change-request-created, change-request-discarded, change-added, change-discarded, change-edited, change-request-rejected, change-request-approved, change-request-approval-added, change-request-cancelled, change-request-sent-to-review, change-request-schedule-suspended, change-request-applied, change-request-scheduled, change-request-scheduled-application-success, change-request-scheduled-application-failure, change-request-configuration-updated, api-token-created, api-token-updated, api-token-deleted, feature-favorited, feature-unfavorited, project-favorited, project-unfavorited, features-exported, features-imported, service-account-created, service-account-deleted, service-account-updated, feature-potentially-stale-on, feature-dependency-added, feature-dependency-removed, feature-dependencies-removed, banner-created, banner-updated, banner-deleted, project-environment-added, project-environment-removed, default-strategy-updated, segment-import, signal-endpoint-created, signal-endpoint-updated, signal-endpoint-deleted, signal-endpoint-token-created, signal-endpoint-token-updated, signal-endpoint-token-deleted, actions-created, actions-updated, actions-deleted, release-plan-template-created, release-plan-template-updated, release-plan-template-deleted, release-plan-template-archived, release-plan-added, release-plan-removed, release-plan-milestone-started, user-preference-updated, scim-users-deleted, scim-groups-deleted]
Example: feature-created
createdBystringrequired
Which user created this event
Example: johndoe
createdByUserIdnumbernullable
The is of the user that created this event
Example: 1337
environmentstringnullable
The feature flag environment the event relates to, if applicable.
Example: development
projectstringnullable
The project the event relates to, if applicable.
Example: default
featureNamestringnullable
The name of the feature flag the event relates to, if applicable.
Example: my.first.feature
dataobjectnullable
Extra associated data related to the event, such as feature flag state, segment configuration, etc., if applicable.
Example: {"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}
preDataobjectnullable
Data relating to the previous state of the event's subject.
Example: {"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 object[]nullable
Any tags related to the event, if applicable.
Array [
valuestringrequired
The value of the tag.
Possible values: >= 2 characters and <= 50 characters
Example: a-tag-value
typestringrequired
The type of the tag
Possible values: >= 2 characters and <= 50 characters
Example: simple
]
labelstringnullable
The concise, human-readable name of the event.
summarystringnullable
A markdown-formatted summary of the event.
ipstringnullable
The IP address of the user that created the event. Only available in Enterprise.
Example: 192.168.1.1
]
totalintegerrequired
The total count of events
Example: 842

Example (auto)

{
  "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"
        }
      ],
      "label": "string",
      "summary": "string",
      "ip": "192.168.1.1"
    }
  ],
  "total": 842
}

Authorization: Authorization

name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L '<your-unleash-url>/api/admin/search/events' \
-H 'Accept: application/json' \
-H 'Authorization: <Authorization>'

Request Collapse all

Base URL

<your-unleash-url>

Auth

Security Scheme

apiKeybearerToken

apiKey

Parameters

query — query

feature — query

project — query

type — query

createdBy — query

from — query

to — query

offset — query

limit — query

ResponseClear

Click the Send API Request button above and see the response here!