Get the most recent events from the Unleash instance or all events related to a project.
GET <your-unleash-url>/api/admin/events
Authorization
name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API
Returns the last 100 events from the Unleash instance when called without a query parameter. When called with a project
parameter, returns all events for the specified project.
If the provided project does not exist, the list of events will be empty.
Request
Query Parameters
- project string
The name of the project whose events you want to retrieve
Responses
- 200
- 401
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
- 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": "Toggle 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": "Toggle 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": 842
}
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."
}
Authorization
name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API
Request
Request
curl / cURL
curl -L -X GET '<your-unleash-url>/api/admin/events' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
python / requests
curl -L -X GET '<your-unleash-url>/api/admin/events' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
go / native
curl -L -X GET '<your-unleash-url>/api/admin/events' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
nodejs / axios
curl -L -X GET '<your-unleash-url>/api/admin/events' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
ruby / Net::HTTP
curl -L -X GET '<your-unleash-url>/api/admin/events' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
csharp / RestSharp
curl -L -X GET '<your-unleash-url>/api/admin/events' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
php / cURL
curl -L -X GET '<your-unleash-url>/api/admin/events' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
java / OkHttp
curl -L -X GET '<your-unleash-url>/api/admin/events' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
powershell / RestMethod
curl -L -X GET '<your-unleash-url>/api/admin/events' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'