Skip to content
Sesharo Docs

List Definitions

GET
/users/{user_id}/metric-definitions
curl --request GET \
  --url 'https://example.com/users/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/metric-definitions?offset=0'

Parameters

Section titled “Parameters”

Path Parameters

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

Query Parameters

Section titled “Query Parameters”
limit
Any of:
integer
>= 1 <= 500

Max rows to return (≤500). Omit for a sane default.

offset
Offset

Rows to skip (pagination).

integer
0

Rows to skip (pagination).

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
Response List Definitions Users User Id Metric Definitions Get
Array<object>
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"
    }
  ]
}