Get all events related to a specific feature flag.
GET /api/admin/events/:featureName
Returns all events related to the specified feature flag. If the feature flag does not exist, the list of events will be empty.
Request
Path Parameters
- featureName string required
- 200
- 401
featureEventsSchema
- application/json
- Schema
- Example (from schema)
Schema
- version integer
Possible values:
>= 1
, [1
]An API versioning number
- toggleName string
The name of the feature flag these events relate to
events object[]required
The list of events
Array [id integer requiredPossible values:
>= 1
The ID of the event. An increasing natural number.
createdAt date-time requiredThe time the event happened as a RFC 3339-conformant timestamp.
type string requiredPossible 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-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 requiredWhich user created this event
createdByUserId number nullableThe is of the user that created this event
environment string nullableThe feature flag environment the event relates to, if applicable.
project string nullableThe project the event relates to, if applicable.
featureName string nullableThe name of the feature flag the event relates to, if applicable.
data object nullableExtra associated data related to the event, such as feature flag state, segment configuration, etc., if applicable.
preData object nullableData relating to the previous state of the event's subject.
tags object[]nullable
Any tags related to the event, if applicable.
Array [value string requiredPossible values:
>= 2 characters
and<= 50 characters
The value of the tag.
]]- totalEvents integer
How many events are there for this feature flag
{
"version": 1,
"toggleName": "my.first.feature.flag",
"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"
}
]
}
],
"totalEvents": 13
}
Authorization information is missing or invalid. Provide a valid API token as the authorization
header, e.g. authorization:*.*.my-admin-token
.
- application/json
- Schema
- Example (from schema)
Schema
- id string
The ID of the error instance
- name string
The name of the error kind
- message string
A description of what went wrong.
{
"id": "9c40958a-daac-400e-98fb-3bb438567008",
"name": "AuthenticationRequired",
"message": "You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login."
}