Sign in
South Connectors

Get south connector metrics

Retrieves the current metrics of a south connector

get/api/south/{southId}/metrics

Path parameters

southIdstring required

Response

The south connector metrics

metricsStartstring required

Represents an instant in time as an ISO 8601 string.

lastConnectionstring required

Represents an instant in time as an ISO 8601 string.

lastRunStartstring required

Represents an instant in time as an ISO 8601 string.

lastRunDurationnumber double nullable required

The duration of the last run in milliseconds.

numberOfValuesRetrievednumber double required

The number of values retrieved.

numberOfFilesRetrievednumber double required

The number of files retrieved.

lastFileRetrievedstring nullable required

The last file retrieved.

Example response

{
  "metricsStart": "2023-10-31T12:34:56.789Z",
  "lastConnection": "2023-10-31T12:34:56.789Z",
  "lastRunStart": "2023-10-31T12:34:56.789Z",
  "lastRunDuration": 1000,
  "numberOfValuesRetrieved": 100,
  "numberOfFilesRetrieved": 1,
  "lastValueRetrieved": {
    "pointId": "point1",
    "timestamp": "2023-10-31T12:34:56.789Z"
  },
  "lastFileRetrieved": "file1.json"
}

Changes

Changed in 51 of the 320 revisions of this API.2526