History Queries

Get history query metrics

Changed on

Retrieves the current metrics of a history query

get/api/history/{historyId}/metrics

Request

  • Base URL: http://localhost:2223
  • URL: http://localhost:2223/api/history/{historyId}/metrics
  • Auth: none required

Path parameters

historyIdstring required

Response

The history query metrics

metricsStartstring required

Represents an instant in time as an ISO 8601 string.

Example response

{
  "metricsStart": "2023-10-31T12:34:56.789Z",
  "north": {
    "lastContentSent": "file1.json",
    "contentSentSize": 1024,
    "lastRunDuration": 1000,
    "lastRunStart": "2023-10-31T12:34:56.789Z",
    "lastConnection": "2023-10-31T12:34:56.789Z"
  },
  "south": {
    "lastFileRetrieved": "file1.json",
    "lastValueRetrieved": {
      "pointId": "point1",
      "timestamp": "2023-10-31T12:34:56.789Z"
    },
    "numberOfFilesRetrieved": 1,
    "numberOfValuesRetrieved": 100,
    "lastRunDuration": 1000,
    "lastRunStart": "2023-10-31T12:34:56.789Z",
    "lastConnection": "2023-10-31T12:34:56.789Z"
  },
  "historyMetrics": {
    "itemsStatus": [
      {
        "itemId": "e4f7e3f0-1234-4567-8901-abcdef123456",
        "itemName": "item1",
        "status": "running",
        "lastValueTimestamp": "2023-10-31T12:34:56.789Z",
        "recordsCount": 42
      }
    ],
    "itemNumberOfIntervals": 34,
    "itemIntervalNumber": 12,
    "itemIntervalProgress": 0.25,
    "numberOfItems": 10,
    "currentItemNumber": 3,
    "itemName": "item1",
    "numberOfIntervals": 2,
    "currentIntervalNumber": 1,
    "currentIntervalEnd": "2023-10-31T12:34:56.789Z",
    "currentIntervalStart": "2023-10-31T12:34:56.789Z",
    "intervalProgress": 0.5,
    "running": true
  }
}

Changes

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      endpoint added