✨ List dimensions | API Reference

This endpoint is not available in Label Studio Community Edition. Learn more about Label Studio Enterprise

List all dimensions for a specific project.

<Card href="https://humansignal.com/goenterprise"> <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/> <p style="margin-top: 10px; font-size: 14px;"> This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) </p> </Card> List all dimensions for a specific project.

Authentication

AuthorizationToken

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>

Path parameters

project_pkintegerRequired

Project ID

Query parameters

agreement_methodologystringOptional

Agreement methodology to use for computing allowed_metrics_with_params. If not provided, uses the methodology stored in the project settings. Valid values: “pairwise”, “consensus”.

is_activebooleanOptional

Filter by active status

orderingstringOptional

Which field to use when ordering the results.

Response

List of dimensions

allowed_metrics_with_paramsstringRead-only

Dictionary mapping metric type names to their parameter schemas.

control_tagstring or nullRead-only

Name of the control tag this dimension is extracted from. Set automatically for system dimensions.

created_atdatetimeRead-only

descriptionstringRead-only

Human-readable description of what this dimension represents

extraction_methodstringRead-only

Method used to extract values from annotation JSON

extraction_method_paramsanyRead-only

Parameters specific to the extraction method. See metrics.py for available extraction methods and their parameters.

idintegerRead-only

is_activebooleanRead-only

Whether this dimension is used in agreement calculations.

is_user_definedbooleanRead-only

Whether this dimension was manually created by a user. System-generated dimensions have this set to False.

metric_paramsanyRead-only

Parameters for the metric. See metrics.py for available metrics and their parameters.

metric_typestringRead-only

Strategy for comparing dimension values across annotators

namestringRead-only

Unique identifier for this dimension within the project

orderintegerRead-only

Display order within the project

projectintegerRead-only

Project this dimension belongs to

updated_atdatetimeRead-only

1	[
2	{
3	"allowed_metrics_with_params": "{\"accuracy\": {\"threshold\": 0.8}, \"f1_score\": {\"average\": \"macro\"}}",
4	"control_tag": "TextArea",
5	"created_at": "2024-01-15T09:30:00Z",
6	"description": "Dimension representing the sentiment polarity extracted from user comments",
7	"extraction_method": "jsonpath",
8	"extraction_method_params": {
9	"path": "$.annotations.sentiment"
10	},
11	"id": 42,
12	"is_active": true,
13	"is_user_defined": true,
14	"metric_params": {
15	"threshold": 0.75
16	},
17	"metric_type": "categorical_accuracy",
18	"name": "sentiment_polarity",
19	"order": 1,
20	"project": 1,
21	"updated_at": "2024-01-15T09:30:00Z"
22	}
23	]

1	curl http://localhost:8000/api/projects/1/dimensions/ \
2	-H "Authorization: Token <api_key>" \
3	-H "Content-Type: application/json"