Skip to content

analytics.mdx

Latest commit

 

History

History
106 lines (66 loc) · 3.22 KB

analytics.mdx

File metadata and controls

106 lines (66 loc) · 3.22 KB
Raw
title Analytics
description Analytics protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

Analytics API Protocol

Defines the HTTP interface for the Semantic Layer.

Provides endpoints for executing analytical queries and discovering metadata.

**Source:** `packages/spec/src/api/analytics.zod.ts`

TypeScript Usage

import { AnalyticsEndpoint, AnalyticsMetadataResponse, AnalyticsQueryRequest, AnalyticsResultResponse, AnalyticsSqlResponse, GetAnalyticsMetaRequest } from '@objectstack/spec/api';
import type { AnalyticsEndpoint, AnalyticsMetadataResponse, AnalyticsQueryRequest, AnalyticsResultResponse, AnalyticsSqlResponse, GetAnalyticsMetaRequest } from '@objectstack/spec/api';

// Validate data
const result = AnalyticsEndpoint.parse(data);

AnalyticsEndpoint

Allowed Values

  • /api/v1/analytics/query
  • /api/v1/analytics/meta
  • /api/v1/analytics/sql

AnalyticsMetadataResponse

Properties

Property Type Required Description
success boolean ✅ Operation success status
error { code: string; message: string; category?: string; httpStatus?: integer; … } optional Error details if success is false
meta { timestamp: string; duration?: number; requestId?: string; traceId?: string } optional Response metadata
data { cubes: { name: string; title?: string; description?: string; sql: string; … }[] } ✅

AnalyticsQueryRequest

Properties

Property Type Required Description
query { cube?: string; measures: string[]; dimensions?: string[]; where?: any; … } ✅ The analytic query definition
cube string ✅ Target cube name
format Enum<'json' | 'csv' | 'xlsx'> ✅ Response format

AnalyticsResultResponse

Properties

Property Type Required Description
success boolean ✅ Operation success status
error { code: string; message: string; category?: string; httpStatus?: integer; … } optional Error details if success is false
meta { timestamp: string; duration?: number; requestId?: string; traceId?: string } optional Response metadata
data { rows: Record<string, any>[]; fields: { name: string; type: string }[]; sql?: string } ✅

AnalyticsSqlResponse

Properties

Property Type Required Description
success boolean ✅ Operation success status
error { code: string; message: string; category?: string; httpStatus?: integer; … } optional Error details if success is false
meta { timestamp: string; duration?: number; requestId?: string; traceId?: string } optional Response metadata
data { sql: string; params: any[] } ✅

GetAnalyticsMetaRequest

Properties

Property Type Required Description
cube string optional Optional cube name to filter