Skip to content

API Reference

Champa Intelligence provides a comprehensive REST API for programmatic access to all platform features. The API follows RESTful principles, uses JSON for request/response payloads, and requires JWT-based authentication.

API Overview

Base URL

https://your-domain.com

All API endpoints are relative to this base URL.

Authentication

All API requests require authentication using either:

  1. JWT Token (for user sessions)
  2. API Token (for programmatic access)

See Authentication for detailed information.

Response Format

All API responses follow a consistent JSON structure:

{
  "success": true,
  "data": {},
  "timestamp": "2025-01-15T10:30:00.123456"
}

Error Response:

{
  "success": false,
  "error": "Error message",
  "status_code": 400
}

API Sections

Core APIs

  • Portfolio API

    Executive-level portfolio overview, KPIs, and trend analysis across all process definitions.

  • Dashboard API

    Process intelligence analytics, lazy-loaded dashboard sections, and comprehensive monitoring data.

  • Health Monitoring API

    Multi-node cluster health, JVM metrics, database performance, and system diagnostics.

  • Metrics API

    Prometheus-format metrics endpoints for Grafana integration and alerting.

Feature APIs

  • AI Analysis API

    AI-powered process analysis, natural language insights, and recommendations.

  • Journey API

    End-to-end business journey tracking across multiple processes.

Error Codes

Code Meaning Description
200 OK Request successful
201 Created Resource created successfully
400 Bad Request Invalid request parameters
401 Unauthorized Authentication required
403 Forbidden Insufficient permissions
404 Not Found Resource not found
429 Too Many Requests Rate limit exceeded
500 Internal Server Error Server error occurred

Support

For API support and questions:

Next Steps

Explore the detailed API documentation for each module: