Class: AnalyticsService

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/analytics.ts:54

Extends

• BaseService

Constructors

Constructor

new AnalyticsService(client): AnalyticsService

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/base.ts:12

Parameters

client

TanqoryClient

Returns

AnalyticsService

Inherited from

BaseService.constructor

Properties

client

protected client: TanqoryClient

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/base.ts:10

Inherited from

BaseService.client

Methods

aiAlerts()

aiAlerts(storeId): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/analytics.ts:313

Get AI anomaly alerts

Parameters

storeId

string

Returns

Promise<any>

---

aiInsights()

aiInsights(storeId): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/analytics.ts:308

Get AI-generated insights

Parameters

storeId

string

Returns

Promise<any>

---

aiQuery()

aiQuery(storeId, data): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/analytics.ts:293

Run an AI-powered natural language query

Parameters

storeId

string

data

query

string

Returns

Promise<any>

---

aiSimilarQueries()

aiSimilarQueries(storeId, params?): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/analytics.ts:303

Get similar queries (based on history)

Parameters

storeId

string

params?

query?

string

Returns

Promise<any>

---

aiSuggestions()

aiSuggestions(storeId): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/analytics.ts:298

Get AI query suggestions

Parameters

storeId

string

Returns

Promise<any>

---

buildQuery()

protected buildQuery(options?): Record<string, any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/base.ts:26

Build query parameters

Parameters

options?

ListOptions

Returns

Record<string, any>

Inherited from

BaseService.buildQuery

---

convertCurrency()

convertCurrency(storeId, data): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/analytics.ts:213

Convert an amount between currencies

Parameters

storeId

string

data

amount

number

from

string

to

string

Returns

Promise<any>

---

createCustomReport()

createCustomReport(storeId, data): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/analytics.ts:159

Create a custom report

Parameters

storeId

string

data

any

Returns

Promise<any>

---

deleteCustomReport()

deleteCustomReport(storeId, reportId): Promise<void>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/analytics.ts:186

Delete a custom report

Parameters

storeId

string

reportId

string

Returns

Promise<void>

---

duplicateCustomReport()

duplicateCustomReport(storeId, reportId): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/analytics.ts:196

Duplicate a custom report

Parameters

storeId

string

reportId

string

Returns

Promise<any>

---

executeCustomReport()

executeCustomReport(storeId, reportId): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/analytics.ts:191

Execute a custom report and get results

Parameters

storeId

string

reportId

string

Returns

Promise<any>

---

exportQuery()

exportQuery(storeId, request): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/analytics.ts:87

Export query results

Parameters

storeId

string

request

object & object

Returns

Promise<any>

---

generateIdempotencyKey()

protected generateIdempotencyKey(prefix): string

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/base.ts:19

Generate idempotency key

Parameters

prefix

string

Returns

string

Inherited from

BaseService.generateIdempotencyKey

---

getAvailableFields()

