Annotation History

✨ List all annotation history items for annotation

Changed on
<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 annotation history items for an annotation. Annotation history logs all actions performed with annotations, such as: imports, submits, updates, reviews, and more. Users can view annotation history items in the Annotation History panel during labeling.
get/api/annotation-history/

Request

  • Base URL
    http://localhost:8000
  • URL
    http://localhost:8000/api/annotation-history/
  • Auth
    API key in header Authorization

Query parameters

annotationinteger

Annotation ID to get annotation history items for.

orderingstring

Which field to use when ordering the results.

Response

action'prediction' | 'propagated_annotation' | 'imported' | 'submitted' | 'updated' | 'skipped' | 'accepted' | 'rejected' | 'fixed_and_accepted' | 'deleted_review'
  • prediction - Created from prediction
  • propagated_annotation - Created from another annotation
  • imported - Imported
  • submitted - Submitted
  • updated - Updated
  • skipped - Skipped
  • accepted - Accepted
  • rejected - Rejected
  • fixed_and_accepted - Fixed and accepted
  • deleted_review - Deleted review
annotation_idinteger nullable

Corresponding annotation for this historical annotation

commentstring nullable required
comment_idinteger nullable

Comment id sent with result

created_atstring date-time required
created_byinteger nullable

Created by user id

draft_idinteger nullable

Corresponding draft for this historical annotation

idinteger required
lead_timenumber double nullable

How much time it took to annotate the task

organization_idinteger nullable

Organization for this annotation history

project_idinteger nullable

Project for this annotation history

resultunknown
review_idinteger nullable

AnnotationReview ID, using with review field

started_atstring date-time nullable

The time that a user started working on this revision of the annotation

task_idinteger nullable

Task id

Changes

  • 04ff286141b5Revision changes
    • info

      added to the / response property allOf list for the response status

    • info

      removed from the / response property allOf list for the response status