Get the most recent events from the Unleash instance or all events related to a project.

curl https://app.unleash-instance.example.com/api/admin/events \
     -H "Authorization: <apiKey>"

{
  "version": 1,
  "events": [
    {
      "id": 1,
      "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",
          "color": "#FFFFFF"
        }
      ],
      "label": "string",
      "summary": "string",
      "ip": "192.168.1.1",
      "groupType": "change-request",
      "groupId": "01HQVX5K8P9EXAMPLE123456"
    }
  ],
  "totalEvents": 842
}

curl https://app.unleash-instance.example.com/api/admin/events \
     -H "Authorization: <apiKey>"

{
  "version": 1,
  "events": [
    {
      "id": 1,
      "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",
          "color": "#FFFFFF"
        }
      ],
      "label": "string",
      "summary": "string",
      "ip": "192.168.1.1",
      "groupType": "change-request",
      "groupId": "01HQVX5K8P9EXAMPLE123456"
    }
  ],
  "totalEvents": 842
}

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.

Authentication

Authorizationstring

API key needed to access this API

AuthorizationBearer

API key needed to access this API, in Bearer token format

Query parameters

projectstringOptional

The name of the project whose events you want to retrieve

Response

eventsSchema

versionenum

The api version of this response. A natural increasing number. Only increases if format changes

Allowed values:

eventslist of objects

The list of events

totalEventsinteger>=0

The total count of events

Errors

401

Unauthorized Error

$	curl https://app.unleash-instance.example.com/api/admin/events \
>	-H "Authorization: <apiKey>"

1	{
2	"version": 1,
3	"events": [
4	{
5	"id": 1,
6	"createdAt": "2023-07-05T12:56:00.000Z",
7	"type": "feature-created",
8	"createdBy": "johndoe",
9	"createdByUserId": 1337,
10	"environment": "development",
11	"project": "default",
12	"featureName": "my.first.feature",
13	"data": {
14	"name": "new-feature",
15	"description": "Flag description",
16	"type": "release",
17	"project": "my-project",
18	"stale": false,
19	"variants": [],
20	"createdAt": "2022-05-31T13:32:20.547Z",
21	"lastSeenAt": null,
22	"impressionData": true
23	},
24	"preData": {
25	"name": "new-feature",
26	"description": "Flag description",
27	"type": "release",
28	"project": "my-project",
29	"stale": false,
30	"variants": [],
31	"createdAt": "2022-05-31T13:32:20.547Z",
32	"lastSeenAt": null,
33	"impressionData": true
34	},
35	"tags": [
36	{
37	"value": "a-tag-value",
38	"type": "simple",
39	"color": "#FFFFFF"
40	}
41	],
42	"label": "string",
43	"summary": "string",
44	"ip": "192.168.1.1",
45	"groupType": "change-request",
46	"groupId": "01HQVX5K8P9EXAMPLE123456"
47	}
48	],
49	"totalEvents": 842
50	}