Retrieving history collection status information

This example shows how to retrieve real-time history collection status information.

Requesting history collection status

To retrieve history collection status information, use the

GET
/data/historycollections/status

endpoint, as follows:

Use the following path to request the current status of all defined history collections:
```
https://host:port/api/v1/data/historycollections/status
```
The result of this request is a list of current status records for all defined history collections.
To request the current status of a specific history collection, include the name parameter, set to the name of the history collection configuration:
```
https://host:port/api/v1/data/historycollections/status?name=uadvisor_name
```
Where uadvisor_name is the unique name of the history collection configuration in the format UADVISOR_xxxxx. Commonly, Kpp and tablename appear in the name.
The result of this request is the current status record for the specified history collection.

Note: A request to a remote monitoring server returns information about the history collection status from the remote monitoring server. When a query is sent to the hub monitoring server, it returns information about both the hub monitoring server and the remote monitoring server.

Interpreting the response

The response to a GET /data/historycollections/status request is a JSON document that contains an array of objects that represent the records returned, as shown in the following example:

[
  {
    "NAME": "UADVISOR_KM5_ASCPUUTIL",
    "LCLTMSTMP": "1230915112744999",
    "DELTASTAT": "L",
    "NODE": "DEMOA:TEMS"
  }
  {
    "NAME": "UADVISOR_KM5_LPCLUST",
    "LCLTMSTMP": "1230915112744999",
    "DELTASTAT": "X",
    "NODE": "DEMOA:TEMS"
  }
]

The following table describes the properties that are returned in the response.

Table 1. Response properties for history collection status
Property	Description
`NAME`	The name of the history collection configuration.
`LCLTMSTMP`	Local timestamp.
`DELTASTAT`	History collection status. The possible values are as follows: L Started X In error
`NODE`	Node. The name of the managed system where the history collection is distributed. Use `/system/nodes` to get information about all nodes on the system.