HealthReportRequest interface

Health report that's submitted for a specific signal

Properties

additionalContext

Optional additional context or description for the health report

evaluationRules

Evaluation rules that were used to determine the reported health state

expiresInMinutes

Number of minutes until the health report expires. Defaults to 60 (1 hour) if not specified.

healthState

Health state to report for the signal

signalName

Name of the entity signal to report health for

value

Reported value of the signal

Property Details

additionalContext

Optional additional context or description for the health report

additionalContext?: string

Property Value

string

evaluationRules

Evaluation rules that were used to determine the reported health state

evaluationRules?: HealthReportEvaluationRule

Property Value

expiresInMinutes

Number of minutes until the health report expires. Defaults to 60 (1 hour) if not specified.

expiresInMinutes?: number

Property Value

number

healthState

Health state to report for the signal

healthState: string

Property Value

string

signalName

Name of the entity signal to report health for

signalName: string

Property Value

string

value

Reported value of the signal

value?: number

Property Value

number