Indicators
GET /indicators/:id
Get an indicator
Examples
curl "https://www.hoshinplan.com/indicators/45544?app_key=<APP_KEY>×tamp=<TIMESTAMP>&signature=<SIGNATURE>" \
-H "Accept: application/json"
Response:
{
"id": 45544,
"name": "My indicator",
"description": "This is my indicator created through the API",
"value": "33.74",
"frequency": "weekly",
"next_update": "2021-08-08",
"goal": "50.0",
"created_at": "2021-07-08T18:20:01.530Z",
"updated_at": "2021-07-30T11:19:33.893Z",
"objective_id": 8786,
"area_id": 4364,
"ind_pos": 1,
"last_update": "2021-08-01",
"last_value": "39.6",
"responsible_id": 252433,
"company_id": 123420,
"reminder": true,
"worst_value": "30.0",
"show_on_parent": false,
"creator_id": 223553,
"hoshin_id": 1235545,
"show_on_charts": true,
"parent_area_id": null,
"parent_objective_id": null,
"deleted_at": null
}
Respuesta
Code: 200
Description:
OK
| Param name | Description |
|---|---|
|
name optional |
Validations:
|
|
value optional |
The current value for this indicator Validations:
|
|
description optional |
Validations:
|
|
ind_pos optional |
Used to sort the indicators in the hoshin view Validations:
|
|
frequency optional |
The update frequency for this indicator Validations:
|
|
next_update optional |
The date of the next desired update Validations:
|
|
goal optional |
The value that would set this indicator to 100% Validations:
|
|
worst_value optional |
The value that would set this indicator to 0% Validations:
|
|
reminder optional |
Send email reminders to the owner when the next update date comes Validations:
|
|
show_on_parent optional |
Show this indicator in the parent Hoshin Validations:
|
|
show_on_charts optional |
Show this indicator in the Hoshin charts view Validations:
|
|
hoshin_id optional |
The id of the area this indicator belongs to Validations:
|
|
area_id optional |
The id of the area this indicator belongs to Validations:
|
|
company_id optional |
The id of the company this indicator belongs to Validations:
|
|
creator_id optional |
The id of the user that created this indicator Validations:
|
|
objective_id optional |
The id of the objective this indicator belongs to Validations:
|
|
responsible_id optional |
The id of the user that is responsible for this indicator Validations:
|
|
last_update optional |
The timestamp of the last time this indicator was updated Validations:
|
|
last_value optional |
The previous value for this indicator Validations:
|
|
created_at optional |
Validations:
|
|
updated_at optional |
Validations:
|
|
parent_objective_id optional |
The id of the parent objective of the objective this indicator belongs to Validations:
|
|
parent_area_id optional |
The id of the area of the parent objective of the objective this indicator belongs to Validations:
|
|
deleted_at optional |
The date when this indicator was deleted Validations:
|
POST /objectives/:objective_id/indicators
Create an indicator for the given objective
Supported Formats
json, xmlExamples
curl -X POST "https://www.hoshinplan.com/objectives/23423/indicators?app_key=<APP_KEY>×tamp=<TIMESTAMP>&signature=<SIGNATURE>" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"name": "My new indicator",
"description": "This is my indicator created through the API",
"responsible_id": 213312,
"goal": "100",
"worst_value": "0",
"frequency": "weekly",
"next_update": "2021-07-08T18:20:01.530Z"
}'
Params
| Param name | Description |
|---|---|
|
name optional |
Validations:
|
|
value optional |
The current value for this indicator Validations:
|
|
description optional |
Validations:
|
|
ind_pos optional |
Used to sort the indicators in the hoshin view Validations:
|
|
frequency optional |
The update frequency for this indicator Validations:
|
|
next_update optional |
The date of the next desired update Validations:
|
|
goal optional |
The value that would set this indicator to 100% Validations:
|
|
worst_value optional |
The value that would set this indicator to 0% Validations:
|
|
reminder optional |
Send email reminders to the owner when the next update date comes Validations:
|
|
show_on_parent optional |
Show this indicator in the parent Hoshin Validations:
|
|
show_on_charts optional |
Show this indicator in the Hoshin charts view Validations:
|
|
objective_id optional |
The id of the objective this indicator belongs to Validations:
|
|
responsible_id optional |
The id of the user that is responsible for this indicator Validations:
|
Respuesta
Code: 201
Description:
The newly created indicator
| Param name | Description |
|---|---|
|
name optional |
Validations:
|
|
value optional |
The current value for this indicator Validations:
|
|
description optional |
Validations:
|
|
ind_pos optional |
Used to sort the indicators in the hoshin view Validations:
|
|
frequency optional |
The update frequency for this indicator Validations:
|
|
next_update optional |
The date of the next desired update Validations:
|
|
goal optional |
The value that would set this indicator to 100% Validations:
|
|
worst_value optional |
The value that would set this indicator to 0% Validations:
|
|
reminder optional |
Send email reminders to the owner when the next update date comes Validations:
|
|
show_on_parent optional |
Show this indicator in the parent Hoshin Validations:
|
|
show_on_charts optional |
Show this indicator in the Hoshin charts view Validations:
|
|
hoshin_id optional |
The id of the area this indicator belongs to Validations:
|
|
area_id optional |
The id of the area this indicator belongs to Validations:
|
|
company_id optional |
The id of the company this indicator belongs to Validations:
|
|
creator_id optional |
The id of the user that created this indicator Validations:
|
|
objective_id optional |
The id of the objective this indicator belongs to Validations:
|
|
responsible_id optional |
The id of the user that is responsible for this indicator Validations:
|
|
last_update optional |
The timestamp of the last time this indicator was updated Validations:
|
|
last_value optional |
The previous value for this indicator Validations:
|
|
created_at optional |
Validations:
|
|
updated_at optional |
Validations:
|
|
parent_objective_id optional |
The id of the parent objective of the objective this indicator belongs to Validations:
|
|
parent_area_id optional |
The id of the area of the parent objective of the objective this indicator belongs to Validations:
|
|
deleted_at optional |
The date when this indicator was deleted Validations:
|
DELETE /indicators/:id
Delete an indicator
Examples
curl -X DELETE "https://www.hoshinplan.com/indicators/45544?app_key=<APP_KEY>×tamp=<TIMESTAMP>&signature=<SIGNATURE>" \ -H "Accept: application/json"
Respuesta
Code: 204
Description:
No Content
| Param name | Description |
|---|
PUT /indicators/:id
Update an indicator
Supported Formats
json, xmlExamples
curl -X PUT "https://www.hoshinplan.com/indicators/45544?app_key=<APP_KEY>×tamp=<TIMESTAMP>&signature=<SIGNATURE>" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"value": "50"
}'
Params
| Param name | Description |
|---|---|
|
name optional |
Validations:
|
|
value optional |
The current value for this indicator Validations:
|
|
description optional |
Validations:
|
|
ind_pos optional |
Used to sort the indicators in the hoshin view Validations:
|
|
frequency optional |
The update frequency for this indicator Validations:
|
|
next_update optional |
The date of the next desired update Validations:
|
|
goal optional |
The value that would set this indicator to 100% Validations:
|
|
worst_value optional |
The value that would set this indicator to 0% Validations:
|
|
reminder optional |
Send email reminders to the owner when the next update date comes Validations:
|
|
show_on_parent optional |
Show this indicator in the parent Hoshin Validations:
|
|
show_on_charts optional |
Show this indicator in the Hoshin charts view Validations:
|
|
objective_id optional |
The id of the objective this indicator belongs to Validations:
|
|
responsible_id optional |
The id of the user that is responsible for this indicator Validations:
|
Respuesta
Code: 200
Description:
The updated indicator
| Param name | Description |
|---|---|
|
name optional |
Validations:
|
|
value optional |
The current value for this indicator Validations:
|
|
description optional |
Validations:
|
|
ind_pos optional |
Used to sort the indicators in the hoshin view Validations:
|
|
frequency optional |
The update frequency for this indicator Validations:
|
|
next_update optional |
The date of the next desired update Validations:
|
|
goal optional |
The value that would set this indicator to 100% Validations:
|
|
worst_value optional |
The value that would set this indicator to 0% Validations:
|
|
reminder optional |
Send email reminders to the owner when the next update date comes Validations:
|
|
show_on_parent optional |
Show this indicator in the parent Hoshin Validations:
|
|
show_on_charts optional |
Show this indicator in the Hoshin charts view Validations:
|
|
hoshin_id optional |
The id of the area this indicator belongs to Validations:
|
|
area_id optional |
The id of the area this indicator belongs to Validations:
|
|
company_id optional |
The id of the company this indicator belongs to Validations:
|
|
creator_id optional |
The id of the user that created this indicator Validations:
|
|
objective_id optional |
The id of the objective this indicator belongs to Validations:
|
|
responsible_id optional |
The id of the user that is responsible for this indicator Validations:
|
|
last_update optional |
The timestamp of the last time this indicator was updated Validations:
|
|
last_value optional |
The previous value for this indicator Validations:
|
|
created_at optional |
Validations:
|
|
updated_at optional |
Validations:
|
|
parent_objective_id optional |
The id of the parent objective of the objective this indicator belongs to Validations:
|
|
parent_area_id optional |
The id of the area of the parent objective of the objective this indicator belongs to Validations:
|
|
deleted_at optional |
The date when this indicator was deleted Validations:
|