@proveanything/smartlinks 1.1.12 → 1.1.13

package/API_SUMMARY.md

@@ -1,6 +1,6 @@
 # Smartlinks API Summary
 
-Version: 1.1.12  |  Generated: 2025-12-28T18:01:35.628Z
+Version: 1.1.13  |  Generated: 2025-12-28T23:26:13.738Z
 
 This is a concise summary of all available API functions and types.
 
@@ -47,6 +47,7 @@ The Smartlinks SDK is organized into the following namespaces:
 
 — Other —
 - **attestation** - Functions for attestation operations
+- **journeysAnalytics** - Functions for journeysAnalytics operations
 - **location** - Functions for location operations
 - **template** - Functions for template operations
 
@@ -601,6 +602,7 @@ interface RecipientWithOutcome {
 interface CommsRecipientIdsQuery {
   broadcastId?: string
   journeyId?: string
+  journeyStepId?: string
   idField?: IdField
   from?: string
   to?: string
@@ -1054,6 +1056,73 @@ interface UpdateJourneyBody {
 }
 ```
 
+### journeysAnalytics
+
+**JourneyStatsRequest** (interface)
+```typescript
+interface JourneyStatsRequest {
+  idField?: IdField // 'userId' | 'contactId'
+  from?: string
+  to?: string
+  finalStepId?: string
+  stepMappings?: Array<{ stepId: string; interactionId?: string; outcome?: string }>
+}
+```
+
+**JourneyStatsResponse** (interface)
+```typescript
+interface JourneyStatsResponse {
+  journeyId: string
+  totalEntered: number
+  currentlyActive?: number
+  completed?: number
+  exitedViaGoal?: number
+  lastUpdated: string
+  stepStats: Array<{ stepId: string; entered: number; completed: number; pending: number }>
+}
+```
+
+**JourneyStepRecipientsRequest** (interface)
+```typescript
+interface JourneyStepRecipientsRequest {
+  status?: 'entered' | 'completed' | 'pending'
+  idField?: IdField
+  interactionId?: string
+  outcome?: string
+  from?: string
+  to?: string
+  limit?: number
+}
+```
+
+**JourneyFunnelReportRequest** (interface)
+```typescript
+interface JourneyFunnelReportRequest {
+  idField?: IdField
+  periodStart?: string
+  periodEnd?: string
+  stepMappings: Array<{ stepId: string; interactionId?: string; outcome?: string }>
+}
+```
+
+**JourneyFunnelReportResponse** (interface)
+```typescript
+interface JourneyFunnelReportResponse {
+  journeyId: string
+  periodStart: string | null
+  periodEnd: string | null
+  steps: Array<{
+  stepId: string
+  enteredCount: number
+  completedCount: number
+  conversionRate: number
+  avgTimeToComplete: number | null
+  }>
+}
+```
+
+**JourneyStepRecipientsResponse** = `string[]`
+
 ### location
 
 **Location** (interface)
@@ -2002,6 +2071,24 @@ Appends one interaction event from a public source.
 **remove**(collectionId: string,
     id: string) → `Promise<void>`
 
+### journeysAnalytics
+
+**stats**(collectionId: string,
+    journeyId: string,
+    body: JourneyStatsRequest = {}) → `Promise<JourneyStatsResponse>`
+POST /admin/collection/:collectionId/journeys.analytics/:journeyId/stats Computes journey stats over a time window; outcome defaults to 'success'. If `finalStepId` is provided, includes `currentlyActive` and `completed` fields.
+
+**recipients**(collectionId: string,
+    journeyId: string,
+    stepId: string,
+    body: JourneyStepRecipientsRequest = {}) → `Promise<JourneyStepRecipientsResponse>`
+POST /admin/collection/:collectionId/journeys.analytics/:journeyId/steps/:stepId/recipients Returns recipient IDs for a given journey step. For completed/pending, `interactionId` is required; outcome defaults to 'success'.
+
+**funnelReport**(collectionId: string,
+    journeyId: string,
+    body: JourneyFunnelReportRequest) → `Promise<JourneyFunnelReportResponse>`
+POST /admin/collection/:collectionId/journeys.analytics/:journeyId/funnel-report Computes conversion, counts, and avg time across mapped steps in a period.
+
 ### location
 
 **createGlobal**(params: LocationPayload) → `Promise<Location>`

package/dist/api/index.d.ts

@@ -19,6 +19,7 @@ export { contact } from "./contact";
 export { broadcasts } from "./broadcasts";
 export { segments } from "./segments";
 export { journeys } from "./journeys";
+export { journeysAnalytics } from "./journeysAnalytics";
 export { qr } from "./qr";
 export { template } from "./template";
 export { interactions } from "./interactions";

package/dist/api/index.js

@@ -21,6 +21,7 @@ export { contact } from "./contact";
 export { broadcasts } from "./broadcasts";
 export { segments } from "./segments";
 export { journeys } from "./journeys";
+export { journeysAnalytics } from "./journeysAnalytics";
 export { qr } from "./qr";
 export { template } from "./template";
 export { interactions } from "./interactions";

package/dist/api/journeysAnalytics.d.ts

@@ -0,0 +1,20 @@
+import type { JourneyStatsRequest, JourneyStatsResponse, JourneyStepRecipientsRequest, JourneyStepRecipientsResponse, JourneyFunnelReportRequest, JourneyFunnelReportResponse } from "../types/journeysAnalytics";
+export declare namespace journeysAnalytics {
+    /**
+     * POST /admin/collection/:collectionId/journeys.analytics/:journeyId/stats
+     * Computes journey stats over a time window; outcome defaults to 'success'.
+     * If `finalStepId` is provided, includes `currentlyActive` and `completed` fields.
+     */
+    function stats(collectionId: string, journeyId: string, body?: JourneyStatsRequest): Promise<JourneyStatsResponse>;
+    /**
+     * POST /admin/collection/:collectionId/journeys.analytics/:journeyId/steps/:stepId/recipients
+     * Returns recipient IDs for a given journey step.
+     * For completed/pending, `interactionId` is required; outcome defaults to 'success'.
+     */
+    function recipients(collectionId: string, journeyId: string, stepId: string, body?: JourneyStepRecipientsRequest): Promise<JourneyStepRecipientsResponse>;
+    /**
+     * POST /admin/collection/:collectionId/journeys.analytics/:journeyId/funnel-report
+     * Computes conversion, counts, and avg time across mapped steps in a period.
+     */
+    function funnelReport(collectionId: string, journeyId: string, body: JourneyFunnelReportRequest): Promise<JourneyFunnelReportResponse>;
+}

package/dist/api/journeysAnalytics.js

@@ -0,0 +1,34 @@
+// src/api/journeysAnalytics.ts
+import { post } from "../http";
+export var journeysAnalytics;
+(function (journeysAnalytics) {
+    /**
+     * POST /admin/collection/:collectionId/journeys.analytics/:journeyId/stats
+     * Computes journey stats over a time window; outcome defaults to 'success'.
+     * If `finalStepId` is provided, includes `currentlyActive` and `completed` fields.
+     */
+    async function stats(collectionId, journeyId, body = {}) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/journeys.analytics/${encodeURIComponent(journeyId)}/stats`;
+        return post(path, body);
+    }
+    journeysAnalytics.stats = stats;
+    /**
+     * POST /admin/collection/:collectionId/journeys.analytics/:journeyId/steps/:stepId/recipients
+     * Returns recipient IDs for a given journey step.
+     * For completed/pending, `interactionId` is required; outcome defaults to 'success'.
+     */
+    async function recipients(collectionId, journeyId, stepId, body = {}) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/journeys.analytics/${encodeURIComponent(journeyId)}/steps/${encodeURIComponent(stepId)}/recipients`;
+        return post(path, body);
+    }
+    journeysAnalytics.recipients = recipients;
+    /**
+     * POST /admin/collection/:collectionId/journeys.analytics/:journeyId/funnel-report
+     * Computes conversion, counts, and avg time across mapped steps in a period.
+     */
+    async function funnelReport(collectionId, journeyId, body) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/journeys.analytics/${encodeURIComponent(journeyId)}/funnel-report`;
+        return post(path, body);
+    }
+    journeysAnalytics.funnelReport = funnelReport;
+})(journeysAnalytics || (journeysAnalytics = {}));

