Skip to content

Signals

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

List the user’s existing Sesharo signals (health-metric types + event categories) with usage stats, so the HA panel’s picker can offer routing an entity into a signal they already track. Read-only.

user_id
required
User Id
string format: uuid

Successful Response

Media typeapplication/json
HASignalsResult
object
events
required
Events
Array<object>
HASignalEvent

One non-archived event category for the user, with usage stats.

object
display_name
required
Display Name
string
entry_count
required
Entry Count
integer
first_at
required
Any of:
string format: date-time
kind
Kind
string
default: event
last_at
required
Any of:
string format: date-time
slug
required
Slug
string
metrics
required
Metrics
Array<object>
HASignalMetric

One health-metric type visible to the user (system catalog or their own custom type), with usage stats, for the HA panel’s “route this entity into a signal you track” picker.

object
display_name
required
Display Name
string
first_at
required
Any of:
string format: date-time
is_custom
required
Is Custom
boolean
kind
Kind
string
default: metric
last_at
required
Any of:
string format: date-time
reading_count
required
Reading Count
integer
slug
required
Slug
string
sources
required
Sources
Array<string>
unit
required
Unit
string
Example
{
"events": [
{
"kind": "event"
}
],
"metrics": [
{
"kind": "metric"
}
]
}

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"
}
]
}