Search

Search events

post/v1/events/search

For a set of events, look up matched billable metrics and customers by transaction id. This endpoint looks at transactions that occurred in the last 34 days, and is intended for sampling-based testing workflows. It is heavily rate limited.

Body Parameters

transactionIdsarray of string

The transaction IDs of the events to retrieve

Returns

idstring

customer_idstring

The ID of the customer in the ingest event body

event_typestring

timestampstring

formatdate-time

transaction_idstring

is_duplicateboolean

optional

matched_billable_metricsarray of object

optional

Hide ParametersShow Parameters

idstring

formatuuid

namestring

aggregatestring

optional

(DEPRECATED) use aggregation_type instead

aggregate_keysarray of string

optional

(DEPRECATED) use aggregation_key instead

aggregation_keystring

optional

A key that specifies which property of the event is used to aggregate data. This key must be one of the property filter names and is not applicable when the aggregation type is 'count'.

aggregation_typeenum

optional

"COUNT" OR "LATEST" OR "MAX" OR 2 more

Specifies the type of aggregation performed on matching events.

Hide ParametersShow Parameters

"COUNT"

"LATEST"

"MAX"

"SUM"

"UNIQUE"

archived_atstring

optional

RFC 3339 timestamp indicating when the billable metric was archived. If not provided, the billable metric is not archived.

formatdate-time

custom_fieldsmap

optional

event_type_filter

optional

An optional filtering rule to match the 'event_type' property of an event.

filtermap

optional

(DEPRECATED) use property_filters & event_type_filter instead

group_byarray of string

optional

(DEPRECATED) use group_keys instead

group_keysarray of array of string

optional

Property names that are used to group usage costs on an invoice. Each entry represents a set of properties used to slice events into distinct buckets.

property_filtersarray of

optional

A list of filters to match events to this billable metric. Each filter defines a rule on an event property. All rules must pass for the event to match the billable metric.

sqlstring

optional

The SQL query associated with the billable metric

matched_customerobject

optional

The customer the event was matched to if a match was found

Hide ParametersShow Parameters

idstring

optional

formatuuid

namestring

optional

processed_atstring

optional

formatdate-time

propertiesmap

optional

curl https://api.metronome.com/v1/events/search \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $METRONOME_BEARER_TOKEN" \
    -d '{
          "transactionIds": [
            "2021-01-01T00:00:00Z_cluster42"
          ]
        }'

200 Example

[
  {
    "id": "id",
    "customer_id": "customer_id",
    "event_type": "event_type",
    "timestamp": "2019-12-27T18:11:19.117Z",
    "transaction_id": "transaction_id",
    "is_duplicate": true,
    "matched_billable_metrics": [
      {
        "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "name": "name",
        "aggregate": "aggregate",
        "aggregate_keys": [
          "string"
        ],
        "aggregation_key": "aggregation_key",
        "aggregation_type": "COUNT",
        "archived_at": "2019-12-27T18:11:19.117Z",
        "custom_fields": {
          "foo": "string"
        },
        "event_type_filter": {
          "in_values": [
            "string"
          ],
          "not_in_values": [
            "string"
          ]
        },
        "filter": {
          "foo": "bar"
        },
        "group_by": [
          "string"
        ],
        "group_keys": [
          [
            "string"
          ]
        ],
        "property_filters": [
          {
            "name": "name",
            "exists": true,
            "in_values": [
              "string"
            ],
            "not_in_values": [
              "string"
            ]
          }
        ],
        "sql": "sql"
      }
    ],
    "matched_customer": {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "name": "name"
    },
    "processed_at": "2019-12-27T18:11:19.117Z",
    "properties": {
      "foo": "bar"
    }
  }
]