getEventOverviewWithHttpInfo method

Future<Response> getEventOverviewWithHttpInfo({ String? range, String? start, String? end, })

Overview returns the caller org's analytics KPIs for one time window.

Overview returns the caller org's analytics KPIs for one time window. Three lenses over one warehouse: llm is the live per-org LLM usage ledger (requests, tokens, spend, models, providers, errors) and is always real; web (pageviews, visitors, sessions) and commerce (orders, revenue, AOV) read the product-event table and report available=false rather than fabricating zeros when it holds nothing yet. The org is the validated principal's — never a parameter — so a caller can only ever read its own tenant. 403 without a validated bearer, 400 on an unknown range, 503 when the warehouse is unreachable.

Note: This method returns the HTTP Response.

Parameters:

• String range: Range is a relative window: a count and a unit — 24h, 7d, 90d, any

• String start: Start is the inclusive lower bound of a custom window, RFC3339. Requires end.

• String end: End is the exclusive upper bound of a custom window, RFC3339. Requires start.

Implementation

Future<Response> getEventOverviewWithHttpInfo({ String? range, String? start, String? end, }) async {
  // ignore: prefer_const_declarations
  final path = r'/v1/event/overview';

  // ignore: prefer_final_locals
  Object? postBody;

  final queryParams = <QueryParam>[];
  final headerParams = <String, String>{};
  final formParams = <String, String>{};

  if (range != null) {
    queryParams.addAll(_queryParams('', 'range', range));
  }
  if (start != null) {
    queryParams.addAll(_queryParams('', 'start', start));
  }
  if (end != null) {
    queryParams.addAll(_queryParams('', 'end', end));
  }

  const contentTypes = <String>[];


  return apiClient.invokeAPI(
    path,
    'GET',
    queryParams,
    postBody,
    headerParams,
    formParams,
    contentTypes.isEmpty ? null : contentTypes.first,
  );
}