LogoLogo
1.1.0
1.1.0
  • Maisa System
    • Introduction
    • API Reference
      • Maisa System API Documentation
        • Authentication
      • Users
      • Projects
      • Analytics
      • System
      • Models
    • Architecture
    • How to use it
  • Helm Installation
    • Getting Started
    • Authentication
    • Configuration Reference
Powered by GitBook
On this page
Export as PDF
  1. Maisa System
  2. API Reference

Analytics

PreviousProjectsNextSystem

Analytics data operations

Get analytics dashboard

get

Retrieves analytics dashboard data.

Available time periods:

  • today

  • yesterday

  • this_week

  • last_week

  • this_month

  • last_month

  • this_quarter

  • last_quarter

  • this_year

  • last_year

  • custom (requires startDate and endDate parameters)

Available metrics:

  • users - User count and growth

  • projects - Project count and status distribution

  • usage - System resource usage

  • performance - System performance metrics

Authorizations
Query parameters
periodstring · enumOptional

Time period for analytics

Default: this_monthPossible values:
startDatestring · dateOptional

Start date for custom period (ISO 8601 format)

endDatestring · dateOptional

End date for custom period (ISO 8601 format)

Responses
200
Analytics dashboard data
application/json
400
Bad request
application/json
401
Unauthorized
application/json
403
Forbidden
application/json
get
GET /v1/analytics/dashboard HTTP/1.1
Host: api.maisa.com
X-API-Key: YOUR_API_KEY
Accept: */*
{
  "data": {
    "period": {
      "type": "today",
      "startDate": "2025-06-01",
      "endDate": "2025-06-01"
    },
    "metrics": {
      "users": {
        "total": 1,
        "active": 1,
        "growth": 1,
        "byRole": {
          "ANY_ADDITIONAL_PROPERTY": 1
        }
      },
      "projects": {
        "total": 1,
        "byStatus": {
          "ANY_ADDITIONAL_PROPERTY": 1
        },
        "created": 1,
        "archived": 1
      },
      "usage": {
        "storage": {
          "total": 1,
          "used": 1,
          "unit": "text"
        },
        "api": {
          "calls": 1,
          "avgResponseTime": 1
        }
      },
      "performance": {
        "uptime": 1,
        "responseTime": {
          "avg": 1,
          "p95": 1,
          "p99": 1
        },
        "errors": 1
      }
    }
  }
}