Class: CustomerEventsService

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/customer-events.ts:23

Extends

• BaseService

Constructors

Constructor

new CustomerEventsService(client): CustomerEventsService

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

Parameters

client

TanqoryClient

Returns

CustomerEventsService

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

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

---

deleteEvent()

deleteEvent(storeId, eventId): Promise<DeletedResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/customer-events.ts:102

Delete an event

Parameters

storeId

string

eventId

string

Returns

Promise<DeletedResponse>

---

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

---

getCustomerEvents()

getCustomerEvents(storeId, customerId, params?): Promise<{ data: object[]; limit: number; page: number; total: number; total_pages: number; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/customer-events.ts:63

Get events for a specific customer

Parameters

storeId

string

customerId

string

params?

endDate?

string

eventName?

string

eventType?

"order_cancelled" | "order_updated" | "order_fulfilled" | "order_edited" | "order_placed" | "page_viewed" | "product_viewed" | "collection_viewed" | "search_performed" | "product_added_to_cart" | "product_removed_from_cart" | "cart_viewed" | "checkout_started" | "checkout_completed" | "checkout_abandoned" | "order_refunded" | "order_returned" | "order_exchanged" | "email_received" | "email_opened" | "email_clicked" | "email_bounced" | "email_unsubscribed" | "sms_received" | "sms_clicked" | "coupon_used" | "loyalty_points_earned" | "loyalty_points_redeemed" | "referral_made" | "custom_event"

limit?

number

page?

number

startDate?

string

Returns

Promise<{ data: object[]; limit: number; page: number; total: number; total_pages: number; }>

---

getCustomerJourney()

getCustomerJourney(storeId, customerId, params?): Promise<{ customerId: string; sessions: object[]; totalEvents: number; }>

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

Get customer journey (chronological event sequence)

Parameters

storeId

string

customerId

string

params?

limit?

number

sessionId?

string

Returns

Promise<{ customerId: string; sessions: object[]; totalEvents: number; }>

---

getEventCountsByType()

getEventCountsByType(storeId, params?): Promise<{ data: object[]; endDate?: Date; startDate?: Date; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/customer-events.ts:116

Get event counts grouped by type

Parameters

storeId

string

params?

endDate?

string

startDate?

string

Returns

Promise<{ data: object[]; endDate?: Date; startDate?: Date; }>

---

getEventCountsOverTime()

getEventCountsOverTime(storeId, params?): Promise<{ data: object[]; endDate: Date; eventName?: string; granularity: string; startDate: Date; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/customer-events.ts:130

Get event counts over time

Parameters

storeId

string

params?

endDate?

string

eventName?

string

granularity?

string

startDate?

string

Returns

Promise<{ data: object[]; endDate: Date; eventName?: string; granularity: string; startDate: Date; }>

---

getEventNames()

getEventNames(storeId): Promise<{ eventNames: object[]; standardTypes: string[]; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/customer-events.ts:144

Get unique event names

Parameters

storeId

string

Returns

Promise<{ eventNames: object[]; standardTypes: string[]; }>

---

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

---

getFunnelAnalysis()

getFunnelAnalysis(storeId, data): Promise<{ endDate?: Date; funnel: object[]; startDate?: Date; steps: string[]; totalConversion: number; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/customer-events.ts:169

Get funnel analysis

Parameters

storeId

string

data

endDate?

string

startDate?

string

steps

string[]

Returns

Promise<{ endDate?: Date; funnel: object[]; startDate?: Date; steps: string[]; totalConversion: number; }>

---

listStoreEvents()

listStoreEvents(storeId, params?): Promise<{ data: object[]; limit: number; page: number; total: number; total_pages: number; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/customer-events.ts:78

List all events for a store (with filtering)

Parameters

storeId

string

params?

endDate?

string

eventName?

string

eventType?

"order_cancelled" | "order_updated" | "order_fulfilled" | "order_edited" | "order_placed" | "page_viewed" | "product_viewed" | "collection_viewed" | "search_performed" | "product_added_to_cart" | "product_removed_from_cart" | "cart_viewed" | "checkout_started" | "checkout_completed" | "checkout_abandoned" | "order_refunded" | "order_returned" | "order_exchanged" | "email_received" | "email_opened" | "email_clicked" | "email_bounced" | "email_unsubscribed" | "sms_received" | "sms_clicked" | "coupon_used" | "loyalty_points_earned" | "loyalty_points_redeemed" | "referral_made" | "custom_event"

limit?

number

page?

number

startDate?

string

Returns

Promise<{ data: object[]; limit: number; page: number; total: number; total_pages: number; }>

---

retrieveEvent()

retrieveEvent(storeId, eventId): Promise<{ customerId: string; deviceType?: string; eventName: string; eventType: "order_cancelled" | "order_updated" | "order_fulfilled" | "order_edited" | "order_placed" | "page_viewed" | "product_viewed" | "collection_viewed" | "search_performed" | "product_added_to_cart" | "product_removed_from_cart" | "cart_viewed" | "checkout_started" | "checkout_completed" | "checkout_abandoned" | "order_refunded" | "order_returned" | "order_exchanged" | "email_received" | "email_opened" | "email_clicked" | "email_bounced" | "email_unsubscribed" | "sms_received" | "sms_clicked" | "coupon_used" | "loyalty_points_earned" | "loyalty_points_redeemed" | "referral_made" | "custom_event"; id: string; properties?: Record<string, unknown>; sessionId?: string; source?: string; timestamp: Date; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/customer-events.ts:92

Get a single event by ID

Parameters

storeId

string

eventId

string

Returns

Promise<{ customerId: string; deviceType?: string; eventName: string; eventType: "order_cancelled" | "order_updated" | "order_fulfilled" | "order_edited" | "order_placed" | "page_viewed" | "product_viewed" | "collection_viewed" | "search_performed" | "product_added_to_cart" | "product_removed_from_cart" | "cart_viewed" | "checkout_started" | "checkout_completed" | "checkout_abandoned" | "order_refunded" | "order_returned" | "order_exchanged" | "email_received" | "email_opened" | "email_clicked" | "email_bounced" | "email_unsubscribed" | "sms_received" | "sms_clicked" | "coupon_used" | "loyalty_points_earned" | "loyalty_points_redeemed" | "referral_made" | "custom_event"; id: string; properties?: Record<string, unknown>; sessionId?: string; source?: string; timestamp: Date; }>

---

trackCustomerEvent()

trackCustomerEvent(storeId, data): Promise<{ customerId: string; deviceType?: string; eventName: string; eventType: "order_cancelled" | "order_updated" | "order_fulfilled" | "order_edited" | "order_placed" | "page_viewed" | "product_viewed" | "collection_viewed" | "search_performed" | "product_added_to_cart" | "product_removed_from_cart" | "cart_viewed" | "checkout_started" | "checkout_completed" | "checkout_abandoned" | "order_refunded" | "order_returned" | "order_exchanged" | "email_received" | "email_opened" | "email_clicked" | "email_bounced" | "email_unsubscribed" | "sms_received" | "sms_clicked" | "coupon_used" | "loyalty_points_earned" | "loyalty_points_redeemed" | "referral_made" | "custom_event"; id: string; properties?: Record<string, unknown>; sessionId?: string; source?: string; timestamp: Date; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/customer-events.ts:31

Track a single customer event

Parameters

storeId

string

data

customerId

string

deviceType?

string

eventName

string

eventType

"order_cancelled" | "order_updated" | "order_fulfilled" | "order_edited" | "order_placed" | "page_viewed" | "product_viewed" | "collection_viewed" | "search_performed" | "product_added_to_cart" | "product_removed_from_cart" | "cart_viewed" | "checkout_started" | "checkout_completed" | "checkout_abandoned" | "order_refunded" | "order_returned" | "order_exchanged" | "email_received" | "email_opened" | "email_clicked" | "email_bounced" | "email_unsubscribed" | "sms_received" | "sms_clicked" | "coupon_used" | "loyalty_points_earned" | "loyalty_points_redeemed" | "referral_made" | "custom_event"

properties?

Record<string, unknown>

sessionId?

string

source?

string

timestamp?

Date

Returns

Promise<{ customerId: string; deviceType?: string; eventName: string; eventType: "order_cancelled" | "order_updated" | "order_fulfilled" | "order_edited" | "order_placed" | "page_viewed" | "product_viewed" | "collection_viewed" | "search_performed" | "product_added_to_cart" | "product_removed_from_cart" | "cart_viewed" | "checkout_started" | "checkout_completed" | "checkout_abandoned" | "order_refunded" | "order_returned" | "order_exchanged" | "email_received" | "email_opened" | "email_clicked" | "email_bounced" | "email_unsubscribed" | "sms_received" | "sms_clicked" | "coupon_used" | "loyalty_points_earned" | "loyalty_points_redeemed" | "referral_made" | "custom_event"; id: string; properties?: Record<string, unknown>; sessionId?: string; source?: string; timestamp: Date; }>

---

trackEventsBatch()

trackEventsBatch(storeId, events): Promise<{ created_count: number; message: string; }>

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

Track multiple events in batch

Parameters

storeId

string

events

object[]

Returns

Promise<{ created_count: number; message: string; }>