{ "opencollection": "1.0.0", "info": { "name": "API Reference subpackage_actions subpackage_projects.subpackage_projects/stats API", "version": "1.0.0" }, "items": [ { "info": { "name": "subpackage_projects.subpackage_projects/stats", "type": "folder" }, "items": [ { "info": { "name": "✨ Get model-version overall agreement vs annotators", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8000/api/projects/:id/model-stats/:model_version/agreement", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "model_version", "value": "", "type": "path" } ] }, "docs": "\n \"Label\n

\n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n

\n
\nGet agreement between a given model vers" }, { "info": { "name": "✨ Get model-version ground truth agreement", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8000/api/projects/:id/model-stats/:model_version/agreement-groundtruth", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "model_version", "value": "", "type": "path" }, { "name": "per_label", "value": "", "type": "query", "description": "Calculate agreement per label" } ] }, "docs": "\n \"Label\n

\n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n

\n
\nGet agreement between a given model vers" }, { "info": { "name": "✨ Get model-version prediction agreement", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8000/api/projects/:id/model-stats/:model_version/prediction", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "model_version", "value": "", "type": "path" }, { "name": "per_label", "value": "", "type": "query", "description": "Calculate agreement per label" } ] }, "docs": "\n \"Label\n

\n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n

\n
\nGet agreement between a given model vers" }, { "info": { "name": "✨ Get Inter-Annotator Agreement matrix", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8000/api/projects/:id/stats/IAA", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "expand", "value": "", "type": "query", "description": "Comma-separated list of fields to expand" }, { "name": "per_label", "value": "", "type": "query", "description": "Calculate IAA per label" }, { "name": "std", "value": "", "type": "query", "description": "Include standard deviation in results" }, { "name": "task", "value": "", "type": "query", "description": "Comma-separated list of task IDs to filter by" } ] }, "docs": "\n \"Label\n

\n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n

\n
\nGet Inter-Annotator Agreement (IAA) matr" }, { "info": { "name": "✨ Get ground truth agreement for multiple users", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8000/api/projects/:id/stats/agreement-groundtruth", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "ids", "value": "", "type": "query", "description": "Comma separated list of user IDs to get ground truth agreement for" }, { "name": "per_label", "value": "", "type": "query", "description": "Per label" } ] }, "docs": "\n \"Label\n

\n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n

\n
\nGet ground truth agreement statistics fo" }, { "info": { "name": "✨ Get individual annotator agreement stats", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8000/api/projects/:id/stats/agreement_annotator/:user_id", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "user_id", "value": "", "type": "path" } ] }, "docs": "\n \"Label\n

\n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n

\n
\nGet agreement statistics for a specific " }, { "info": { "name": "✨ Get agreement statistics for multiple annotators", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8000/api/projects/:id/stats/agreement_annotators", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "ids", "value": "", "type": "query", "description": "Comma separated list of annotator user IDs to get agreement scores for" } ] }, "docs": "\n \"Label\n

\n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n

\n
\nGet agreement statistics for multiple an" }, { "info": { "name": "✨ Get user data filter statistics", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8000/api/projects/:id/stats/data_filter", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "\n \"Label\n

\n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n

\n
\nGet statistics about user data filters a" }, { "info": { "name": "✨ Get finished tasks statistics", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8000/api/projects/:id/stats/finished", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "user_pk", "value": "", "type": "query", "description": "User ID to filter statistics by (optional)" } ] }, "docs": "\n \"Label\n

\n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n

\n
\nGet statistics about finished tasks for " }, { "info": { "name": "✨ Get label distribution counts", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8000/api/projects/:id/stats/label-distribution/counts", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "choice_keys", "value": "", "type": "query", "description": "Explicit choice keys to fetch, joined by \"___PIPE___\" (for example: \"label___SEP___pos___PIPE___quality___SEP___4\"). When provided, pagination params are ignored." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of choice keys to return for pagination. Ignored when `choice_keys` is provided." }, { "name": "offset", "value": "", "type": "query", "description": "Zero-based offset into the structure `choice_keys` list. Used only when `choice_keys` is not provided." } ] }, "docs": "\n \"Label\n

