Search

Search events

client.V1.Usage.Search(ctx, body) (*[]V1UsageSearchResponse, error)

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.

Parameters

body

Hide ParametersShow Parameters

TransactionIDsfield

param.Field[[]string]

The transaction IDs of the events to retrieve

Returns

V1UsageSearchResponsetype

[]V1UsageSearchResponse

Hide ParametersShow Parameters

IDstring

CustomerIDstring

The ID of the customer in the ingest event body

EventTypestring

TimestampTime

formatdate-time

TransactionIDstring

IsDuplicatebool

optional

MatchedBillableMetricsarray

optional

[]V1UsageSearchResponseMatchedBillableMetric

Hide ParametersShow Parameters

IDstring

formatuuid

Namestring

Aggregatestring

optional

(DEPRECATED) use aggregation_type instead

AggregateKeysarray

optional

[]string

(DEPRECATED) use aggregation_key instead

AggregationKeystring

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'.

AggregationType

optional

Specifies the type of aggregation performed on matching events.

Hide ParametersShow Parameters

V1UsageSearchResponseMatchedBillableMetricsAggregationTypeCountconst

"COUNT"

V1UsageSearchResponseMatchedBillableMetricsAggregationTypeLatestconst

"LATEST"

V1UsageSearchResponseMatchedBillableMetricsAggregationTypeMaxconst

"MAX"

V1UsageSearchResponseMatchedBillableMetricsAggregationTypeSumconst

"SUM"

V1UsageSearchResponseMatchedBillableMetricsAggregationTypeUniqueconst

"UNIQUE"

ArchivedAtTime

optional

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

formatdate-time

CustomFieldsmap

optional

map[string, string]

EventTypeFilter

optional

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

Filtermap

optional

map[string, unknown]

(DEPRECATED) use property_filters & event_type_filter instead

GroupByarray

optional

[]string

(DEPRECATED) use group_keys instead

GroupKeysarray

optional

[][]string

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.

PropertyFiltersarray

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.

Hide ParametersShow Parameters

Namestring

The name of the event property.

Existsbool

optional

Determines whether the property must exist in the event. If true, only events with this property will pass the filter. If false, only events without this property will pass the filter. If null or omitted, the existence of the property is optional.

InValuesarray

optional

[]string

Specifies the allowed values for the property to match an event. An event will pass the filter only if its property value is included in this list. If undefined, all property values will pass the filter. Must be non-empty if present.

NotInValuesarray

optional

[]string

Specifies the values that prevent an event from matching the filter. An event will not pass the filter if its property value is included in this list. If null or empty, all property values will pass the filter. Must be non-empty if present.

Sqlstring

optional

The SQL query associated with the billable metric

MatchedCustomer

optional

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

Hide ParametersShow Parameters

IDstring

optional

formatuuid

Namestring

optional

ProcessedAtTime

optional

formatdate-time

Propertiesmap

optional

map[string, unknown]

package main

import (
  "context"
  "fmt"

  "github.com/Metronome-Industries/metronome-go"
  "github.com/Metronome-Industries/metronome-go/option"
)

func main() {
  client := metronome.NewClient(
    option.WithBearerToken("My Bearer Token"),
  )
  response, err := client.V1.Usage.Search(context.TODO(), metronome.V1UsageSearchParams{
    TransactionIDs: metronome.F([]string{"2021-01-01T00:00:00Z_cluster42"}),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response)
}

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"
    }
  }
]