v77

latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-045764591.5 MB

Dimensions

✨ List dimensions

<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.

get/api/projects/{project_pk}/dimensions/

Path parameters

project_pkinteger required

Project ID

Query parameters

agreement_methodologystring

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_activeboolean

Filter by active status

orderingstring

Which field to use when ordering the results.

Response

List of dimensions

allowed_metrics_with_paramsobject required

Dictionary mapping metric type names to their parameter schemas.

control_tagstring nullable required

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

created_atstring date-time required

descriptionstring required

Human-readable description of what this dimension represents

extraction_methodstring required

Method used to extract values from annotation JSON

{"stackTrail":"components:schemas:DimensionList:properties:extraction_method_params","oasType":"schema","type":"unknown","title":"Extraction method parameters","description":"Parameters specific to the extraction method. See metrics.py for available extraction methods and their parameters."}

idinteger required

is_activeboolean required

Whether this dimension is used in agreement calculations.

is_categoricalboolean required

Whether this dimension produces categorical (primitive/scalar) values.

is_user_definedboolean required

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

{"stackTrail":"components:schemas:DimensionList:properties:metric_params","oasType":"schema","type":"unknown","title":"Metric parameters","description":"Parameters for the metric. See metrics.py for available metrics and their parameters."}

metric_typestring required

Strategy for comparing dimension values across annotators

namestring required

Unique identifier for this dimension within the project

orderinteger required

Display order within the project

projectinteger required

Project this dimension belongs to

updated_atstring date-time required

{"stackTrail":"components:schemas:DimensionList:properties:values_enum","oasType":"schema","type":"unknown","description":"Schema-defined enum values for indexed value_counts. Refreshed only with label config changes.","nullable":true}