\n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n

\n
\nReturns counts and percentages for reque" }, { "info": { "name": "✨ Get label distribution structure", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8000/api/projects/:id/stats/label-distribution/structure", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "\n \"Label\n

\n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n

\n
\nReturns dimensions and flattened `choice" }, { "info": { "name": "✨ Get lead time statistics", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8000/api/projects/:id/stats/lead_time", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "\n \"Label\n

\n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n

\n
\nGet lead time statistics across the proj" }, { "info": { "name": "✨ Get paginated member performance rows", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8000/api/projects/:id/stats/member_performance_rows/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "ids", "value": "", "type": "query", "description": "Comma-separated user IDs to include. When omitted, members are derived from the project." }, { "name": "ordering", "value": "", "type": "query", "description": "Sort field; prefix with \"-\" for descending (e.g. \"-finished\")." }, { "name": "page", "value": "", "type": "query", "description": "1-based page index." }, { "name": "page_size", "value": "", "type": "query", "description": "Page size (1–100)." }, { "name": "table", "value": "", "type": "query", "description": "Which table to load: \"annotations\" or \"reviews\"." } ] }, "docs": "\n \"Label\n

\n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n

\n
\nPaginated, sortable member performance r" }, { "info": { "name": "✨ Get total agreement for project", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8000/api/projects/:id/stats/total_agreement", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "per_label", "value": "", "type": "query", "description": "Return agreement per label" } ] }, "docs": "\n \"Label\n

\n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n

\n
\nOverall or per-label total agreement acr" }, { "info": { "name": "✨ Start stats recalculation", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8000/api/projects/:id/update-stats", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "stat_type", "value": "", "type": "query", "description": "Stat type to recalculate. Possible values: label, stats" } ] }, "docs": "\n \"Label\n

\n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n

\n
\nStart stats recalculation for given proj" }, { "info": { "name": "✨ Get prediction agreement statistics for multiple annotators", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8000/api/projects/:id/user-stats/prediction", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "ids", "value": "", "type": "query", "description": "Comma separated list of annotator user IDs to get agreement scores for" }, { "name": "per_label", "value": "", "type": "query", "description": "Per label" } ] }, "docs": "\n \"Label\n

\n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n

\n
\nGet prediction agreement statistics for " }, { "info": { "name": "✨ Get review scores for multiple annotators", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8000/api/projects/:id/user-stats/review_score", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "ids", "value": "", "type": "query", "description": "Comma separated list of annotator user IDs to get review scores for" }, { "name": "per_label", "value": "", "type": "query", "description": "Per label" } ] }, "docs": "\n \"Label\n

\n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n

\n
\nGet review score and performance score s" }, { "info": { "name": "✨ Get individual user prediction agreement", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8000/api/projects/:id/user-stats/:user_pk/prediction", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "user_pk", "value": "", "type": "path" }, { "name": "per_label", "value": "", "type": "query", "description": "Calculate agreement per label" } ] }, "docs": "\n \"Label\n

\n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n

\n
\nGet prediction agreement statistics for " }, { "info": { "name": "✨ Get individual user review scores", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8000/api/projects/:id/user-stats/:user_pk/review_score", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "user_pk", "value": "", "type": "path" }, { "name": "per_label", "value": "", "type": "query", "description": "Calculate agreement per label" } ] }, "docs": "\n \"Label\n

\n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n

\n
\nGet review score statistics for a specif" }, { "info": { "name": "✨ Get individual user ground truth agreement", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8000/api/projects/:id/users/:user_pk/stats/agreement-groundtruth", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "user_pk", "value": "", "type": "path" }, { "name": "per_label", "value": "", "type": "query", "description": "Calculate agreement per label" } ] }, "docs": "\n \"Label\n

\n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n

\n
\nGet ground truth agreement statistics fo" } ] } ], "bundled": true }