✨ Get dimension | API Reference

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

Retrieve a specific dimension by ID.

<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> Retrieve a specific dimension by ID.

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

idintegerRequired

Dimension ID

project_pkintegerRequired

Project ID

Response

Dimension details

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

created_byinteger or nullRead-only

User who created this dimension

idintegerRead-only

namestring1-255 characters

Unique identifier for this dimension within the project

projectintegerRead-only

Project this dimension belongs to

updated_atdatetimeRead-only

descriptionstring

Human-readable description of what this dimension represents

extraction_methodstring<=32 characters

Method used to extract values from annotation JSON

extraction_method_paramsany

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

is_activeboolean

Whether this dimension is used in agreement calculations.

is_user_definedboolean

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

metric_paramsany

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

metric_typestring<=32 characters

Strategy for comparing dimension values across annotators

orderinteger0-2147483647

Display order within the project

1	{
2	"allowed_metrics_with_params": "{\"accuracy\": {\"threshold\": 0.8}, \"f1_score\": {\"average\": \"macro\"}}",
3	"control_tag": "label",
4	"created_at": "2024-01-15T09:30:00Z",
5	"created_by": 42,
6	"id": 1,
7	"name": "label_agreement",
8	"project": 1,
9	"updated_at": "2024-01-15T09:30:00Z",
10	"description": "Dimension representing label agreement accuracy",
11	"extraction_method": "jsonpath",
12	"extraction_method_params": {
13	"path": "$.annotations[].result[].value.choices[0]"
14	},
15	"is_active": true,
16	"is_user_defined": true,
17	"metric_params": {
18	"threshold": 0.75
19	},
20	"metric_type": "accuracy",
21	"order": 1
22	}

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