NetXMS icon

NetXMS

Interact with the NetXMS network monitoring and management system

Actions41

Data Collection → Get History

AI-generated

Summary

Retrieve historical values for a specific NetXMS Data Collection Item (DCI) on a target object. Optionally constrain the time range, limit data points, or request raw samples or hourly/daily aggregates.

Inputs

  • objectId (required) — Required numeric ID of the data collection target object.
  • dciId (required) — Required numeric ID of the DCI whose history to retrieve.
  • additionalFields — Optional history query settings.
  • function — Optional aggregation function within Additional Fields: avg (default), max, min, or minmax. Declared for hourly/daily reads and ignored for raw data.
  • maxDataPoints — Optional raw-data bucketing target within Additional Fields. 0 disables bucketing and is omitted from the request.
  • maxRows — Optional maximum number of returned data points within Additional Fields. 0 uses the server default and is omitted from the request.
  • tier — Optional storage tier within Additional Fields: auto (server chooses), daily, hourly, or raw. Defaults to auto when added.
  • timeFrom — Optional starting Unix timestamp within Additional Fields. 0 means no lower bound and is omitted from the request.
  • timeTo — Optional ending Unix timestamp within Additional Fields. 0 means now and is omitted from the request.

Output shape

The API's history response as JSON items: one item per element if it returns an array, otherwise one item containing the response.

The source does not specify history record fields or an API response envelope. It passes the response through without extracting nested data or fetching additional pages. With Continue On Fail enabled, a failed history request produces an item containing an error message.

Examples

Example 1: Read raw samples for a DCI over a bounded time range

Set Object ID and DCI ID, then add Storage Tier = raw, Time From, Time To, and optionally Max Rows or Max Data Points.

Links

Discussion