Key Results

get_key_results

Get list of key results for the authenticated user's organization

get_key_results

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_key_results",
    "arguments": {
        "page": 1,
        "limit": 10,
        "search": "string",
        "relations": [
          "string"
        ],
        "goalId": "550e8400-e29b-41d4-a716-446655440000",
        "ownerId": "550e8400-e29b-41d4-a716-446655440000",
        "status": "string"
      }
  }
}

const result = await client.callTool({
  "name": "get_key_results",
  "arguments": {
    "page": 1,
    "limit": 10,
    "search": "string",
    "relations": [
      "string"
    ],
    "goalId": "550e8400-e29b-41d4-a716-446655440000",
    "ownerId": "550e8400-e29b-41d4-a716-446655440000",
    "status": "string"
  }
});

result = await session.call_tool("get_key_results", arguments={
  "page": 1,
  "limit": 10,
  "search": "string",
  "relations": [
    "string"
  ],
  "goalId": "550e8400-e29b-41d4-a716-446655440000",
  "ownerId": "550e8400-e29b-41d4-a716-446655440000",
  "status": "string"
})

Parameters

pagenumber1

Page number for pagination

limitnumber10

Number of items per page

searchstring

Search term for key result name or description

relationsArray<string>

Relations to include (e.g., ["goal", "owner", "lead"])

goalIdstring<uuid>

Filter by goal ID

ownerIdstring<uuid>

Filter by owner ID

statusstring

Filter by key result status

get_key_result_count

Get key result count in the authenticated user's organization

get_key_result_count

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_key_result_count",
    "arguments": {
        "goalId": "550e8400-e29b-41d4-a716-446655440000",
        "ownerId": "550e8400-e29b-41d4-a716-446655440000",
        "status": "string"
      }
  }
}

const result = await client.callTool({
  "name": "get_key_result_count",
  "arguments": {
    "goalId": "550e8400-e29b-41d4-a716-446655440000",
    "ownerId": "550e8400-e29b-41d4-a716-446655440000",
    "status": "string"
  }
});

result = await session.call_tool("get_key_result_count", arguments={
  "goalId": "550e8400-e29b-41d4-a716-446655440000",
  "ownerId": "550e8400-e29b-41d4-a716-446655440000",
  "status": "string"
})

Parameters

goalIdstring<uuid>

Filter by goal ID

ownerIdstring<uuid>

Filter by owner ID

statusstring

Filter by key result status

get_key_result

Get a specific key result by ID

get_key_result

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_key_result",
    "arguments": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "relations": [
          "string"
        ]
      }
  }
}

const result = await client.callTool({
  "name": "get_key_result",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "relations": [
      "string"
    ]
  }
});

result = await session.call_tool("get_key_result", arguments={
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "relations": [
    "string"
  ]
})

Parameters

idstring<uuid>required

The key result ID

relationsArray<string>

Relations to include (e.g., ["goal", "owner", "lead"])

create_key_result

Create a new key result in the authenticated user's organization

create_key_result

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "create_key_result",
    "arguments": {
        "key_result_data": {
          "name": "string",
          "goalId": "string",
          "deadline": "string"
        }
      }
  }
}

const result = await client.callTool({
  "name": "create_key_result",
  "arguments": {
    "key_result_data": {
      "name": "string",
      "goalId": "string",
      "deadline": "string"
    }
  }
});

result = await session.call_tool("create_key_result", arguments={
  "key_result_data": {
    "name": "string",
    "goalId": "string",
    "deadline": "string"
  }
})

Request Body

{
  "key_result_data": {
    "name": "string",
    "goalId": "string",
    "deadline": "string"
  }
}

Body

application/json

key_result_dataobjectrequired

The data for creating the key result

Show child attributes

namestringrequired

The key result name (required)

goalIdstringrequired

The goal ID (required)

deadlinestringrequired

The deadline (required)

[key: string]any

update_key_result

Update an existing key result

update_key_result

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "update_key_result",
    "arguments": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "key_result_data": {}
      }
  }
}

const result = await client.callTool({
  "name": "update_key_result",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "key_result_data": {}
  }
});

result = await session.call_tool("update_key_result", arguments={
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "key_result_data": {}
})

Parameters

idstring<uuid>required

The key result ID

key_result_dataobjectrequired

The data for updating the key result

update_key_result_progress

Update the progress of a key result

update_key_result_progress

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "update_key_result_progress",
    "arguments": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "progress": 0,
        "update": 0
      }
  }
}

const result = await client.callTool({
  "name": "update_key_result_progress",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "progress": 0,
    "update": 0
  }
});

result = await session.call_tool("update_key_result_progress", arguments={
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "progress": 0,
  "update": 0
})

Parameters

idstring<uuid>required

The key result ID

progressnumber[0, 100]required

The progress percentage (0-100)

updatenumber

The current update value

delete_key_result

Delete a key result

delete_key_result

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "delete_key_result",
    "arguments": {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
  }
}

const result = await client.callTool({
  "name": "delete_key_result",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440000"
  }
});

result = await session.call_tool("delete_key_result", arguments={
  "id": "550e8400-e29b-41d4-a716-446655440000"
})

Parameters

idstring<uuid>required

The key result ID

get_key_results_by_goal

