Skip to navigation
BotBye APIProtectionMetric Definitions

create

View as Markdown

Create a new metric definition.

Accepted permissions Project → Risk metric definitions → Create

Token scope Metric Definitions Action

Authentication

X-Api-Keystring

Personal access token. Create it in your BotBye account under Profile → Personal Access Tokens, tick the scopes the endpoints you call require (see each endpoint’s Token scope), and send the token in the X-Api-Key request header. A token works only for the account it was created in.

Path parameters

account_idstringRequired
project_idstringRequired

Request

This endpoint expects an object.
namestringRequired
aggregationenumRequired
Allowed values:
timeWindowintegerRequired
Time window in seconds.
keyByenumRequired
Allowed values:
fieldstring or nullOptional
filterobject or nullOptional
enabledbooleanOptional