---
title: "Get an overview of a project"
method: GET
path: "/project/{projectId}/overview"
tags: ["project"]
---

# Get an overview of a project

`GET /project/{projectId}/overview`

## Path parameters

- `projectId` string, required

## Response `200`

A project overview

- ProjectOverview
  - `project` Project
    - `id` string
    - `name` string
    - `created_on` string, date-time
  - `sessions` unknown[]
    - unknown
  - `model_usage` object[]
    - `model_name` string
    - `date` string, date
    - `token_usage` number
    - `average_latency` number, float
    - `cost` number, float

## Changes

- **2024-08-13** `c3ab20af61ef` — 1 breaking, 1 warning, 2 info
  - the `sessions` response's property type/format changed from `object`/`` to `array`/`` for status `200`
  - removed the optional property `sessions/event_count` from the response with the `200` status
  - added the optional property `model_usage/items/date` to the response with the `200` status
  - added the optional property `sessions/thread_count` to the response with the `200` status
- **2024-08-12** `5800c68dedbb` — 1 info
  - the `project/id` response's property pattern `^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` was added for the status `200`

[Change history](https://skmtc.dev/defra/apis/twiki-api/changes/project/:projectId/overview/get.md)

---

[API](https://skmtc.dev/defra/apis/twiki-api.md) · [All operations](https://skmtc.dev/defra/apis/twiki-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/defra/twiki-api/revisions/c3ab20af61ef/schema)