Metering Events

List metering events

Changed on

List ingested events.

get/openmeter/events

Request

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

Query parameters

sizeinteger

The number of items to include per page.

afterstring

Request the next page of data, starting with the item after this parameter.

beforestring

Request the previous page of data, starting with the item before this parameter.

Filter events returned in the response.

To filter events by subject add the following query param: filter[subject][eq]=customer-1

{
  "customer_id": "01G65Z755AFWAKHE12NY0CQ9FH",
  "time": "2023-01-01T01:01:01.001Z",
  "ingested_at": "2023-01-01T01:01:01.001Z",
  "stored_at": "2023-01-01T01:01:01.001Z"
}
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 events returned in the response. Supported sort attributes are:

  • time (default)
  • ingested_at
  • stored_at

When omitted, events are sorted by time desc (most recent first). When a sort field is provided without a suffix, it sorts descending. Append the asc suffix to sort ascending, or the desc suffix to sort descending.

Response

Cursor paginated response.

Example response

{
  "data": [
    {
      "event": {
        "id": "5c10fade-1c9e-4d6c-8275-c52c36731d3c",
        "source": "service-name",
        "specversion": "1.0",
        "type": "prompt",
        "subject": "customer_key",
        "time": "2023-01-01T01:01:01.001Z"
      },
      "customer": {
        "id": "01G65Z755AFWAKHE12NY0CQ9FH"
      },
      "ingested_at": "2023-01-01T01:01:01.001Z",
      "stored_at": "2023-01-01T01:01:02.001Z"
    }
  ],
  "meta": {
    "page": {
      "size": 10
    }
  }
}

Changes

  • v33be06f269447Revision changes
    • info

      for the query request parameter filter, the format of property customer_id/allOf[subschema #1: ULID Field Filter]/anyOf[subschema #2]/oeq was generalized from ArrayEncoding.commaDelimited to no format

    • info

      for the query request parameter filter, the format of property id/allOf[StringFieldFilter]/anyOf[subschema #2]/ocontains was generalized from ArrayEncoding.commaDelimited to no format

    • info

      for the query request parameter filter, the format of property id/allOf[StringFieldFilter]/anyOf[subschema #2]/oeq was generalized from ArrayEncoding.commaDelimited to no format

    • info

      for the query request parameter filter, the format of property source/allOf[StringFieldFilter]/anyOf[subschema #2]/ocontains was generalized from ArrayEncoding.commaDelimited to no format

    • info

      for the query request parameter filter, the format of property source/allOf[StringFieldFilter]/anyOf[subschema #2]/oeq was generalized from ArrayEncoding.commaDelimited to no format

    • info

      for the query request parameter filter, the format of property subject/allOf[StringFieldFilter]/anyOf[subschema #2]/ocontains was generalized from ArrayEncoding.commaDelimited to no format

    • info

      for the query request parameter filter, the format of property subject/allOf[StringFieldFilter]/anyOf[subschema #2]/oeq was generalized from ArrayEncoding.commaDelimited to no format

    • info

      for the query request parameter filter, the format of property type/allOf[StringFieldFilter]/anyOf[subschema #2]/ocontains was generalized from ArrayEncoding.commaDelimited to no format

    • info

      for the query request parameter filter, the format of property type/allOf[StringFieldFilter]/anyOf[subschema #2]/oeq was generalized from ArrayEncoding.commaDelimited to no format

  • v39d0042cb3815Revision changes
    • breaking

      for the query request parameter filter, the format of property customer_id/allOf[subschema #1: ULID Field Filter]/anyOf[subschema #2]/oeq was specialized from no format to ArrayEncoding.commaDelimited

    • breaking

      for the query request parameter filter, the format of property id/allOf[StringFieldFilter]/anyOf[subschema #2]/ocontains was specialized from no format to ArrayEncoding.commaDelimited

    • breaking

      for the query request parameter filter, the format of property id/allOf[StringFieldFilter]/anyOf[subschema #2]/oeq was specialized from no format to ArrayEncoding.commaDelimited

    • breaking

      for the query request parameter filter, the format of property source/allOf[StringFieldFilter]/anyOf[subschema #2]/ocontains was specialized from no format to ArrayEncoding.commaDelimited

    • breaking

      for the query request parameter filter, the format of property source/allOf[StringFieldFilter]/anyOf[subschema #2]/oeq was specialized from no format to ArrayEncoding.commaDelimited

    • breaking

      for the query request parameter filter, the format of property subject/allOf[StringFieldFilter]/anyOf[subschema #2]/ocontains was specialized from no format to ArrayEncoding.commaDelimited

    • breaking

      for the query request parameter filter, the format of property subject/allOf[StringFieldFilter]/anyOf[subschema #2]/oeq was specialized from no format to ArrayEncoding.commaDelimited

    • breaking

      for the query request parameter filter, the format of property type/allOf[StringFieldFilter]/anyOf[subschema #2]/ocontains was specialized from no format to ArrayEncoding.commaDelimited

    • breaking

      for the query request parameter filter, the format of property type/allOf[StringFieldFilter]/anyOf[subschema #2]/oeq was specialized from no format to ArrayEncoding.commaDelimited