getAvailableFields(storeId, params): Promise<{ availableDimensions: object[]; availableMetrics: object[]; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/analytics.ts:72

Get available fields for a query

Parameters

storeId

string

params

tables?

string[]

Returns

Promise<{ availableDimensions: object[]; availableMetrics: object[]; }>

---

getCacheStats()

getCacheStats(storeId): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/analytics.ts:95

Get query cache statistics

Parameters

storeId

string

Returns

Promise<any>

---

getChannelPerformance()

getChannelPerformance(storeId, params?): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/analytics.ts:260

Get channel performance

Parameters

storeId

string

params?

dateFrom?

string

dateTo?

string

Returns

Promise<any>

---

getCohortAnalysis()

getCohortAnalysis(storeId, params): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/analytics.ts:272

Run cohort analysis

Parameters

storeId

string

params

any

Returns

Promise<any>

---

getCohortRetention()

getCohortRetention(storeId, params?): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/analytics.ts:277

Get cohort retention data

Parameters

storeId

string

params?

any

Returns

Promise<any>

---

getCurrencies()

getCurrencies(storeId): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/analytics.ts:203

Get supported currencies

Parameters

storeId

string

Returns

Promise<any>

---

getCustomerJourney()

getCustomerJourney(storeId, params?): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/analytics.ts:228

Get customer journey attribution

Parameters

storeId

string

params?

customerId?

string

Returns

Promise<any>

---

getCustomReport()

getCustomReport(storeId, reportId): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/analytics.ts:174

Get a specific custom report

Parameters

storeId

string

reportId

string

Returns

Promise<any>

---

getCustomReportMetadata()

getCustomReportMetadata(storeId): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/analytics.ts:149

Get custom report metadata (available fields, dimensions)

Parameters

storeId

string

Returns

Promise<any>

---

getDashboard()

getDashboard(storeId, params?): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/analytics.ts:107

Get analytics dashboard data

Parameters

storeId

string

params?

dateFrom?

string

dateTo?

string

Returns

Promise<any>

---

getExchangeRate()

getExchangeRate(storeId, params): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/analytics.ts:208

Get exchange rate between two currencies

Parameters

storeId

string

params

from

string

to

string

Returns

Promise<any>

---

getExportMimeType()

protected getExportMimeType(format): string

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/base.ts:45

Get MIME type for export format

Parameters

format

string

Returns

string

Inherited from

BaseService.getExportMimeType

---

getLiveView()

getLiveView(storeId): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/analytics.ts:115

Get live view data (real-time visitors)

Parameters

storeId

string

Returns

Promise<any>

---

getMultiTouchAttribution()

getMultiTouchAttribution(storeId, orderId): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/analytics.ts:235

Get multi-touch attribution for an order

Parameters

storeId

string

orderId

string

Returns

Promise<any>

---

getOrderAttribution()

getOrderAttribution(storeId, orderId): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/analytics.ts:223

Get order attribution data

Parameters

storeId

string

orderId

string

Returns

Promise<any>

---

getProductsBoughtTogether()

getProductsBoughtTogether(storeId, params?): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/analytics.ts:284

Get products frequently bought together

Parameters

storeId

string

params?

productId?

string

Returns

Promise<any>

---

getQueryMetadata()

getQueryMetadata(storeId): Promise<{ compatibility: { dimensionMetricMatrix: Record<string, string[]>; metricDimensionMatrix: Record<string, string[]>; }; datasets: object[]; dimensionsByCategory: Record<string, object[]>; metricsByCategory: Record<string, object[]>; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/analytics.ts:67

Get query metadata (available tables, columns, etc.)

Parameters

storeId

string

Returns

Promise<{ compatibility: { dimensionMetricMatrix: Record<string, string[]>; metricDimensionMatrix: Record<string, string[]>; }; datasets: object[]; dimensionsByCategory: Record<string, object[]>; metricsByCategory: Record<string, object[]>; }>

---

getReport()

getReport(storeId, reportId): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/analytics.ts:137

Get a specific saved report

Parameters

storeId

string

reportId

string

Returns

Promise<any>

---

getReportCategories()

getReportCategories(storeId): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/analytics.ts:142

Get report categories

Parameters

storeId

string

Returns

Promise<any>

---

getReportCounts()

getReportCounts(storeId): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/analytics.ts:127

Get report counts per category

Parameters

storeId

string

Returns

Promise<any>

---

getSalesByCampaign()

getSalesByCampaign(storeId, params?): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/analytics.ts:250

Get sales by campaign

Parameters

storeId

string

params?

dateFrom?

string

dateTo?

string

Returns

Promise<any>

---

getSalesBySource()

getSalesBySource(storeId, params?): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/analytics.ts:240

Get sales by traffic source

Parameters

storeId

string

params?

dateFrom?

string

dateTo?

string

Returns

Promise<any>

---

invalidateCache()

invalidateCache(storeId): Promise<void>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/analytics.ts:100

Invalidate query cache

Parameters

storeId

string

Returns

Promise<void>

---

listCustomReports()

listCustomReports(storeId): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/analytics.ts:154

List custom reports

Parameters

storeId

string

Returns

Promise<any>

---

listReports()

listReports(storeId): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/analytics.ts:132

List saved reports

Parameters

storeId

string

Returns

Promise<any>

---

previewCustomReport()

previewCustomReport(storeId, config): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/analytics.ts:167

Preview a custom report without saving

Parameters

storeId

string

config

any

Returns

Promise<any>

---

query()

query(storeId, request): Promise<{ comparisonData?: Record<string, string | number | boolean>[]; data: Record<string, string | number | boolean>[]; meta: { columns: object[]; currency?: { convertedRows: number; displayCurrency: string; unconvertedRows: number; usedCurrentRates: boolean; }; executionTime: number; query: { comparison?: { enabled: boolean; type: "previous_period" | "previous_year"; }; dataset: "inventory" | "sales" | "products" | "customers" | "sessions" | "behavior" | "fraud" | "marketing" | "orders" | "performance" | "payments" | "payouts" | "order_edits" | "inventory_movements" | "giftcards" | "finance" | "store_activity" | "profitability"; dateRange: { endDate?: string; preset?: string; startDate?: string; }; dimensions?: string[]; filters?: object[]; limit: number; metrics: object[]; offset: number; options?: { currency?: string; displayCurrency?: string; includeNulls: boolean; storeCurrency?: string; timezone?: string; }; sort?: object[]; }; totalRows: number; truncated: boolean; }; summary?: Record<string, number>; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/analytics.ts:62

Execute a TanqoryQL query

Parameters

storeId

string

request

comparison?

{ enabled: boolean; type: "previous_period" | "previous_year"; }

comparison.enabled

boolean

comparison.type

"previous_period" | "previous_year"

dataset

"inventory" | "sales" | "products" | "customers" | "sessions" | "behavior" | "fraud" | "marketing" | "orders" | "performance" | "payments" | "payouts" | "order_edits" | "inventory_movements" | "giftcards" | "finance" | "store_activity" | "profitability"

dateRange

{ endDate?: string; preset?: string; startDate?: string; }

dateRange.endDate?

string

dateRange.preset?

string

dateRange.startDate?

string

dimensions?

string[]

filters?

object[]

limit

number

metrics

object[]

offset

number

options?

{ currency?: string; displayCurrency?: string; includeNulls: boolean; storeCurrency?: string; timezone?: string; }

options.currency?

string

options.displayCurrency?

string

options.includeNulls

boolean

options.storeCurrency?

string

options.timezone?

string

sort?

object[]

Returns

Promise<{ comparisonData?: Record<string, string | number | boolean>[]; data: Record<string, string | number | boolean>[]; meta: { columns: object[]; currency?: { convertedRows: number; displayCurrency: string; unconvertedRows: number; usedCurrentRates: boolean; }; executionTime: number; query: { comparison?: { enabled: boolean; type: "previous_period" | "previous_year"; }; dataset: "inventory" | "sales" | "products" | "customers" | "sessions" | "behavior" | "fraud" | "marketing" | "orders" | "performance" | "payments" | "payouts" | "order_edits" | "inventory_movements" | "giftcards" | "finance" | "store_activity" | "profitability"; dateRange: { endDate?: string; preset?: string; startDate?: string; }; dimensions?: string[]; filters?: object[]; limit: number; metrics: object[]; offset: number; options?: { currency?: string; displayCurrency?: string; includeNulls: boolean; storeCurrency?: string; timezone?: string; }; sort?: object[]; }; totalRows: number; truncated: boolean; }; summary?: Record<string, number>; }>

---

runAnomalyDetection()

runAnomalyDetection(storeId): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/analytics.ts:318

Run anomaly detection

Parameters

storeId

string

Returns

Promise<any>

---

testConnection()

testConnection(storeId): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/analytics.ts:120

Test analytics database connection

Parameters

storeId

string

Returns

Promise<any>

---

updateCustomReport()

updateCustomReport(storeId, reportId, data): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/analytics.ts:179

Update a custom report

Parameters

storeId

string

reportId

string

data

any

Returns

Promise<any>

---

validateQuery()

validateQuery(storeId, request): Promise<{ availableDimensions: string[]; availableMetrics: string[]; disabledDimensions: object[]; disabledMetrics: object[]; errors: object[]; valid: boolean; warnings: object[]; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/analytics.ts:82

Validate a query without executing

Parameters

storeId

string

request

comparison?

{ enabled: boolean; type: "previous_period" | "previous_year"; }

comparison.enabled

boolean

comparison.type

"previous_period" | "previous_year"

dataset

"inventory" | "sales" | "products" | "customers" | "sessions" | "behavior" | "fraud" | "marketing" | "orders" | "performance" | "payments" | "payouts" | "order_edits" | "inventory_movements" | "giftcards" | "finance" | "store_activity" | "profitability"

dateRange

{ endDate?: string; preset?: string; startDate?: string; }

dateRange.endDate?

string

dateRange.preset?

string

dateRange.startDate?

string

dimensions?

string[]

filters?

object[]

limit

number

metrics

object[]

offset

number

options?

{ currency?: string; displayCurrency?: string; includeNulls: boolean; storeCurrency?: string; timezone?: string; }

options.currency?

string

options.displayCurrency?

string

options.includeNulls

boolean

options.storeCurrency?

string

options.timezone?

string

sort?

object[]

Returns

Promise<{ availableDimensions: string[]; availableMetrics: string[]; disabledDimensions: object[]; disabledMetrics: object[]; errors: object[]; valid: boolean; warnings: object[]; }>