Events

Get all events related to a specific feature flag.

Returns all events related to the specified feature flag. If the feature flag does not exist, the list of events will be empty.

get/api/admin/events/{featureName}

Path parameters

featureNamestring required

Response

featureEventsSchema

version1

An API versioning number

toggleNamestring

The name of the feature flag these events relate to

totalEventsinteger

How many events are there for this feature flag

Example response

{
  "version": 1,
  "toggleName": "my.first.feature.flag",
  "events": [
    {
      "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"
        }
      ],
      "ip": "192.168.1.1",
      "groupType": "change-request",
      "groupId": "01HQVX5K8P9EXAMPLE123456"
    }
  ],
  "totalEvents": 13
}

Changes

Changed in 2 of the 7 revisions of this API.5

    • added the new safeguard-triggered enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new remote-mcp-server-settings-updated enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new user-access-request-approved enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new user-access-request-registered enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new user-access-request-rejected enum value to the // response property for the response status

      response-property-enum-value-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog