Metrics | Docs

Agent metrics

Deprecated

Contains an overview of the aggregated metrics for an agent. It includes metrics link the amount of records, bytes, and errors per plugin.

get

/v1/agents/{agentID}/metrics

Authorizations

Path parameters

agentIDstring · uuidrequired

Query parameters

startstring · duration · default: -24h

intervalstring · duration · default: 1h

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://cloud-api.calyptia.com/v1/agents/{agentID}/metrics' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "measurements": {
    "ANY_ADDITIONAL_PROPERTY": {
      "plugins": {
        "ANY_ADDITIONAL_PROPERTY": {
          "metrics": {
            "ANY_ADDITIONAL_PROPERTY": [
              {
                "time": "2025-03-12T03:46:27.573Z",
                "value": null
              }
            ]
          }
        }
      },
      "totals": {
        "ANY_ADDITIONAL_PROPERTY": [
          {
            "time": "2025-03-12T03:46:27.573Z",
            "value": null
          }
        ]
      }
    }
  }
}