States

✨ Get entity state history

<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> Get the state history of an entity
get/api/fsm/entities/{entity_name}/{entity_id}/history

Request

  • Base URL
    http://localhost:8000
  • URL
    http://localhost:8000/api/fsm/entities/{entity_name}/{entity_id}/history
  • Auth
    API key in header Authorization

Path parameters

entity_idinteger required
entity_namestring required

Query parameters

created_at_fromstring

Filter for state history items created at or after the ISO 8601 formatted date (YYYY-MM-DDTHH:MM:SS)

created_at_tostring

Filter for state history items created at or before the ISO 8601 formatted date (YYYY-MM-DDTHH:MM:SS)

orderingstring

Which field to use when ordering the results.

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

previous_statestring

Filter previous_state by exact match (case-insensitive)

statestring

Filter state by exact match (case-insensitive)

transition_namestring

Filter transition_name by exact match (case-insensitive)

triggered_bynumber

Filter triggered_by by exact match

Response

countinteger required
nextstring uri nullable
previousstring uri nullable

Example response

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2"
}

Changes

No operation changes recorded.