Sign in
OpenMeter Notifications

List notification events

Changed on

List all notification events.

get/openmeter/notification/events

Request

  • Base URL: http://localhost:8888/api/v3
  • URL: http://localhost:8888/api/v3/openmeter/notification/events
  • Auth: none declared

Query parameters

sizeinteger

The number of items to include per page.

numberinteger

The page number.

Determines which page of the collection to retrieve.

sortstring

The asc suffix is optional as the default sort order is ascending. The desc suffix is used to specify a descending order. Multiple sort attributes may be provided via a comma separated list. JSONPath notation may be used to specify a sub-attribute (eg: 'foo.bar desc').

Example:created_at desc

Sort notification events returned in the response. Supported sort attributes are:

  • created_at (default)
  • id
  • type

The asc suffix is optional as the default sort order is ascending. The desc suffix is used to specify a descending order. Without a sort parameter, events are returned newest first.

Filter notification events returned in the response.

Examples:

  • filter[type]=invoice.created
  • filter[delivery_status]=failed
  • filter[subject_key]=customer-1
{
  "id": "01G65Z755AFWAKHE12NY0CQ9FH",
  "created_at": "2023-01-01T01:01:01.001Z",
  "rule_id": "01G65Z755AFWAKHE12NY0CQ9FH",
  "channel_id": "01G65Z755AFWAKHE12NY0CQ9FH",
  "subject_id": "01G65Z755AFWAKHE12NY0CQ9FH",
  "feature_id": "01G65Z755AFWAKHE12NY0CQ9FH"
}

Response

Page paginated response.

Example response

{
  "data": [
    {
      "id": "01G65Z755AFWAKHE12NY0CQ9FH",
      "created_at": "2023-01-01T01:01:01.001Z",
      "rule": {
        "id": "01G65Z755AFWAKHE12NY0CQ9FH"
      },
      "delivery_status": [
        {
          "channel_id": "01G65Z755AFWAKHE12NY0CQ9FH",
          "updated_at": "2023-01-01T01:01:01.001Z",
          "next_attempt": "2023-01-01T01:01:01.001Z",
          "attempts": [
            {
              "timestamp": "2023-01-01T01:01:01.001Z"
            }
          ]
        }
      ],
      "payload": {
        "id": "01G65Z755AFWAKHE12NY0CQ9FH",
        "timestamp": "2023-01-01T01:01:01.001Z",
        "data": {
          "entitlement_id": "01G65Z755AFWAKHE12NY0CQ9FH",
          "feature": {
            "id": "01G65Z755AFWAKHE12NY0CQ9FH"
          },
          "customer_id": "01G65Z755AFWAKHE12NY0CQ9FH",
          "value": {
            "feature_key": "resource_key",
            "has_access": true,
            "config": "{ \"availableModels\": [\"gpt-5\", \"gpt-4o\"] }",
            "value": {
              "balance": "100",
              "usage": "50",
              "overage": "0",
              "total_available_grant_amount": "100",
              "grant_balances": {
                "additional_property": "1"
              }
            }
          }
        }
      }
    }
  ],
  "meta": {
    "page": {
      "number": 1,
      "size": 10,
      "total": 100
    }
  }
}

Changes