Skip to content
Sesharo Docs

Create Definition

POST
/users/{user_id}/metric-definitions
curl --request POST \
  --url https://example.com/users/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/metric-definitions \
  --header 'Content-Type: application/json' \
  --data '{ "display_name": "example", "manual_fallback": true, "metric_type_slug": "example", "resolution_operator": "priority", "sources": [] }'

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
user_id
required
User Id
string format: uuid

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
DefinitionCreate
object
display_name
Any of:
string
manual_fallback
Manual Fallback
boolean
default: true
metric_type_slug
required
Metric Type Slug
string
resolution_operator
Resolution Operator
string
default: priority
Allowed values: priority average median lowest highest sum latest
sources
Sources
Array<object>
default:
SourceSpec

A source feeding a metric, in rank order. condition is an optional queue-jump, e.g. {"type": "prefer_if_present"} = prefer this source whenever it reports.

object
condition
Any of:
object
key
additional properties
any
source
required
Source
string

Responses

Section titled “Responses”

201

Section titled “201”

Successful Response

Media typeapplication/json
DefinitionRead
object
automations
required
Automations
Array<object>
AutomationRead
object
action_config
required
Action Config
object
key
additional properties
any
action_type
required
Action Type
string
enabled
required
Enabled
boolean
id
required
Id
string format: uuid
trigger_config
required
Trigger Config
object
key
additional properties
any
trigger_type
required
Trigger Type
string
display_name
required
Any of:
string
enabled
required
Enabled
boolean
id
required
Id
string format: uuid
manual_fallback
required
Manual Fallback
boolean
metric_type_slug
required
Metric Type Slug
string
resolution_operator
required
Resolution Operator
string
sources
required
Sources
Array<object>
SourceRead
object
condition
Any of:
object
key
additional properties
any
rank
required
Rank
integer
source
required
Source
string
Examplegenerated
{
  "automations": [
    {
      "action_config": {},
      "action_type": "example",
      "enabled": true,
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "trigger_config": {},
      "trigger_type": "example"
    }
  ],
  "display_name": "example",
  "enabled": true,
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "manual_fallback": true,
  "metric_type_slug": "example",
  "resolution_operator": "example",
  "sources": [
    {
      "condition": {},
      "rank": 1,
      "source": "example"
    }
  ]
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}