List projects' counts | API Reference

from label_studio_sdk import LabelStudio
client = LabelStudio(
    base_url="http://localhost:8000",
    api_key="YOUR_API_KEY_HERE"
)
client.projects.list_counts()

{
  "count": 3,
  "results": [
    {
      "finished_task_number": 150,
      "ground_truth_number": 10,
      "id": 101,
      "num_tasks_with_annotations": 140,
      "queue_done": 130,
      "queue_left": 20,
      "queue_total": "150",
      "rejected": 5,
      "review_total_tasks": 145,
      "reviewed_number": 140,
      "skipped_annotations_number": "3",
      "task_number": 150,
      "total_annotations_number": "420",
      "total_predictions_number": 300,
      "useful_annotation_number": 400
    },
    {
      "finished_task_number": 75,
      "ground_truth_number": 5,
      "id": 102,
      "num_tasks_with_annotations": 70,
      "queue_done": 65,
      "queue_left": 10,
      "queue_total": "75",
      "rejected": 2,
      "review_total_tasks": 72,
      "reviewed_number": 70,
      "skipped_annotations_number": "1",
      "task_number": 75,
      "total_annotations_number": "210",
      "total_predictions_number": 150,
      "useful_annotation_number": 200
    },
    {
      "finished_task_number": 200,
      "ground_truth_number": 15,
      "id": 103,
      "num_tasks_with_annotations": 190,
      "queue_done": 180,
      "queue_left": 25,
      "queue_total": "205",
      "rejected": 8,
      "review_total_tasks": 195,
      "reviewed_number": 190,
      "skipped_annotations_number": "4",
      "task_number": 205,
      "total_annotations_number": "560",
      "total_predictions_number": 400,
      "useful_annotation_number": 550
    }
  ],
  "next": "http://localhost:8000/api/projects/counts/?page=2",
  "previous": null
}

Returns a list of projects with their counts. For example, task_number which is the total task number in project

Authentication

Authorizationstring

The token (or API key) must be passed as a request header. You can find your user token on the User Account page in Label Studio. Example:

curl https://label-studio-host/api/projects -H “Authorization: Token [your-token]”

The token (or API key) must be passed as a request header. You can find your user token on the User Account page in Label Studio. Example: <br><pre><code class="language-bash">curl https://label-studio-host/api/projects -H "Authorization: Token [your-token]"</code></pre>

Query parameters

filterstringOptionalDefaults to all

Filter projects by pinned status. Use ‘pinned_only’ to return only pinned projects, ‘exclude_pinned’ to return only non-pinned projects, or ‘all’ to return all projects.

idsstringOptional

Filter id by in list

includestringOptional

Comma-separated list of count fields to include in the response to optimize performance. Available fields: task_number, finished_task_number, total_predictions_number, total_annotations_number, num_tasks_with_annotations, useful_annotation_number, ground_truth_number, skipped_annotations_number. If not specified, all count fields are included.

orderingstringOptional

Which field to use when ordering the results.

pageintegerOptional

A page number within the paginated result set.

page_sizeintegerOptional

Number of results to return per page.

searchstringOptional

Search term for project title and description

statestringOptional

Filter current_state by exact match

titlestringOptional

Filter title by contains (case-insensitive)

workspacesdoubleOptional

Filter workspaces by exact match

Response

countinteger

resultslist of objects

nextstring or nullformat: "uri"

previousstring or nullformat: "uri"