Outcomes
GET all outcomes for a plan
GET all outcomes for a planGet all outcomes for a specific plan
GET https://api.tability.app/v2/workspaces/:workspaceID/plans/:planID/outcomes
Path Parameters
| Name | Type | Description |
|---|---|---|
:workspaceID* | String | Unique ID of the workspace |
:planID* | String | Unique ID of the plan (UUID or Nano ID) |
[
{
"id": "03b42e14-e081-4546-92d4-6d8bb3de1a50",
"workspace_id": "f709df85-fa72-43d4-b398-db159ec6f8da",
"nano_slug": "j4Jlkboa7H3g",
"objective_id": "9baab5b7-5ebb-4261-81e1-5ec0a9d2d860",
"rank": "~nb",
"title": "Increase Quarterly Sales Revenue from $1 million to $1.3 million",
"description": "",
"from": 1000000.0,
"to": 1300000.0,
"score_format": "$_number_w",
"created_at": "2023-11-23T11:27:37.206Z",
"updated_at": "2023-12-07T01:15:34.078Z",
"is_pending_checkin": false,
"archived": false,
"completed": false,
"open_initiatives_count": 4,
"closed_initiatives_count": 1,
"total_initiatives_count": 5,
"is_dummy": true,
"outcome_progress_prct": 0.0,
"initiative_progress_prct": 0.2,
"cached_tag_list": "",
"outcome_type": "improve_metric",
"weight": 1,
"membership": {
"id": "784506bf-d098-42e9-b3c9-64b45bcf8683",
"workspace_id": "f709df85-fa72-43d4-b398-db159ec6f8da",
"user_id": "3661d1d7-5343-4932-9e98-dd167b4594bd",
"role": "user",
"created_at": "2023-11-23T11:27:34.984Z",
"updated_at": "2023-11-23T11:27:37.797Z",
"cached_email": "seiji_v4-onboarding-test@example.com",
"cached_firstname": "Seiji",
"cached_lastname": "Ono (sample)",
"cached_avatar_url": "https://res.cloudinary.com/tability/image/upload/v1625719561/dummy_data/persona_seiji_ono_sxzlrn.png"
},
"current_checkin": {
"id": "e996987d-d52a-4948-a2c9-1b04e6095911",
"workspace_id": "f709df85-fa72-43d4-b398-db159ec6f8da",
"nano_slug": "uTWISiqtTVtE",
"outcome_id": "03b42e14-e081-4546-92d4-6d8bb3de1a50",
"checkin_date": "2023-12-07T01:15:33.592Z",
"score": 120000.0,
"confidence": "red",
"body": "",
"created_at": "2023-12-07T01:15:33.605Z",
"updated_at": "2023-12-07T01:15:33.605Z",
"is_remote": false,
"cached_reactions": "{}",
"cached_views_count": 0,
"membership": {
"id": "fb201467-1da7-4964-9824-cbca10fefe04",
"workspace_id": "f709df85-fa72-43d4-b398-db159ec6f8da",
"user_id": "59f5655c-25b3-4e1a-bf97-2e99be39b870",
"role": "owner",
"created_at": "2023-06-28T23:23:45.276Z",
"updated_at": "2023-12-07T01:59:26.301Z",
"cached_email": "sten@tability.io",
"cached_firstname": "Sten",
"cached_lastname": "Pittet",
"cached_avatar_url": "https://res.cloudinary.com/tability-dev/image/upload/c_thumb,g_face,w_250,z_0.75/v1657093202/2.0-dev/59f5655c-25b3-4e1a-bf97-2e99be39b870/303e9965-bde1-40eb-bd42-cbb048ca8c79.png"
}
},
"previous_checkin": {
"id": "ed503037-deab-4be6-890b-c852fc9eeffb",
"workspace_id": "f709df85-fa72-43d4-b398-db159ec6f8da",
"nano_slug": "Fmd2wpBLhXNo",
"outcome_id": "03b42e14-e081-4546-92d4-6d8bb3de1a50",
"checkin_date": "2023-12-07T01:15:07.992Z",
"score": 1200000.0,
"confidence": "green",
"body": "",
"created_at": "2023-12-07T01:15:08.041Z",
"updated_at": "2023-12-07T01:15:08.041Z",
"is_remote": false,
"cached_reactions": "{}",
"cached_views_count": 0,
"membership": {
"id": "fb201467-1da7-4964-9824-cbca10fefe04",
"workspace_id": "f709df85-fa72-43d4-b398-db159ec6f8da",
"user_id": "59f5655c-25b3-4e1a-bf97-2e99be39b870",
"role": "owner",
"created_at": "2023-06-28T23:23:45.276Z",
"updated_at": "2023-12-07T01:59:26.301Z",
"cached_email": "sten@tability.io",
"cached_firstname": "Sten",
"cached_lastname": "Pittet",
"cached_avatar_url": "https://res.cloudinary.com/tability-dev/image/upload/c_thumb,g_face,w_250,z_0.75/v1657093202/2.0-dev/59f5655c-25b3-4e1a-bf97-2e99be39b870/303e9965-bde1-40eb-bd42-cbb048ca8c79.png"
}
}
}
]GET all outcomes for an objective
GET all outcomes for an objectiveGet all outcomes for a specific objective
GET https://api.tability.dev:3001/v2/workspaces/:workspaceID/objectives/:objectiveId/outcomes
Path Parameters
| Name | Type | Description |
|---|---|---|
:workspaceID* | String | Unique ID of the workspace |
:objectiveID* | String | Unique ID of the objective (UUID or Nano ID) |
[
{
"id": "03b42e14-e081-4546-92d4-6d8bb3de1a50",
"workspace_id": "f709df85-fa72-43d4-b398-db159ec6f8da",
"nano_slug": "j4Jlkboa7H3g",
"objective_id": "9baab5b7-5ebb-4261-81e1-5ec0a9d2d860",
"rank": "~nb",
"title": "Increase Quarterly Sales Revenue from $1 million to $1.3 million",
"description": "",
"from": 1000000.0,
"to": 1300000.0,
"score_format": "$_number_w",
"created_at": "2023-11-23T11:27:37.206Z",
"updated_at": "2023-12-07T01:15:34.078Z",
"is_pending_checkin": false,
"archived": false,
"completed": false,
"open_initiatives_count": 4,
"closed_initiatives_count": 1,
"total_initiatives_count": 5,
"is_dummy": true,
"outcome_progress_prct": 0.0,
"initiative_progress_prct": 0.2,
"cached_tag_list": "",
"outcome_type": "improve_metric",
"weight": 1,
"membership": {
"id": "784506bf-d098-42e9-b3c9-64b45bcf8683",
"workspace_id": "f709df85-fa72-43d4-b398-db159ec6f8da",
"user_id": "3661d1d7-5343-4932-9e98-dd167b4594bd",
"role": "user",
"created_at": "2023-11-23T11:27:34.984Z",
"updated_at": "2023-11-23T11:27:37.797Z",
"cached_email": "seiji_v4-onboarding-test@example.com",
"cached_firstname": "Seiji",
"cached_lastname": "Ono (sample)",
"cached_avatar_url": "https://res.cloudinary.com/tability/image/upload/v1625719561/dummy_data/persona_seiji_ono_sxzlrn.png"
},
"current_checkin": {
"id": "e996987d-d52a-4948-a2c9-1b04e6095911",
"workspace_id": "f709df85-fa72-43d4-b398-db159ec6f8da",
"nano_slug": "uTWISiqtTVtE",
"outcome_id": "03b42e14-e081-4546-92d4-6d8bb3de1a50",
"checkin_date": "2023-12-07T01:15:33.592Z",
"score": 120000.0,
"confidence": "red",
"body": "",
"created_at": "2023-12-07T01:15:33.605Z",
"updated_at": "2023-12-07T01:15:33.605Z",
"is_remote": false,
"cached_reactions": "{}",
"cached_views_count": 0,
"membership": {
"id": "fb201467-1da7-4964-9824-cbca10fefe04",
"workspace_id": "f709df85-fa72-43d4-b398-db159ec6f8da",
"user_id": "59f5655c-25b3-4e1a-bf97-2e99be39b870",
"role": "owner",
"created_at": "2023-06-28T23:23:45.276Z",
"updated_at": "2023-12-07T01:59:26.301Z",
"cached_email": "sten@tability.io",
"cached_firstname": "Sten",
"cached_lastname": "Pittet",
"cached_avatar_url": "https://res.cloudinary.com/tability-dev/image/upload/c_thumb,g_face,w_250,z_0.75/v1657093202/2.0-dev/59f5655c-25b3-4e1a-bf97-2e99be39b870/303e9965-bde1-40eb-bd42-cbb048ca8c79.png"
}
},
"previous_checkin": {
"id": "ed503037-deab-4be6-890b-c852fc9eeffb",
"workspace_id": "f709df85-fa72-43d4-b398-db159ec6f8da",
"nano_slug": "Fmd2wpBLhXNo",
"outcome_id": "03b42e14-e081-4546-92d4-6d8bb3de1a50",
"checkin_date": "2023-12-07T01:15:07.992Z",
"score": 1200000.0,
"confidence": "green",
"body": "",
"created_at": "2023-12-07T01:15:08.041Z",
"updated_at": "2023-12-07T01:15:08.041Z",
"is_remote": false,
"cached_reactions": "{}",
"cached_views_count": 0,
"membership": {
"id": "fb201467-1da7-4964-9824-cbca10fefe04",
"workspace_id": "f709df85-fa72-43d4-b398-db159ec6f8da",
"user_id": "59f5655c-25b3-4e1a-bf97-2e99be39b870",
"role": "owner",
"created_at": "2023-06-28T23:23:45.276Z",
"updated_at": "2023-12-07T01:59:26.301Z",
"cached_email": "sten@tability.io",
"cached_firstname": "Sten",
"cached_lastname": "Pittet",
"cached_avatar_url": "https://res.cloudinary.com/tability-dev/image/upload/c_thumb,g_face,w_250,z_0.75/v1657093202/2.0-dev/59f5655c-25b3-4e1a-bf97-2e99be39b870/303e9965-bde1-40eb-bd42-cbb048ca8c79.png"
}
}
}
]GET a specific outcome
GET a specific outcomeGet the details of a specific outcome
GET https://api.tability.app/v2/workspaces/:workspaceID/outcomes/:outcomeID
Path Parameters
| Name | Type | Description |
|---|---|---|
:workspaceID* | String | Unique ID of the workspace |
:outcomeID* | String | Unique ID of the outcome (UUID or Nano ID) |
{
"id": "561a1404-ae77-40a3-86be-a255ed0b77f4",
"workspace_id": "f709df85-fa72-43d4-b398-db159ec6f8da",
"nano_slug": "4j0H6rkKf97w",
"objective_id": "9baab5b7-5ebb-4261-81e1-5ec0a9d2d860",
"rank": "~nb",
"title": "Maintain a customer retention rate of at least 85%",
"description": "",
"from": 0.0,
"to": 100.0,
"score_format": "_number_%",
"created_at": "2023-11-23T11:27:37.925Z",
"updated_at": "2023-11-23T11:27:46.790Z",
"is_pending_checkin": false,
"archived": false,
"completed": false,
"open_initiatives_count": 4,
"closed_initiatives_count": 0,
"total_initiatives_count": 4,
"is_dummy": true,
"outcome_progress_prct": 0.84,
"initiative_progress_prct": 0.0,
"outcome_contributors_count": 0,
"cached_tag_list": null,
"outcome_type": "improve_metric",
"weight": 1,
"membership": null,
"plan": {
"id": "0044993f-069a-4718-8139-306c01972b44",
"parent_id": null,
"workspace_id": "f709df85-fa72-43d4-b398-db159ec6f8da",
"nano_slug": "O-7xOV5nKdRy",
"title": "Company Quarterly Goals 2023",
"plan_icon": ":cityscape:",
"start_at": "2023-10-12T00:00:00.000Z",
"finish_at": "2024-01-04T00:00:00.000Z",
"state": "published",
"created_at": "2023-11-23T11:27:37.155Z",
"updated_at": "2023-12-07T01:15:34.149Z",
"archived": false,
"cached_tag_list": null,
"active": true,
"expired": false
},
"objective": {
"id": "9baab5b7-5ebb-4261-81e1-5ec0a9d2d860",
"workspace_id": "f709df85-fa72-43d4-b398-db159ec6f8da",
"nano_slug": "OzshSldtC-Ll",
"plan_id": "0044993f-069a-4718-8139-306c01972b44",
"rank": "~na",
"title": "Increase Sales Growth",
"created_at": "2023-11-23T11:27:37.184Z",
"updated_at": "2023-12-07T01:15:34.117Z",
"archived": false,
"outcome_progress_prct": 0.42,
"initiative_progress_prct": 0.111111111111111,
"total_initiatives_count": 9,
"closed_initiatives_count": 1,
"grey_outcomes_count": 0,
"red_outcomes_count": 2,
"yellow_outcomes_count": 0,
"green_outcomes_count": 0,
"total_outcomes_count": 2,
"ncs": -100.0,
"description": "",
"cached_tag_list": "Raise Visibility"
},
"current_checkin": {
"id": "dbdebd0f-9f97-4c3c-b3af-95a2c2885d8f",
"workspace_id": "f709df85-fa72-43d4-b398-db159ec6f8da",
"nano_slug": "YMVQNUc6SnKY",
"outcome_id": "561a1404-ae77-40a3-86be-a255ed0b77f4",
"checkin_date": "2023-11-16T00:00:00.000Z",
"score": 84.0,
"confidence": "red",
"body": "We stopped the bleeding, but still haven't managed to find expansion opportunities. A lot of the accounts have said they might come back and buy higher subscriptions in Q1 and we're still missing a talk track on why they should pull the trigger now.",
"created_at": "2023-11-23T11:27:38.219Z",
"updated_at": "2023-11-23T11:27:38.219Z",
"is_remote": false,
"cached_reactions": "{}",
"cached_views_count": 1,
"membership": {
"id": "b3748039-c7f1-4c20-8420-c370cd738750",
"workspace_id": "f709df85-fa72-43d4-b398-db159ec6f8da",
"user_id": "2cda3686-42a4-4f46-841f-9145e8ce3c14",
"role": "user",
"created_at": "2023-11-23T11:27:36.791Z",
"updated_at": "2023-11-23T11:27:41.389Z",
"cached_email": "julia_v4-onboarding-test@example.com",
"cached_firstname": "Julia",
"cached_lastname": "Bennett (sample)",
"cached_avatar_url": "https://res.cloudinary.com/tability/image/upload/v1625719560/dummy_data/persona_julia_bennett_ua2hcs.png"
}
},
"previous_checkin": {
"id": "1625d733-4741-4082-a195-c630177de36e",
"workspace_id": "f709df85-fa72-43d4-b398-db159ec6f8da",
"nano_slug": "GbEj1vvJAo5f",
"outcome_id": "561a1404-ae77-40a3-86be-a255ed0b77f4",
"checkin_date": "2023-11-09T00:00:00.000Z",
"score": 84.0,
"confidence": "yellow",
"body": "Things seem to have stabilized for the mid-sized accounts since we started doing more reach outs. The large accounts haven't had any change in sentiment or top-level metrics, either. So it looks like we've picked the right strategy. Now to just maintain and try to grow some MRR.",
"created_at": "2023-11-23T11:27:38.174Z",
"updated_at": "2023-11-23T11:27:38.174Z",
"is_remote": false,
"cached_reactions": "{}",
"cached_views_count": 0,
"membership": {
"id": "b3748039-c7f1-4c20-8420-c370cd738750",
"workspace_id": "f709df85-fa72-43d4-b398-db159ec6f8da",
"user_id": "2cda3686-42a4-4f46-841f-9145e8ce3c14",
"role": "user",
"created_at": "2023-11-23T11:27:36.791Z",
"updated_at": "2023-11-23T11:27:41.389Z",
"cached_email": "julia_v4-onboarding-test@example.com",
"cached_firstname": "Julia",
"cached_lastname": "Bennett (sample)",
"cached_avatar_url": "https://res.cloudinary.com/tability/image/upload/v1625719560/dummy_data/persona_julia_bennett_ua2hcs.png"
}
}
}Last updated