Entities

Fetch the history of an entity's properties

This route allows you to retrieve historical values for a selected list of an entity's properties over a given time range.<br/><br/>To learn more about entities, check out the entity documentation.

post/v1/entities/properties-history

Request

  • Base URL: https://api.port.io
  • URL: https://api.port.io/v1/entities/properties-history
  • Auth: API key in header Authorization

Request body

entityIdentifierstring required

The identifier of the entity you want to operate on.

blueprintIdentifierstring required

The identifier of the blueprint you want to operate on.

propertyNamesstring[] required

An array of property names to fetch historical records for.

timeInterval'hour' | 'day' | 'isoWeek' | 'month' | 'quarter'

Response

Retrieved successfully.

okunknown required

Changes

No recorded changes to this operation across all 1 revision of this API.