Get Scorecard

GET

/scorecard

GET

/api/v1/scorecard

curl https://api.taktoria.com/api/v1/scorecard \
     -H "Authorization: Bearer <token>"

{
  "year": 1,
  "columns": [
    {
      "key": "key",
      "timeframe": "ANNUAL",
      "checkpoint": "MID",
      "at": "2024-01-15T09:30:00Z",
      "reached": true
    },
    {
      "key": "key",
      "timeframe": "ANNUAL",
      "checkpoint": "MID",
      "at": "2024-01-15T09:30:00Z",
      "reached": true
    }
  ],
  "rows": [
    {
      "objectiveId": "objectiveId",
      "title": "title",
      "weight": 1.1,
      "timeframe": "ANNUAL",
      "cells": {
        "cells": {
          "score": 1.1,
          "source": "grade",
          "noScore": true,
          "inProgress": true
        }
      },
      "keyResults": [
        {
          "keyResultId": "keyResultId",
          "title": "title",
          "weight": 1.1,
          "cells": {
            "cells": {
              "score": 1.1,
              "source": "grade",
              "noScore": true,
              "inProgress": true
            }
          },
          "priority": "P0"
        },
        {
          "keyResultId": "keyResultId",
          "title": "title",
          "weight": 1.1,
          "cells": {
            "cells": {
              "score": 1.1,
              "source": "grade",
              "noScore": true,
              "inProgress": true
            }
          },
          "priority": "P0"
        }
      ]
    },
    {
      "objectiveId": "objectiveId",
      "title": "title",
      "weight": 1.1,
      "timeframe": "ANNUAL",
      "cells": {
        "cells": {
          "score": 1.1,
          "source": "grade",
          "noScore": true,
          "inProgress": true
        }
      },
      "keyResults": [
        {
          "keyResultId": "keyResultId",
          "title": "title",
          "weight": 1.1,
          "cells": {
            "cells": {
              "score": 1.1,
              "source": "grade",
              "noScore": true,
              "inProgress": true
            }
          },
          "priority": "P0"
        },
        {
          "keyResultId": "keyResultId",
          "title": "title",
          "weight": 1.1,
          "cells": {
            "cells": {
              "score": 1.1,
              "source": "grade",
              "noScore": true,
              "inProgress": true
            }
          },
          "priority": "P0"
        }
      ]
    }
  ],
  "average": {
    "average": 1.1
  },
  "byPriority": {
    "byPriority": {
      "byPriority": 1.1
    }
  },
  "averageInProgress": [
    "averageInProgress",
    "averageInProgress"
  ],
  "byPriorityInProgress": {
    "byPriorityInProgress": [
      "byPriorityInProgress",
      "byPriorityInProgress"
    ]
  }
}

A fiscal year’s scorecard, as the dashboard grid shows it, private objectives included: a key belongs to the workspace, not a person. A signed-in session gets what its person may see.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

yearintegerOptional

The fiscal year, 2000 to 2100; the current one when left out.

teamIdstringOptional

Objectives a team owns, or holds one of the key results of; of those it does not own, only its own key results, with the objective’s cells rolled up from them.

priorityenumOptional

Only that priority's key results, and the objectives holding one, their cells rolled up from those key results alone.

Allowed values:

framestringOptional

annual, or a quarter 1 to 4. Every period when left out.

midbooleanOptional

false leaves out the mid-quarter columns.

Response

This endpoint returns an object.

yearinteger

columnslist of objects

rowslist of objects

averagemap from strings to optional doubles

Per column, the weighted average of every objective in its time frame.

byPrioritymap from strings to maps from strings to optional doubles

The same averages for P0, P1, P2 and P3 on their own: each objective on its key results of that priority, with its own weight.

averageInProgresslist of strings

The columns whose average counts an in-progress score (a Final not come, read from the latest check-in): not final yet either.

byPriorityInProgressmap from strings to lists of strings

The same, for each priority's averages.

Errors

402

Subscription Required Error

422

Validation Error

429

Too Many Requests Error