Stats

OPTIONS /dashboard/metric-thresholds

OPTIONS operation for /dashboard/metric-thresholds

options/dashboard/metric-thresholds

Request

  • Base URL: https://dev-rest.onboard.io
  • URL: https://dev-rest.onboard.io/dashboard/metric-thresholds
  • Auth: API key in header Authorization

Response

Successful response

idinteger
onboarder_companystring required
metric_key'time_to_launch' | 'on_time_launch_rate' | 'customer_engagement' | 'internal_task_efficiency' | 'overdue_task_rate' required
metric_key_displaystring
target_valuenumber float required

Target threshold value

good_valuenumber float required

Good threshold value

risk_valuenumber float required

Risk threshold value

target_operator'lt' | 'gt' | 'lte' | 'gte'

Operator for target comparison

good_operator'lt' | 'gt' | 'lte' | 'gte'

Operator for good comparison

risk_operator'lt' | 'gt' | 'lte' | 'gte'

Operator for risk comparison

descriptionstring

Description of the metric

contextstring

Context about what the metric means

created_bystring
created_by_namestring
updated_bystring
updated_by_namestring
created_atstring date-time
updated_atstring date-time

Changes

No recorded changes to this operation across all 3 revisions of this API.