> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.taktoria.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.taktoria.com/_mcp/server.

# Get Scorecard

GET https://api.taktoria.com/api/v1/scorecard

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.

Reference: https://docs.taktoria.com/api-reference/okr/get-scorecard

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Servers

- `https://api.taktoria.com/api/v1` (Production, default)
- `http://localhost:3000/api/v1` (Local)

## Request

### Query parameters

- `year` (integer, optional) — The fiscal year, 2000 to 2100; the current one when left out.
- `teamId` (string, optional) — 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.
- `priority` (enum, optional) — Only that priority's key results, and the objectives holding one, their cells rolled up from those key results alone.
  - Allowed values: `P0`, `P1`, `P2`, `P3`
- `frame` (string, optional) — `annual`, or a quarter `1` to `4`. Every period when left out.
- `mid` (boolean, optional) — `false` leaves out the mid-quarter columns.

## Response

### 200

- `year` (integer, required)
- `columns` (list of ScorecardColumn, required)
- `rows` (list of ScorecardRow, required)
- `average` (map from string to double, required) — Per column, the weighted average of every objective in its time frame.
- `byPriority` (map from string to map from string to double, required) — 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.
- `averageInProgress` (list of string, required) — The columns whose `average` counts an in-progress score (a Final not come, read from the latest check-in): not final yet either.
- `byPriorityInProgress` (map from string to list of string, required) — The same, for each priority's averages.

## Errors

### 402 Subscription Required Error

The organization has no subscription for the app that lets it in: active, trialing or past due. One that is unpaid (Stripe stopped retrying a failed payment), paused, incomplete or cancelled answers this too, and the message says which: an unpaid app is locked until a workspace admin updates the payment details. `details.status` is the app's subscription status (null with none), and `details.paymentIssue` is `unpaid`, or `payment_failed` for an incomplete one whose first payment failed, as `paymentIssue` on `GET /subscription` reckons it; null when a payment is not why.

- `error` (ErrorDetail, required)

### 422 Validation Error

- `error` (ErrorDetail, required)

### 429 Too Many Requests Error

Rate limited (`rate_limited`): the key, the signed-in person, the workspace or an expensive endpoint's own budget is used up for now. `Retry-After` says how many seconds to wait, and `details` names the `policy`, its `limit`, `windowSeconds` and `retryAfter`. Every answer to an authenticated request carries the IETF `RateLimit-Policy` and `RateLimit` headers, so a client can slow down before it gets this. Nothing was done; wait and send it again. See "Rate limits".

- `error` (ErrorDetail, required)

## Types

### ScorecardColumn

- `key` (string, required) — What rows key their cells by, such as `1:FINAL` or `ANNUAL:Q2`.
- `timeframe` (enum, required) — The year, or one of its quarters.
  - Allowed values: `ANNUAL`, `Q1`, `Q2`, `Q3`, `Q4`
- `checkpoint` (enum, required) — Where the scorecard reads a grade. A quarterly objective is read at MID (halfway through its quarter) and FINAL; an annual one at the end of Q1, Q2 and Q3, and FINAL at the end of the year.
  - Allowed values: `MID`, `Q1`, `Q2`, `Q3`, `FINAL`
- `at` (datetime, required) — The moment it reads, the last millisecond of that day.
- `reached` (boolean, required)

### ScorecardRow

An objective, with cells only for its own time frame's columns.

- `objectiveId` (string, required)
- `title` (string, required)
- `weight` (double, required)
- `timeframe` (enum, required) — The year, or one of its quarters.
  - Allowed values: `ANNUAL`, `Q1`, `Q2`, `Q3`, `Q4`
- `cells` (map from string to ScorecardCell, required) — Rolled up from its key results, by weight.
- `keyResults` (list of ScorecardKeyResultRow, required)

### ErrorDetail

- `code` (string, required) — A stable machine-readable code such as `not_found`.
- `message` (string, required)
- `details` (any, optional)

### ScorecardCell

- `score` (double, optional) — Absent at a checkpoint that has not come, or with nothing to read.
- `source` (enum, optional)
  - Allowed values: `grade`, `history`
- `noScore` (boolean, optional) — `true` when the score was reset on the scorecard: the cell has no score, whatever the check-ins say, until a grade is set. Its `source` is `grade`, and it drops out of what is rolled up.
- `inProgress` (boolean, optional) — `true` on a Final that has not come and has no grade: `score` is then the latest check-in so far, where the key result (or, rolled up, the objective) stands, not a final score. The averages count it, and say so in `averageInProgress`.

### ScorecardKeyResultRow

- `keyResultId` (string, required)
- `title` (string, required)
- `weight` (double, required)
- `cells` (map from string to ScorecardCell, required)
- `priority` (enum, optional) — A key result's priority, and the dimension scores are averaged by, so a workspace can see how it did on what mattered most rather than only in aggregate. Objectives have none: a priority's average takes each objective on its key results of that priority alone, with the objective's own weight.
  - Allowed values: `P0`, `P1`, `P2`, `P3`

## Examples

**Response**

```json
{
  "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"
    ]
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.taktoria.com/api/v1/scorecard"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.taktoria.com/api/v1/scorecard';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.taktoria.com/api/v1/scorecard"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.taktoria.com/api/v1/scorecard")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.taktoria.com/api/v1/scorecard")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.taktoria.com/api/v1/scorecard', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.taktoria.com/api/v1/scorecard");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.taktoria.com/api/v1/scorecard")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```