Skip to content
Sesharo Docs

List Offered

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

Metric types the user has data for but hasn’t defined yet, with their virtual default.

Parameters

Section titled “Parameters”

Path Parameters

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

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
Response List Offered Users User Id Metric Definitions Offered Get
Array<object>
OfferedMetric

A metric Sesharo can offer from the user’s data but which has no definition yet — the “available to set up” list, carrying the virtual default so the editor can pre-fill it.

object
available_sources
required
Available Sources
Array<string>
category
required
Category
string
default_operator
required
Default Operator
string
default_sources
required
Default Sources
Array<string>
display_name
required
Display Name
string
metric_type_slug
required
Metric Type Slug
string
unit
required
Unit
string
Examplegenerated
[
  {
    "available_sources": [
      "example"
    ],
    "category": "example",
    "default_operator": "example",
    "default_sources": [
      "example"
    ],
    "display_name": "example",
    "metric_type_slug": "example",
    "unit": "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"
    }
  ]
}