Analytics Endpoints

Access performance metrics, execution statistics, and business intelligence data.

Get Metrics

Retrieve aggregated metrics for a specified time period.

GET /v1/analytics/metrics
curl -X GET "https://api.sematryx.com/v1/analytics/metrics?start_date=2024-01-01&end_date=2024-01-31" \
  -H "Authorization: Bearer YOUR_API_KEY"

Query Parameters

  • start_date (required): Start date in ISO 8601 format
  • end_date (required): End date in ISO 8601 format
  • optimization_id (optional): Filter by specific optimization
  • granularity (optional): hour, day, week, month (default: day)
Response
{
  "period": {
    "start": "2024-01-01T00:00:00Z",
    "end": "2024-01-31T23:59:59Z"
  },
  "metrics": {
    "total_optimizations": 1250,
    "successful_optimizations": 1195,
    "failed_optimizations": 55,
    "average_optimization_time": 2.34,
    "total_evaluations": 1250000,
    "cost": {
      "total": 125.50,
      "currency": "USD"
    }
  },
  "trends": {
    "optimizations_per_day": [45, 52, 38, 61, ...],
    "success_rate": [0.96, 0.97, 0.95, 0.98, ...]
  }
}

Get Execution Statistics

Get detailed statistics about optimization runs.

GET /v1/analytics/executions
curl -X GET https://api.sematryx.com/v1/analytics/executions \
  -H "Authorization: Bearer YOUR_API_KEY"

Query Parameters

  • start_date (optional): Filter executions from this date
  • end_date (optional): Filter executions until this date
  • optimization_id (optional): Filter by specific optimization
  • status (optional): Filter by status (completed, failed, running, pending)
Response
{
  "total": 1250,
  "by_status": {
    "completed": 1195,
    "failed": 55
  },
  "by_optimization": [
    {
      "optimization_id": "opt_1234567890",
      "count": 450,
      "success_rate": 0.98
    }
  ],
  "time_series": [
    {
      "date": "2024-01-01",
      "optimizations": 45,
      "successful": 43,
      "failed": 2
    }
  ]
}

Get Performance Data

Retrieve performance metrics for specific optimizations or overall account.

GET /v1/analytics/performance
curl -X GET "https://api.sematryx.com/v1/analytics/performance?optimization_id=opt_1234567890" \
  -H "Authorization: Bearer YOUR_API_KEY"

Performance Metrics

  • Execution Time: Average, median, p95, p99 execution times
  • Throughput: Executions per second/minute/hour
  • Error Rate: Percentage of failed executions
  • Resource Usage: CPU, memory, network utilization
  • Cost Efficiency: Cost per execution, optimization opportunities

Available Metrics

Execution Metrics

  • • Total optimizations
  • • Successful optimizations
  • • Failed optimizations
  • • Optimization time statistics
  • • Success rate

Business Metrics

  • • Function evaluations
  • • Cost analysis
  • • ROI calculations
  • • Usage trends
  • • Efficiency gains

Performance Metrics

  • • Response times
  • • Throughput rates
  • • Resource utilization
  • • Error rates
  • • Optimization opportunities

Trend Analysis

  • • Time series data
  • • Growth trends
  • • Seasonal patterns
  • • Anomaly detection
  • • Predictive insights

Exporting Data

Analytics data can be exported in various formats for further analysis:

  • CSV: Add ?format=csv to any endpoint
  • JSON: Default format for all endpoints
  • Excel: Add ?format=xlsx for Excel export
  • PDF: Add ?format=pdf for report export