package/dist/types/comms.d.ts

@@ -133,6 +133,7 @@ export interface RecipientWithOutcome {
 export interface CommsRecipientIdsQuery {
     broadcastId?: string;
     journeyId?: string;
+    journeyStepId?: string;
     idField?: IdField;
     from?: string;
     to?: string;

package/dist/types/index.d.ts

@@ -15,6 +15,7 @@ export * from "./broadcasts";
 export * from "./segments";
 export * from "./common";
 export * from "./journeys";
+export * from "./journeysAnalytics";
 export * from "./qr";
 export * from "./template";
 export * from "./interaction";

package/dist/types/index.js

@@ -17,6 +17,7 @@ export * from "./broadcasts";
 export * from "./segments";
 export * from "./common";
 export * from "./journeys";
+export * from "./journeysAnalytics";
 export * from "./qr";
 export * from "./template";
 export * from "./interaction";

package/dist/types/journeysAnalytics.d.ts

@@ -0,0 +1,58 @@
+import type { IdField } from './common';
+export interface JourneyStatsRequest {
+    idField?: IdField;
+    from?: string;
+    to?: string;
+    finalStepId?: string;
+    stepMappings?: Array<{
+        stepId: string;
+        interactionId?: string;
+        outcome?: string;
+    }>;
+}
+export interface JourneyStatsResponse {
+    journeyId: string;
+    totalEntered: number;
+    currentlyActive?: number;
+    completed?: number;
+    exitedViaGoal?: number;
+    lastUpdated: string;
+    stepStats: Array<{
+        stepId: string;
+        entered: number;
+        completed: number;
+        pending: number;
+    }>;
+}
+export interface JourneyStepRecipientsRequest {
+    status?: 'entered' | 'completed' | 'pending';
+    idField?: IdField;
+    interactionId?: string;
+    outcome?: string;
+    from?: string;
+    to?: string;
+    limit?: number;
+}
+export type JourneyStepRecipientsResponse = string[];
+export interface JourneyFunnelReportRequest {
+    idField?: IdField;
+    periodStart?: string;
+    periodEnd?: string;
+    stepMappings: Array<{
+        stepId: string;
+        interactionId?: string;
+        outcome?: string;
+    }>;
+}
+export interface JourneyFunnelReportResponse {
+    journeyId: string;
+    periodStart: string | null;
+    periodEnd: string | null;
+    steps: Array<{
+        stepId: string;
+        enteredCount: number;
+        completedCount: number;
+        conversionRate: number;
+        avgTimeToComplete: number | null;
+    }>;
+}

package/dist/types/journeysAnalytics.js

@@ -0,0 +1,2 @@
+// src/types/journeysAnalytics.ts
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@proveanything/smartlinks",
-  "version": "1.1.12",
+  "version": "1.1.13",
   "description": "Official JavaScript/TypeScript SDK for the Smartlinks API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",