Search for events (deprecated)

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

Authorization

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

deprecated

This endpoint has been deprecated and may be removed in future versions of the API.

Allows searching for events matching the search criteria in the request body

Request

application/json

Body

required

deprecatedSearchEventsSchema

type string
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]
Find events by event type (case-sensitive).
project string
Find events by project ID (case-sensitive).
feature string
Find events by feature flag name (case-sensitive).
query string
Find events by a free-text search query. The query will be matched against the event type, the username or email that created the event (if any), and the event data payload (if any).
limit integer
Possible values: >= 1 and <= 100
Default value: 100
The maximum amount of events to return in the search result
offset integer
Which event id to start listing from

Responses

eventsSchema

application/json

Schema
Example (from schema)

Schema

version integer required
Possible values: >= 1, [1]
The api version of this response. A natural increasing number. Only increases if format changes
events object[]required
The list of events
Array [
id integer required
Possible values: >= 1
The ID of the event. An increasing natural number.
createdAt date-time required
The time the event happened as a RFC 3339-conformant timestamp.
type string required
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]
What type of event this is
createdBy string required
Which user created this event
createdByUserId number nullable
The is of the user that created this event
environment string nullable
The feature flag environment the event relates to, if applicable.
project string nullable
The project the event relates to, if applicable.
featureName string nullable
The name of the feature flag the event relates to, if applicable.
data object nullable
Extra associated data related to the event, such as feature flag state, segment configuration, etc., if applicable.
preData object nullable
Data relating to the previous state of the event's subject.
tags object[]nullable
Any tags related to the event, if applicable.
Array [
value string required
Possible values: >= 2 characters and <= 50 characters
The value of the tag.
type string required
Possible values: >= 2 characters and <= 50 characters
The type of the tag
]
label string nullable
[Experimental] The concise, human-readable name of the event.
summary string nullable
[Experimental] A markdown-formatted summary of the event.
]
totalEvents integer
The total count of events

{
  "version": 1,
  "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"
    }
  ],
  "totalEvents": 842
}

Authorization

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

Request

Base URL

<your-unleash-url>

Security Scheme

apiKey

Body required

{
  "type": "feature-created",
  "project": "default",
  "feature": "my.first.flag",
  "query": "admin@example.com",
  "limit": 50,
  "offset": 100
}

curl / cURL
curl -L -X POST '<your-unleash-url>/api/admin/events/search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "type": "feature-created",
  "project": "default",
  "feature": "my.first.flag",
  "query": "admin@example.com",
  "limit": 50,
  "offset": 100
}'

python / requests
curl -L -X POST '<your-unleash-url>/api/admin/events/search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "type": "feature-created",
  "project": "default",
  "feature": "my.first.flag",
  "query": "admin@example.com",
  "limit": 50,
  "offset": 100
}'

go / native
curl -L -X POST '<your-unleash-url>/api/admin/events/search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "type": "feature-created",
  "project": "default",
  "feature": "my.first.flag",
  "query": "admin@example.com",
  "limit": 50,
  "offset": 100
}'

nodejs / native
curl -L -X POST '<your-unleash-url>/api/admin/events/search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "type": "feature-created",
  "project": "default",
  "feature": "my.first.flag",
  "query": "admin@example.com",
  "limit": 50,
  "offset": 100
}'

ruby / Net::HTTP
curl -L -X POST '<your-unleash-url>/api/admin/events/search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "type": "feature-created",
  "project": "default",
  "feature": "my.first.flag",
  "query": "admin@example.com",
  "limit": 50,
  "offset": 100
}'

csharp / httpclient
curl -L -X POST '<your-unleash-url>/api/admin/events/search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "type": "feature-created",
  "project": "default",
  "feature": "my.first.flag",
  "query": "admin@example.com",
  "limit": 50,
  "offset": 100
}'

php / cURL
curl -L -X POST '<your-unleash-url>/api/admin/events/search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "type": "feature-created",
  "project": "default",
  "feature": "my.first.flag",
  "query": "admin@example.com",
  "limit": 50,
  "offset": 100
}'

java / OkHttp
curl -L -X POST '<your-unleash-url>/api/admin/events/search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "type": "feature-created",
  "project": "default",
  "feature": "my.first.flag",
  "query": "admin@example.com",
  "limit": 50,
  "offset": 100
}'

powershell / RestMethod
curl -L -X POST '<your-unleash-url>/api/admin/events/search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "type": "feature-created",
  "project": "default",
  "feature": "my.first.flag",
  "query": "admin@example.com",
  "limit": 50,
  "offset": 100
}'

Search for events (deprecated)

Authorization

Request​

Body

Authorization

Request

Request