@iblai/iblai-api 4.14.2-loadtest-core → 4.14.2-loadtest-ai

package/dist/types/services/AnalyticsService.d.ts

@@ -0,0 +1,488 @@
+import type { AccessTimesHeatmap } from '../models/AccessTimesHeatmap';
+import type { BaseFinanceResponse } from '../models/BaseFinanceResponse';
+import type { CurrentUsersResponse } from '../models/CurrentUsersResponse';
+import type { FinanceDetailsResponse } from '../models/FinanceDetailsResponse';
+import type { InvoiceReportResponse } from '../models/InvoiceReportResponse';
+import type { UserDetail } from '../models/UserDetail';
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class AnalyticsService {
+    /**
+     * Financial Analytics API - Get comprehensive cost metrics with comparison analysis.
+     *
+     * This endpoint provides period-based cost analysis (not cumulative) with support for:
+     * - Multiple time granularities and metrics
+     * - Cross-dimensional filtering
+     * - Percentage change vs comparison periods
+     * - Forward-filled time series
+     *
+     * **Examples:**
+     *
+     * **Basic Weekly Costs:**
+     * ```
+     * GET /api/v2/analytics/financial/?metric=weekly_costs&comparison_days=10
+     * ```
+     *
+     * **Platform & Mentor Filtered:**
+     * ```
+     * # Get total costs for a specific platform and mentor
+     * GET /api/v2/analytics/financial/?metric=total_costs&platform_key=web-app&mentor_unique_id=mentor-123&comparison_days=14
+     * ```
+     *
+     * **Monthly Costs by Provider:**
+     * ```
+     * GET /api/v2/analytics/financial/?metric=monthly_costs&provider=openai&granularity=month&comparison_days=30
+     * ```
+     *
+     * **Daily Costs for Specific User:**
+     * ```
+     * GET /api/v2/analytics/financial/?metric=total_costs&username=user-456&granularity=day&start_date=2025-01-15&end_date=2025-01-21&comparison_days=7
+     * ```
+     *
+     *
+     * **Response Structure:**
+     * ```json
+     * {
+         * "metric": "weekly_costs",
+         * "value": 12.47,
+         * "percentage_change": 8.5,
+         * "overtime": [
+             * {"date": "2025-01-06", "value": 2.89},
+             * {"date": "2025-01-13", "value": 3.12}
+             * ],
+             * "period_info": {
+                 * "start_date": "2025-01-01",
+                 * "end_date": "2025-01-31",
+                 * "period_days": 31
+                 * },
+                 * "comparison_info": {
+                     * "previous_period_value": 11.50,
+                     * ...
+                     * }
+                     * }
+                     * ```
+                     * @returns BaseFinanceResponse Successful financial metrics response with period-based cost data
+                     * @throws ApiError
+                     */
+    static analyticsFinancialRetrieve({ metric, allTime, comparisonDays, endDate, fillMethod, granularity, llmModel, mentorUniqueId, platformKey, provider, showOvertime, startDate, username, }: {
+        /**
+         * Type of financial metric to retrieve
+         *
+         * * `total_costs` - Total costs for selected timeframe
+         * * `weekly_costs` - Costs for current/selected week
+         * * `monthly_costs` - Costs for current/selected month
+         */
+        metric: 'total_costs' | 'weekly_costs' | 'monthly_costs';
+        /**
+         * calculate from platform inception (ignores date filters)
+         */
+        allTime?: boolean;
+        /**
+         * Number of days for comparison period to calculate percentage change (e.g., 10 for 10-day comparison)
+         */
+        comparisonDays?: number;
+        /**
+         * End date for analysis (YYYY-MM-DD). Defaults to today.
+         */
+        endDate?: string;
+        /**
+         * Method for filling missing time periods in overtime data
+         *
+         * * `zero` - Fill missing periods with zero
+         * * `previous` - Fill missing periods with previous value
+         */
+        fillMethod?: 'zero' | 'previous';
+        /**
+         * Time granularity for overtime series data
+         *
+         * * `day` - Daily data points
+         * * `week` - Weekly data points
+         * * `month` - Monthly data points
+         */
+        granularity?: 'day' | 'week' | 'month';
+        /**
+         * Filter by specific LLM model (e.g., gpt-4o, claude-3-5-sonnet)
+         */
+        llmModel?: string;
+        /**
+         * Filter by specific mentor unique ID
+         */
+        mentorUniqueId?: string;
+        /**
+         * Filter by specific platform key
+         */
+        platformKey?: string;
+        /**
+         * Filter by AI provider
+         *
+         * * `openai` - OpenAI
+         * * `anthropic` - Anthropic
+         * * `azure` - Azure
+         * * `google` - Google
+         * * `meta` - Meta
+         * * `other` - Other
+         */
+        provider?: 'openai' | 'anthropic' | 'azure' | 'google' | 'meta' | 'other';
+        /**
+         * Whether to include overtime series data in response
+         */
+        showOvertime?: boolean;
+        /**
+         * Start date for analysis (YYYY-MM-DD). Defaults to 30 days ago.
+         */
+        startDate?: string;
+        /**
+         * Filter by specific username - returns costs for this user only
+         */
+        username?: string;
+    }): CancelablePromise<BaseFinanceResponse>;
+    /**
+     * Financial Details Analytics API – paginated cost tables with flexible grouping.
+     *
+     * This endpoint returns tabular cost metrics aggregated by the dimension
+     * specified via the `group_by` query parameter.  One or more KPI columns
+     * can be requested through the comma-separated `metrics` list while
+     * typical filters (date range, provider, platform_key, user, etc.) narrow the
+     * dataset.  Results are paginated with `page` / `limit`.
+     *
+     * **Required query parameters**
+     * - group_by – provider | llm_model | username | mentor | platform
+     * - metrics – csv list of KPI names, e.g. total_cost, sessions
+     *
+     * **Shared optional filters**
+     * - start_date, end_date   – ISO yyyy-mm-dd (ignored when all_time=true)
+     * - platform_key           – tenant isolation
+     * - mentor_unique_id       – filter to one mentor
+     * - username               – filter to a learner
+     * - provider / llm_model   – filter to LLM provider / model
+     * - all_time               – true → lifetime totals
+     * - page (default 1), limit (default 50)
+     *
+     * **Examples**
+     * --------
+     * 1. Cost by provider for the last week
+     * ```
+     * GET /api/v2/analytics/financial/details?
+     * group_by=provider&
+     * metrics=total_cost&
+     * start_date=2025-01-01&
+     * end_date=2025-01-07&
+     * page=1&limit=10
+     * ```
+     *
+     * 2. Lifetime cost per user with extra KPIs
+     * ```
+     * GET /api/v2/analytics/financial/details?
+     * group_by=username&
+     * metrics=total_cost,sessions&
+     * all_time=true&page=1&limit=50
+     * ```
+     * 3. Cost by LLM model with tenant filter
+     * ```
+     * GET /api/v2/analytics/financial/details?
+     * group_by=llm_model&
+     * metrics=total_cost&
+     * platform_key=web-app&
+     * start_date=2025-01-01&end_date=2025-01-31
+     * ```
+     * Response structure
+     * -------------------
+     * ```
+     * {
+         * "page": 1,
+         * "limit": 10,
+         * "total_pages": 1,
+         * "total_records": 3,
+         * "rows": [
+             * {"provider": "openai", "total_cost": 2.5},
+             * {"provider": "anthropic", "total_cost": 1.0},
+             * {"provider": "azure",    "total_cost": 0.5}
+             * ],
+             * "metrics": [
+                 * {
+                     * "name": "total_cost",
+                     * "unit": "$",
+                     * "description": "Cost for this entity in period"
+                     * }
+                     * ],
+                     * "total_cost": 4.0   // optional grand-total when available
+                     * }
+                     * ``
+                     * @returns FinanceDetailsResponse
+                     * @throws ApiError
+                     */
+    static analyticsFinancialDetailsRetrieve({ groupBy, allTime, endDate, limit, llmModel, mentorUniqueId, metrics, page, platformKey, provider, startDate, username, }: {
+        /**
+         * Dimension to group by
+         *
+         * * `provider` - Group by provider
+         * * `llm_model` - Group by LLM model
+         * * `username` - Group by username
+         * * `mentor` - Group by mentor
+         * * `platform` - Group by platform
+         * * `action` - Group by actions
+         */
+        groupBy: 'provider' | 'llm_model' | 'username' | 'mentor' | 'platform' | 'action';
+        allTime?: boolean;
+        endDate?: string;
+        limit?: number;
+        llmModel?: string;
+        mentorUniqueId?: string;
+        /**
+         * Comma-separated list of metrics (e.g. total_cost,sessions, last_active)
+         */
+        metrics?: string;
+        page?: number;
+        platformKey?: string;
+        provider?: string;
+        startDate?: string;
+        username?: string;
+    }): CancelablePromise<FinanceDetailsResponse>;
+    /**
+     * Flexible Invoice Report API – Billing summary with username and platform filtering.
+     *
+     * This endpoint generates invoice reports with flexible filtering options:
+     * - Platform admins can view their platform's data and filter by username within their platform
+     * - Super admins can view any combination of username/platform or global summaries
+     *
+     * **Key Features:**
+     * - Flexible filtering by username and/or platform_key
+     * - Essential metrics: total cost, sessions, usage period
+     * - Provider breakdown (OpenAI, Anthropic, etc.)
+     * - Top mentors/actions by cost
+     * - Clean, invoice-ready format
+     *
+     * **Query Parameters:**
+     * - username: Filter by specific username (optional)
+     * - platform_key: Filter by platform (optional, but required for platform admins)
+     * - start_date, end_date: billing period (defaults to last 30 days)
+     * - include_breakdown: show provider/mentor details (default: true)
+     *
+     * **Permission Logic:**
+     * - Platform admins: Must include platform_key matching their permission scope
+     * - Super admins: Can use any combination of filters or none (global summary)
+     *
+     * **Examples:**
+     * ```
+     * # Platform admin viewing their platform
+     * GET /api/analytics/financial/invoice?platform_key=web-app
+     *
+     * # Platform admin viewing specific user in their platform
+     * GET /api/analytics/financial/invoice?platform_key=web-app&username=john.doe
+     *
+     * # Super admin viewing specific user across all platforms
+     * GET /api/analytics/financial/invoice?username=john.doe
+     *
+     * # Super admin viewing global summary
+     * GET /api/analytics/financial/invoice
+     * ```
+     *
+     * **Response Structure:**
+     * ```json
+     * {
+         * "entity": {
+             * "type": "user|platform|global",
+             * "username": "john.doe",
+             * "platform_key": "web-app",
+             * "platform_name": "Web Application",
+             * "display_name": "John Doe on Web Application"
+             * },
+             * "billing_period": {
+                 * "start_date": "2025-01-01",
+                 * "end_date": "2025-01-31",
+                 * "days": 31
+                 * },
+                 * "summary": {
+                     * "total_cost": 245.750,
+                     * "total_sessions": 1250,
+                     * "active_users": 85,
+                     * "cost_per_session": 0.196
+                     * },
+                     * "breakdown": {
+                         * "by_provider": [...],
+                         * "by_mentor": [...],
+                         * "by_action": [...]
+                         * }
+                         * }
+                         * ```
+                         * @returns InvoiceReportResponse
+                         * @throws ApiError
+                         */
+    static analyticsFinancialInvoiceRetrieve({ endDate, includeBreakdown, platformKey, startDate, username, }: {
+        /**
+         * End date for billing period (defaults to today)
+         */
+        endDate?: string;
+        /**
+         * Whether to include provider and mentor breakdown
+         */
+        includeBreakdown?: boolean;
+        /**
+         * Platform key to filter by (optional, required for platform admins)
+         */
+        platformKey?: string;
+        /**
+         * Start date for billing period (defaults to 30 days ago)
+         */
+        startDate?: string;
+        /**
+         * Username to generate invoice for (optional)
+         */
+        username?: string;
+    }): CancelablePromise<InvoiceReportResponse>;
+    /**
+     *
+     * Time Analytics API - User activity patterns by time of day and day of week.
+     *
+     * Provides heatmap data showing when users are most active, useful for:
+     * - Understanding peak usage times
+     * - Capacity planning and resource allocation
+     * - User behavior analysis
+     * - Support scheduling optimization
+     *
+     * **Key Features:**
+     * - Day of week patterns (0=Sunday through 6=Saturday)
+     * - Hour of day activity levels (0-23)
+     * - Flexible date range filtering
+     * - Platform and mentor-specific filtering
+     * - Message count aggregation
+     *
+     * **Data Structure:**
+     * - `day_of_week`: 0-6 (Sunday-Saturday)
+     * - `hour`: 0-23 (24-hour format)
+     * - `value`: Message count for that time slot
+     *
+     * @returns AccessTimesHeatmap Access times heatmap data with day/hour patterns
+     * @throws ApiError
+     */
+    static analyticsTimeRetrieve({ dateFilter, endDate, mentorUniqueId, platformKey, startDate, }: {
+        /**
+         * * `today` - Today only
+         * * `yesterday` - Yesterday only
+         * * `7d` - Last 7 days
+         * * `30d` - Last 30 days
+         * * `90d` - Last 90 days
+         * * `custom` - Custom date range
+         */
+        dateFilter?: 'today' | 'yesterday' | '7d' | '30d' | '90d' | 'custom';
+        endDate?: string;
+        /**
+         * Filter by specific mentor unique ID
+         */
+        mentorUniqueId?: string;
+        platformKey?: string;
+        startDate?: string;
+    }): CancelablePromise<AccessTimesHeatmap>;
+    /**
+     *
+     * User Analytics API - Comprehensive user activity metrics and trends.
+     *
+     * Provides real-time and historical user analytics including:
+     * - Currently active users (last hour)
+     * - Active users over time periods (7d, 30d, 90d)
+     * - Registered user counts and growth
+     * - Time series charts with customizable granularity
+     *
+     * **Key Features:**
+     * - Real-time active user counting
+     * - Percentage change calculations vs previous periods
+     * - Flexible date filtering and granularity
+     * - Platform and mentor-specific filtering
+     * - Forward-filled time series data
+     *
+     * **Supported Metrics:**
+     * - `currently_active`: Users active in last hour
+     * - `active_users`: Unique users in specified period
+     * - `registered_users`: Total and new user counts
+     *
+     * @returns CurrentUsersResponse User analytics metrics with comparison data
+     * @throws ApiError
+     */
+    static analyticsUsersRetrieve({ metric, dateFilter, endDate, granularity, mentorUniqueId, platformKey, startDate, }: {
+        /**
+         * * `currently_active` - Users logged in right now
+         * * `active_users` - Active users in a period
+         * * `registered_users` - Registered users
+         * * `active_users_last_30d` - Active users in the last 30 days
+         */
+        metric: 'currently_active' | 'active_users' | 'registered_users' | 'active_users_last_30d';
+        /**
+         * * `today` - Today only
+         * * `7d` - Last 7 days
+         * * `30d` - Last 30 days
+         * * `90d` - Last 90 days
+         * * `custom` - Custom date range
+         */
+        dateFilter?: 'today' | '7d' | '30d' | '90d' | 'custom';
+        endDate?: string;
+        /**
+         * * `hour` - hour
+         * * `day` - day
+         * * `week` - week
+         * * `month` - month
+         */
+        granularity?: 'hour' | 'day' | 'week' | 'month';
+        /**
+         * Filter by specific mentor unique ID
+         */
+        mentorUniqueId?: string;
+        platformKey?: string;
+        startDate?: string;
+    }): CancelablePromise<CurrentUsersResponse>;
+    /**
+     *
+     * User Details API - Comprehensive user activity details with search and filtering.
+     *
+     * Provides detailed user information including:
+     * - User contact information (email, full name)
+     * - Activity metrics (message count, last activity)
+     * - Search functionality across multiple fields
+     * - Flexible date range filtering
+     * - CSV export capability
+     *
+     * **Key Features:**
+     * - Full-text search across email, name, and user ID
+     * - Date range filtering for activity periods
+     * - Platform and mentor-specific filtering
+     * - Comprehensive pagination with metadata
+     * - CSV export for data analysis
+     * - User aggregation across platforms/mentors
+     *
+     * **Search Capabilities:**
+     * - Email address matching
+     * - Full name search
+     * - User ID lookup
+     * - Partial string matching (case-insensitive)
+     *
+     * **Export Options:**
+     * - JSON response (default)
+     * - CSV export (?export=csv)
+     * - Includes all user fields in export
+     *
+     * @returns UserDetail Paginated user details with activity metrics
+     * @throws ApiError
+     */
+    static analyticsUsersDetailsRetrieve({ dateFilter, endDate, limit, mentorUniqueId, page, platformKey, search, startDate, }: {
+        /**
+         * * `today` - Today only
+         * * `7d` - Last 7 days
+         * * `30d` - Last 30 days
+         * * `90d` - Last 90 days
+         * * `all_time` - All time
+         * * `custom` - Custom date range
+         */
+        dateFilter?: 'today' | '7d' | '30d' | '90d' | 'all_time' | 'custom';
+        endDate?: string;
+        limit?: number;
+        /**
+         * Filter by specific mentor unique ID
+         */
+        mentorUniqueId?: string;
+        page?: number;
+        platformKey?: string;
+        /**
+         * Search by email, full name, or user ID
+         */
+        search?: string;
+        startDate?: string;
+    }): CancelablePromise<UserDetail>;
+}