Skip to content

Timeseries API

The Timeseries API allows you to retrieve and analyze time-based metrics and events data from Aegis.

Endpoints

Get Time Series Data

Retrieve time series data for policy evaluations.

POST /api/timeseries
curl -X POST "https://<your-instance>.aegis.pegasys.cloud/api/timeseries" \
  -H "Authorization: Bearer <your_token>" \
  -H "Content-Type: application/json" \
  -d @- <<EOF
            {
              "startTimestamp": "2025-06-07T18:31:14",
              "endTimestamp": "2025-06-14T18:31:14",
              "interval": "day",
              "keys": ["policy_name", "rule_status"]
            }
        EOF
{
  "startTimestamp": "2025-06-07T18:31:14",
  "endTimestamp": "2025-06-14T18:31:14",
  "interval": "day",
  "keys": ["policy_name", "rule_status"]
}
{
  "timeseries": [
    {
      "timestamp": "2025-06-07T00:00:00Z",
      "policy_name": "deployments",
      "rule_status": "passed",
      "count": 42
    },
    {
      "timestamp": "2025-06-07T00:00:00Z",
      "policy_name": "deployments",
      "rule_status": "failed",
      "count": 18
    },
    {
      "timestamp": "2025-06-08T00:00:00Z",
      "policy_name": "deployments",
      "rule_status": "passed",
      "count": 53
    }
  ]
}

Get Available Time Series Keys

Retrieve available keys for time series queries.

GET /api/timeseries/keys

Query Parameters:

Parameter Description
startTimestamp Start date/time for the query in ISO 8601 format (e.g., "2025-01-01T00:00:00")
endTimestamp End date/time for the query in ISO 8601 format (e.g., "2025-07-01T00:00:00")
curl -X GET "https://<your-instance>.aegis.pegasys.cloud/api/timeseries/keys?startTimestamp=2025-01-01T00:00:00&endTimestamp=2025-07-01T00:00:00" \
  -H "Authorization: Bearer <your_token>"
{
  "keys": [
    "policy_name",
    "rule_name",
    "rule_status",
    "policy_platform",
    "resource_kind",
    "resource_namespace"
  ]
}