Send custom metrics

post https://app.okayhq.com/api/v1/metrics

For backward compatibility, this endpoint is also aliased at https://app.okayhq.com/api/webhooks/events/v1

Use this endpoint to send one or more custom metrics to Okay.
Every metric can have labels and properties, which will show up in the query builder.
You can optionally associate a metric to a person, which will cause it to be linked to this person's team(s) when filtering and grouping.

Body Params

event

string

required

Defaults to custom

A fixed value, for backward compatibility

metrics

object

required

One or more metric(s) you want to send

timestamp

date-time

required

The time at which the event took place

customEventName

string

required

A way to namespace metrics under a common category. Metrics will show up as customEventName/<metric name> in the UI.

uniqueKey

array of strings

The name of the properties that are a natural key for this event. This will allow versioning and replaying events to correct errors or add new metadata. If uniqueKey is omitted, a UUID will be automatically created for this event.

uniqueKey

identity

object

The Github/Gitlab login or email address of the user so you can automatically link metrics to teams

properties

object

Key/value pairs to enable filtering and grouping metrics

Response

200

Successful response