ObjectStackObjectStack

Analytics

Analytics protocol schemas

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

PropertyTypeRequiredDescription
successboolean✅Operation success status
errorObjectoptionalError details if success is false
metaObjectoptionalResponse metadata
dataObject✅

AnalyticsQueryRequest

Properties

PropertyTypeRequiredDescription
queryObject✅The analytic query definition
cubestring✅Target cube name
formatEnum<'json' | 'csv' | 'xlsx'>✅Response format

AnalyticsResultResponse

Properties

PropertyTypeRequiredDescription
successboolean✅Operation success status
errorObjectoptionalError details if success is false
metaObjectoptionalResponse metadata
dataObject✅

AnalyticsSqlResponse

Properties

PropertyTypeRequiredDescription
successboolean✅Operation success status
errorObjectoptionalError details if success is false
metaObjectoptionalResponse metadata
dataObject✅

GetAnalyticsMetaRequest

Properties

PropertyTypeRequiredDescription
cubestringoptionalOptional cube name to filter

On this page

TypeScript UsageAnalyticsEndpointAllowed ValuesAnalyticsMetadataResponsePropertiesAnalyticsQueryRequestPropertiesAnalyticsResultResponsePropertiesAnalyticsSqlResponsePropertiesGetAnalyticsMetaRequestProperties