Metrics

Deprecated

Agent metrics

get

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

Authorizations

userproject

Path parameters

agentIDstring · uuidRequired

Query parameters

startstring · durationOptionalDefault: -24h

intervalstring · durationOptionalDefault: 1h

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /v1/agents/{agentID}/metrics HTTP/1.1
Host: cloud-api.calyptia.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "measurements": {
    "ANY_ADDITIONAL_PROPERTY": {
      "plugins": {
        "ANY_ADDITIONAL_PROPERTY": {
          "metrics": {
            "ANY_ADDITIONAL_PROPERTY": [
              {
                "time": "2025-06-27T23:15:29.277Z",
                "value": 1
              }
            ]
          }
        }
      },
      "totals": {
        "ANY_ADDITIONAL_PROPERTY": [
          {
            "time": "2025-06-27T23:15:29.277Z",
            "value": 1
          }
        ]
      }
    }
  }
}

Agent metrics

get

Authorizations

userproject

Path parameters

agentIDstring · uuidRequired

Query parameters

startstring · durationOptional

Option to filter metrics since the given time ago

Default: -24h

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /v2/agents/{agentID}/metrics HTTP/1.1
Host: cloud-api.calyptia.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "input": {
      "bytes": 0,
      "records": 0
    }
  },
  "outputs": {
      "bytes": 0,
      "records": 0,
      "errors": 0,
      "retries": 0,
      "retriedRecords": 0,
      "retriesFailed": 0,
      "droppedRecords": 0,
      "loads": 0
    }
  },
  "filters": {
      "dropRecords": 0,
      "emitRecords": 0
    }
  }
}