Skip to main content

Statistics API

Analytics and Performance Metrics​

Comprehensive statistics and analytics for decision outcomes and system performance.

Decision Statistics​

Get detailed statistics for a specific decision.

Endpoint​

GET /api/stats/decision/{decision_id}

Authentication​

Required: JWT Bearer token

Path Parameters​

ParameterTypeRequiredDescription
decision_idstringYesDecision identifier

Response​

{
  "decision_id": "64a1b2c3d4e5f6789012345",
  "decision_action": "recommend_product_123",
  "total_outcomes": 150,
  "successful_outcomes": 120,
  "success_rate": 0.8,
  "last_updated": "2023-07-01T14:30:00.000Z"
}

Overall Statistics​

Get comprehensive statistics across all decisions for the authenticated customer.

Endpoint​

GET /api/stats/overall

Authentication​

Required: JWT Bearer token

Response​

{
  "total_decisions": 50,
  "total_outcomes": 500,
  "successful_outcomes": 400,
  "overall_success_rate": 0.8,
  "decision_breakdown": {
    "decision_1": {"total": 100, "successful": 85},
    "decision_2": {"total": 80, "successful": 65}
  },
  "last_updated": "2023-07-01T14:30:00.000Z"
}

Analyze outcome trends over a specified time period.

Endpoint​

GET /api/stats/trends

Authentication​

Required: JWT Bearer token

Query Parameters​

ParameterTypeRequiredDefaultDescription
daysintegerNo30Number of days to analyze

Response​

{
  "period_days": 30,
  "total_outcomes_in_period": 150,
  "daily_breakdown": {
    "2023-07-01": {"total": 5, "successful": 4},
    "2023-07-02": {"total": 8, "successful": 7}
  },
  "last_updated": "2023-07-01T14:30:00.000Z"
}

Evaluation Summary​

Get a comprehensive summary of all evaluation metrics.

Endpoint​

GET /api/stats/summary

Authentication​

Required: JWT Bearer token

Response​

{
  "overview": {
    "total_decisions": 50,
    "total_outcomes": 500,
    "overall_success_rate": 0.8
  },
  "quality_metrics": {
    "data_completeness": 0.95,
    "consistency_score": 0.88,
    "freshness_days": 7
  },
  "performance_indicators": {
    "avg_decisions_per_day": 15.5,
    "peak_activity_hour": "14:00",
    "most_common_outcome": "success"
  },
  "trends": {
    "weekly_growth": 0.12,
    "monthly_trend": "increasing",
    "seasonal_pattern": "stable"
  },
  "last_updated": "2023-07-01T14:30:00.000Z"
}

Decision Comparison​

Compare performance across multiple decisions.

Endpoint​

GET /api/stats/comparison

Authentication​

Required: JWT Bearer token

Query Parameters​

ParameterTypeRequiredDefaultDescription
limitintegerNo10Maximum number of decisions to compare

Response​

{
  "comparison_period": "all_time",
  "total_decisions_compared": 10,
  "top_performers": [
    {
      "decision_id": "decision_1",
      "action": "recommend_electronics",
      "total_outcomes": 100,
      "success_rate": 0.95,
      "rank": 1
    },
    {
      "decision_id": "decision_2",
      "action": "recommend_books",
      "total_outcomes": 80,
      "success_rate": 0.85,
      "rank": 2
    }
  ],
  "last_updated": "2023-07-01T14:30:00.000Z"
}

Performance Metrics​

Get system performance and quality metrics.

Endpoint​

GET /api/stats/performance

Authentication​

Required: JWT Bearer token

Response​

{
  "accuracy": 0.85,
  "precision": 0.82,
  "recall": 0.88,
  "f1_score": 0.85,
  "avg_response_time_ms": 150,
  "throughput_per_second": 100,
  "error_rate": 0.05,
  "last_updated": "2023-07-01T14:30:00.000Z"
}

Example Usage​

Get Decision Statistics​

curl -X GET "http://localhost:5049/api/stats/decision/64a1b2c3d4e5f6789012345" \
  -H "Authorization: Bearer <jwt-token>"

Get Overall Statistics​

curl -X GET "http://localhost:5049/api/stats/overall" \
  -H "Authorization: Bearer <jwt-token>"
curl -X GET "http://localhost:5049/api/stats/trends?days=7" \
  -H "Authorization: Bearer <jwt-token>"

Get Evaluation Summary​

curl -X GET "http://localhost:5049/api/stats/summary" \
  -H "Authorization: Bearer <jwt-token>"

Compare Top 5 Decisions​

curl -X GET "http://localhost:5049/api/stats/comparison?limit=5" \
  -H "Authorization: Bearer <jwt-token>"

Get Performance Metrics​

curl -X GET "http://localhost:5049/api/stats/performance" \
  -H "Authorization: Bearer <jwt-token>"

Metrics Explained​

Success Rate​

Percentage of outcomes that are considered successful (contain "success" in the outcome string).

Performance Metrics​

  • Accuracy: Overall correctness of predictions
  • Precision: True positive rate
  • Recall: Ability to find all positive instances
  • F1 Score: Harmonic mean of precision and recall
  • Response Time: Average API response time
  • Throughput: Requests processed per second
  • Error Rate: Percentage of failed requests

Quality Metrics​

  • Data Completeness: Percentage of complete data records
  • Consistency Score: Data consistency across records
  • Freshness: Age of most recent data in days

Data Aggregation​

Statistics are computed in real-time from MongoDB collections:

  • decisions: Decision records and actions
  • outcomes: Result records and customer feedback

All statistics are scoped to the authenticated customer's data for privacy and security.