monitoring

Get monitoring service status. (admin access required)

Gets the current status of the blockchain state monitoring service

get/monitoring

Request

  • Base URL: ./../api/v1/ (relative, and the document was published on a file host, not at the API’s origin)
  • URL: ./../api/v1/monitoring
  • Auth: API key in header token

Response

Monitoring service status

status'success' required

Example response

{
  "status": "success",
  "data": {
    "MonitoringStatus": {
      "isMonitoring": true,
      "Stats": {
        "trackedEntities": 42,
        "PurchaseCursor": {
          "timestamp": "2024-01-01T00:00:00.000Z",
          "lastId": "cuid_v2_auto_generated"
        },
        "PaymentCursor": {
          "timestamp": "2024-01-01T00:00:00.000Z",
          "lastId": "cuid_v2_auto_generated"
        },
        "MemoryUsage": {
          "heapUsed": "50MB",
          "heapTotal": "100MB",
          "external": "10MB"
        }
      }
    }
  }
}

Changes

No recorded changes to this operation across all 50 revisions of this API.