Platform Metrics

POST /api/v2/metrics/platform_metrics

Description

The platform_metrics endpoint retrieves comprehensive platform-wide metrics including Elasticsearch cluster statistics and Arcanna system performance data. This endpoint provides an overview of your entire platform's health and usage across all jobs or a filtered subset.

Quick Start Examples

Get platform metrics for all jobs

curl -X POST "https://your.arcanna.ai/api/v2/metrics/platform_metrics" \
  -H "X-Arcanna-Api-Key: your-api-key-here" \
  -H "Content-Type: application/json"

Get platform metrics for specific jobs

curl -X POST "https://your.arcanna.ai/api/v2/metrics/platform_metrics?job_ids=1234,5678" \
  -H "X-Arcanna-Api-Key: your-api-key-here" \
  -H "Content-Type: application/json"

Get platform metrics with custom time aggregation

curl -X POST "https://your.arcanna.ai/api/v2/metrics/platform_metrics?aggregation_time_interval=1d" \
  -H "X-Arcanna-Api-Key: your-api-key-here" \
  -H "Content-Type: application/json"

Request Parameters

Query Parameters

Parameter	Type	Required	Description
job_ids	integer or array of integers	No	Job IDs to filter by. If not provided, metrics for all jobs will be included
aggregation_time_interval	string	No	Time interval for aggregation (e.g., '1d', '7d', '15d', '30d'). Default is '7d'

Response

Success Response (200 OK)

{
  "es_cluster_metrics": {
    "cluster_name": "arcanna-cluster",
    /* ... */
  },
  "arcanna": {
    "overall": {
      "buckets_count": 4134,
      "storage_mb": 2197,
      "events_count": 197015
    },
    "per_job_metrics": [
        /* ... */
    ]
    /* ... */
  }
}

Use Cases

• Monitor overall platform health and performance
• Track resource usage across all jobs
• Analyze system load and capacity planning
• Generate platform-wide reports and dashboards