Get all key results for a specific goal

get_key_results_by_goal

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_key_results_by_goal",
    "arguments": {
        "goalId": "550e8400-e29b-41d4-a716-446655440000",
        "page": 1,
        "limit": 10,
        "status": "string",
        "relations": [
          "string"
        ]
      }
  }
}

const result = await client.callTool({
  "name": "get_key_results_by_goal",
  "arguments": {
    "goalId": "550e8400-e29b-41d4-a716-446655440000",
    "page": 1,
    "limit": 10,
    "status": "string",
    "relations": [
      "string"
    ]
  }
});

result = await session.call_tool("get_key_results_by_goal", arguments={
  "goalId": "550e8400-e29b-41d4-a716-446655440000",
  "page": 1,
  "limit": 10,
  "status": "string",
  "relations": [
    "string"
  ]
})

Parameters

goalIdstring<uuid>required

The goal ID

pagenumber1

Page number for pagination

limitnumber10

Number of items per page

statusstring

Filter by key result status

relationsArray<string>

Relations to include

get_my_key_results

Get key results assigned to the current authenticated user

get_my_key_results

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_my_key_results",
    "arguments": {
        "page": 1,
        "limit": 10,
        "status": "string",
        "goalId": "550e8400-e29b-41d4-a716-446655440000"
      }
  }
}

const result = await client.callTool({
  "name": "get_my_key_results",
  "arguments": {
    "page": 1,
    "limit": 10,
    "status": "string",
    "goalId": "550e8400-e29b-41d4-a716-446655440000"
  }
});

result = await session.call_tool("get_my_key_results", arguments={
  "page": 1,
  "limit": 10,
  "status": "string",
  "goalId": "550e8400-e29b-41d4-a716-446655440000"
})

Parameters

pagenumber1

Page number for pagination

limitnumber10

Number of items per page

statusstring

Filter by key result status

goalIdstring<uuid>

Filter by specific goal ID

create_key_result_update

Create an update for a key result

create_key_result_update

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "create_key_result_update",
    "arguments": {
        "keyResultId": "550e8400-e29b-41d4-a716-446655440000",
        "update_data": {
          "update": 0,
          "progress": 0,
          "description": "string",
          "status": "string"
        }
      }
  }
}

const result = await client.callTool({
  "name": "create_key_result_update",
  "arguments": {
    "keyResultId": "550e8400-e29b-41d4-a716-446655440000",
    "update_data": {
      "update": 0,
      "progress": 0,
      "description": "string",
      "status": "string"
    }
  }
});

result = await session.call_tool("create_key_result_update", arguments={
  "keyResultId": "550e8400-e29b-41d4-a716-446655440000",
  "update_data": {
    "update": 0,
    "progress": 0,
    "description": "string",
    "status": "string"
  }
})

Request Body

{
  "keyResultId": "550e8400-e29b-41d4-a716-446655440000",
  "update_data": {
    "update": 0,
    "progress": 0,
    "description": "string",
    "status": "string"
  }
}

Body

application/json

keyResultIdstring<uuid>required

The key result ID

update_dataobjectrequired

The update data

Show child attributes

updatenumberrequired

The current value/update

progressnumber[0, 100]required

The progress percentage (0-100)

descriptionstring

Description of the update

statusstring

Status of the key result

get_key_result_updates

Get updates for a specific key result

get_key_result_updates

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_key_result_updates",
    "arguments": {
        "keyResultId": "550e8400-e29b-41d4-a716-446655440000",
        "page": 1,
        "limit": 10
      }
  }
}

const result = await client.callTool({
  "name": "get_key_result_updates",
  "arguments": {
    "keyResultId": "550e8400-e29b-41d4-a716-446655440000",
    "page": 1,
    "limit": 10
  }
});

result = await session.call_tool("get_key_result_updates", arguments={
  "keyResultId": "550e8400-e29b-41d4-a716-446655440000",
  "page": 1,
  "limit": 10
})

Parameters

keyResultIdstring<uuid>required

The key result ID

pagenumber1

Page number for pagination

limitnumber10

Number of items per page

get_key_result_statistics

Get key result statistics for the authenticated user's organization

get_key_result_statistics

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_key_result_statistics",
    "arguments": {
        "goalId": "550e8400-e29b-41d4-a716-446655440000",
        "ownerId": "550e8400-e29b-41d4-a716-446655440000",
        "startDate": "string",
        "endDate": "string"
      }
  }
}

const result = await client.callTool({
  "name": "get_key_result_statistics",
  "arguments": {
    "goalId": "550e8400-e29b-41d4-a716-446655440000",
    "ownerId": "550e8400-e29b-41d4-a716-446655440000",
    "startDate": "string",
    "endDate": "string"
  }
});

result = await session.call_tool("get_key_result_statistics", arguments={
  "goalId": "550e8400-e29b-41d4-a716-446655440000",
  "ownerId": "550e8400-e29b-41d4-a716-446655440000",
  "startDate": "string",
  "endDate": "string"
})

Parameters

goalIdstring<uuid>

Filter by specific goal ID

ownerIdstring<uuid>

Filter by owner ID

startDatestring

Start date for statistics (ISO format)

endDatestring

End date for statistics (ISO format)

Stack Overflow Website Demo