@agenus-io/pixel-backend-sdk 1.1.6 → 1.1.8

package/dist/Class/index.d.ts

@@ -1,5 +1,5 @@
 import type { AWSConfig, SendSaleParams } from "../config";
-import { ICreatePixelDTO, IGetOnePixelDTO, IGetPixelDTO, IDeletePixelDTO, IUpdatePixelDTO, IPixelSdk, IUpdateOffersDTO, IMetricsDTO, IFunilSummaryDTO, IAccessGraphDTO, IEventsSourceDTO, IEventsDeviceDTO, IEventsPerPageDTO, IEventsPerProjectDTO, ISummaryDTO } from './interface';
+import { ICreatePixelDTO, IGetOnePixelDTO, IGetPixelDTO, IDeletePixelDTO, IUpdatePixelDTO, IPixelSdk, IUpdateOffersDTO, IMetricsDTO, IFunilSummaryDTO, IAccessGraphDTO, IEventsSourceDTO, IEventsDeviceDTO, IEventsPerPageDTO, IEventsPerProjectDTO, ISummaryDTO, ISessionsSummaryDTO, ISessionsGraphDTO, IConversionGraphDTO, IVisitorsGraphDTO, ITrafficDeviceDTO, ITrafficSourceDTO, IEventGetDTO } from './interface';
 /**
  * Classe responsável por com vendas e pixels
  */
@@ -36,4 +36,11 @@ export declare class PixelSDK implements IPixelSdk {
     EventsPerPage({ workSpaceId, startDate, endDate }: IEventsPerPageDTO.Params): Promise<IEventsPerPageDTO.Result>;
     EventsPerProject({ workSpaceId, startDate, endDate }: IEventsPerProjectDTO.Params): Promise<IEventsPerProjectDTO.Result>;
     Summary({ workSpaceId, startDate, endDate, projectId, pageId }: ISummaryDTO.Params): Promise<ISummaryDTO.Result>;
+    SessionsSummary({ workSpaceId, startDate, endDate, pixelId }: ISessionsSummaryDTO.Params): Promise<ISessionsSummaryDTO.Result>;
+    SessionsGraph({ workSpaceId, startDate, endDate }: ISessionsGraphDTO.Params): Promise<ISessionsGraphDTO.Result>;
+    ConversionGraph({ workSpaceId, startDate, endDate, pixelId }: IConversionGraphDTO.Params): Promise<IConversionGraphDTO.Result>;
+    VisitorsGraph({ workSpaceId, startDate, endDate, pixelId }: IVisitorsGraphDTO.Params): Promise<IVisitorsGraphDTO.Result>;
+    TrafficDevice({ workSpaceId, startDate, endDate, pixelId }: ITrafficDeviceDTO.Params): Promise<ITrafficDeviceDTO.Result>;
+    TrafficSource({ workSpaceId, startDate, endDate, pixelId }: ITrafficSourceDTO.Params): Promise<ITrafficSourceDTO.Result>;
+    EventGet({ workSpaceId, startDate, endDate, pixelId, type, category }: IEventGetDTO.Params): Promise<IEventGetDTO.Result>;
 }

package/dist/Class/index.js

@@ -401,5 +401,166 @@ class PixelSDK {
             throw "Erro ao obter resumo de eventos";
         }
     }
+    async SessionsSummary({ workSpaceId, startDate, endDate, pixelId }) {
+        try {
+            const token = {
+                appId: this.appId,
+                secretToken: this.appToken,
+                workSpaceId: workSpaceId,
+            };
+            const response = await axios_1.default.get(`${this.apiUrl}/metrics/sessions/summary`, {
+                headers: { "app-id": token.appId, "app-secret-token": token.secretToken, "work-space-id": token.workSpaceId },
+                params: { startDate, endDate, pixelId },
+            });
+            return response.data;
+        }
+        catch (error) {
+            if (error instanceof axios_1.AxiosError) {
+                console.log(error.response?.data);
+            }
+            else {
+                console.log(error);
+            }
+            throw "Erro ao obter resumo de sessões";
+        }
+    }
+    async SessionsGraph({ workSpaceId, startDate, endDate }) {
+        try {
+            const token = {
+                appId: this.appId,
+                secretToken: this.appToken,
+                workSpaceId: workSpaceId,
+            };
+            const response = await axios_1.default.get(`${this.apiUrl}/metrics/sessions/graph`, {
+                headers: { "app-id": token.appId, "app-secret-token": token.secretToken, "work-space-id": token.workSpaceId },
+                params: { startDate, endDate },
+            });
+            return response.data;
+        }
+        catch (error) {
+            if (error instanceof axios_1.AxiosError) {
+                console.log(error.response?.data);
+            }
+            else {
+                console.log(error);
+            }
+            throw "Erro ao obter gráfico de sessões";
+        }
+    }
+    async ConversionGraph({ workSpaceId, startDate, endDate, pixelId }) {
+        try {
+            const token = {
+                appId: this.appId,
+                secretToken: this.appToken,
+                workSpaceId: workSpaceId,
+            };
+            const response = await axios_1.default.get(`${this.apiUrl}/metrics/sessions/conversion-graph`, {
+                headers: { "app-id": token.appId, "app-secret-token": token.secretToken, "work-space-id": token.workSpaceId },
+                params: { startDate, endDate, pixelId },
+            });
+            return response.data;
+        }
+        catch (error) {
+            if (error instanceof axios_1.AxiosError) {
+                console.log(error.response?.data);
+            }
+            else {
+                console.log(error);
+            }
+            throw "Erro ao obter gráfico de conversões";
+        }
+    }
+    async VisitorsGraph({ workSpaceId, startDate, endDate, pixelId }) {
+        try {
+            const token = {
+                appId: this.appId,
+                secretToken: this.appToken,
+                workSpaceId: workSpaceId,
+            };
+            const response = await axios_1.default.get(`${this.apiUrl}/metrics/visitors/graph`, {
+                headers: { "app-id": token.appId, "app-secret-token": token.secretToken, "work-space-id": token.workSpaceId },
+                params: { startDate, endDate, pixelId },
+            });
+            return response.data;
+        }
+        catch (error) {
+            if (error instanceof axios_1.AxiosError) {
+                console.log(error.response?.data);
+            }
+            else {
+                console.log(error);
+            }
+            throw "Erro ao obter gráfico de visitantes";
+        }
+    }
+    async TrafficDevice({ workSpaceId, startDate, endDate, pixelId }) {
+        try {
+            const token = {
+                appId: this.appId,
+                secretToken: this.appToken,
+                workSpaceId: workSpaceId,
+            };
+            const response = await axios_1.default.get(`${this.apiUrl}/metrics/visitors/traffic-device`, {
+                headers: { "app-id": token.appId, "app-secret-token": token.secretToken, "work-space-id": token.workSpaceId },
+                params: { startDate, endDate, pixelId },
+            });
+            return response.data;
+        }
+        catch (error) {
+            if (error instanceof axios_1.AxiosError) {
+                console.log(error.response?.data);
+            }
+            else {
+                console.log(error);
+            }
+            throw "Erro ao obter dispositivos de tráfego";
+        }
+    }
+    async TrafficSource({ workSpaceId, startDate, endDate, pixelId }) {
+        try {
+            const token = {
+                appId: this.appId,
+                secretToken: this.appToken,
+                workSpaceId: workSpaceId,
+            };
+            const response = await axios_1.default.get(`${this.apiUrl}/metrics/visitors/traffic-source`, {
+                headers: { "app-id": token.appId, "app-secret-token": token.secretToken, "work-space-id": token.workSpaceId },
+                params: { startDate, endDate, pixelId },
+            });
+            return response.data;
+        }
+        catch (error) {
+            if (error instanceof axios_1.AxiosError) {
+                console.log(error.response?.data);
+            }
+            else {
+                console.log(error);
+            }
+            throw "Erro ao obter dispositivos de tráfego";
+        }
+    }
+    async EventGet({ workSpaceId, startDate, endDate, pixelId, type, category }) {
+        try {
+            const token = {
+                appId: this.appId,
+                secretToken: this.appToken,
+                workSpaceId: workSpaceId,
+            };
+            const response = await axios_1.default.get(`${this.apiUrl}/events`, {
+                headers: { "app-id": token.appId, "app-secret-token": token.secretToken, "work-space-id": token.workSpaceId },
+                params: { startDate, endDate, pixelId, type, category },
+            });
+            return response.data;
+        }
+        catch (error) {
+            if (error instanceof axios_1.AxiosError) {
+                console.log(error.response?.data);
+            }
+            else {
+                console.log(error);
+            }
+            throw "Erro ao obter eventos";
+        }
+    }
 }
 exports.PixelSDK = PixelSDK;

package/dist/Class/interface.d.ts

@@ -259,8 +259,134 @@ export declare namespace IEventsPerProjectDTO {
         startDate: Date;
         endDate: Date;
     };
+    type PaginationMeta = {
+        total: number;
+        totalPages: number;
+        page: number;
+        pageSize: number;
+    };
+    type DeviceOs = {
+        name: string;
+        version: string;
+    };
+    type DeviceEngine = {
+        name: string;
+        version: string;
+    };
+    type DeviceScreen = {
+        width: number;
+        height: number;
+        pixel_ratio: number;
+    };
+    type DeviceBrowser = {
+        name: string;
+        version: string;
+    };
+    type EventDevice = {
+        id: string;
+        os: DeviceOs;
+        type: string;
+        engine: DeviceEngine;
+        screen: DeviceScreen;
+        browser: DeviceBrowser;
+        language: string;
+        userAgent: string;
+    };
+    type EventScriptMeta = {
+        pageId: string;
+        version: string;
+        projectId: string;
+        script_url: string;
+        environment: string;
+        pixel_source: string;
+    };
+    type BehaviorSnapshot = {
+        state: {
+            isIdle: boolean;
+            isActive: boolean;
+            isVisible: boolean;
+        };
+        pageId: string;
+        scroll: {
+            maxDepth: number;
+        };
+        timing: {
+            idleTime: number;
+            activeTime: number;
+            visibleTime: number;
+        };
+        sessionId: string;
+        timestamp: number;
+        visitorId: string;
+        engagement: {
+            level: string;
+            score: number;
+        };
+        interaction: {
+            clicks: number;
+            keypresses: number;
+            mouseMovements: number;
+        };
+    };
+    type BehaviorCriticalEvent = {
+        type: string;
+        pageId: string;
+        sessionId: string;
+        timestamp: number;
+        visitorId: string;
+    };
+    type BehaviorSummaryData = {
+        path: string;
+        hostname: string;
+        page_url: string;
+        sessionId: string;
+        timestamp: number;
+        visitorId: string;
+        behaviorSnapshots: BehaviorSnapshot[];
+        behaviorCriticalEvents: BehaviorCriticalEvent[];
+    };
+    type UserIdleData = {
+        path: string;
+        hostname: string;
+        page_url: string;
+        active_ms: number;
+        timestamp: number;
+        idle_threshold_ms: number;
+    };
+    type EventPayload = BehaviorSummaryData | UserIdleData | Record<string, unknown>;
+    type EventItem = {
+        id: string;
+        eventId: string;
+        sent: boolean;
+        errorType: string;
+        errorMessage: string | null;
+        sessionId: string;
+        currency: string | null;
+        type: string;
+        category: string;
+        timestamp: string;
+        fingerprint: string;
+        ip: string;
+        userAgent: string;
+        device: EventDevice;
+        data: EventPayload;
+        meta: EventScriptMeta;
+        pixelId: string;
+        createdAt: string;
+        updatedAt: string;
+        visitorId: string;
+        utms: unknown;
+        utmSource: string | null;
+        utmMedium: string | null;
+        utmCampaign: string | null;
+        utmContent: string | null;
+        utmTerm: string | null;
+        pageusProjectId: string | null;
+        pageusPageId: string | null;
+    };
     type Result = {
-        data: Record<string, number>;
+        data: EventItem[];
+        meta: PaginationMeta;
     };
 }
 export declare namespace ISummaryDTO {
@@ -280,6 +406,114 @@ export declare namespace ISummaryDTO {
         engagementRate: number;
     };
 }
+export declare namespace ISessionsSummaryDTO {
+    type Params = {
+        workSpaceId: string;
+        startDate?: Date;
+        endDate?: Date;
+        pixelId?: string;
+    };
+    type Result = {
+        totalSessions: number;
+        uniqueUsers: number;
+        averageTimeSession: number;
+        conversionRate: string;
+        dataSessionsEngagement: number;
+    };
+}
+export declare namespace ISessionsGraphDTO {
+    type Params = {
+        workSpaceId: string;
+        startDate?: Date;
+        endDate?: Date;
+        pixelId?: string;
+    };
+    type Result = {
+        graph: {
+            sessions: number;
+            date: string;
+        }[];
+        percentageEvolution: number;
+    };
+}
+export declare namespace IConversionGraphDTO {
+    type Params = {
+        workSpaceId: string;
+        startDate?: Date;
+        endDate?: Date;
+        pixelId?: string;
+    };
+    type Result = {
+        graph: {
+            conversions: number;
+            sessions: number;
+            date: string;
+        }[];
+        percentageEvolution: number;
+    };
+}
+export declare namespace IVisitorsGraphDTO {
+    type Params = {
+        workSpaceId: string;
+        startDate?: Date;
+        endDate?: Date;
+        pixelId?: string;
+    };
+    type Result = {
+        graph: {
+            date: string;
+            visitors: number;
+        }[];
+        percentageEvolution: number;
+    };
+}
+export declare namespace ITrafficDeviceDTO {
+    type Params = {
+        workSpaceId: string;
+        startDate?: Date;
+        endDate?: Date;
+        pixelId?: string;
+    };
+    type Result = {
+        os: {
+            _count: number;
+            os: string;
+        }[];
+        browser: {
+            _count: number;
+            browser: string;
+        }[];
+        type: {
+            _count: number;
+            type: string;
+        }[];
+    };
+}
+export declare namespace ITrafficSourceDTO {
+    type Params = {
+        workSpaceId: string;
+        startDate?: Date;
+        endDate?: Date;
+        pixelId?: string;
+    };
+    type Result = {
+        _count: number;
+        utmSource: string;
+    }[];
+}
+export declare namespace IEventGetDTO {
+    type Params = {
+        workSpaceId: string;
+        startDate?: Date;
+        endDate?: Date;
+        pixelId?: string;
+        type?: string[];
+        category?: string[];
+    };
+    type Result = {
+        data: Record<string, number>;
+    };
+}
 export interface IPixelSdk {
     Create(params: ICreatePixelDTO.Params): Promise<ICreatePixelDTO.Result>;
     Update(params: IUpdatePixelDTO.Params): Promise<void>;
@@ -295,5 +529,12 @@ export interface IPixelSdk {
     EventsPerPage(params: IEventsPerPageDTO.Params): Promise<IEventsPerPageDTO.Result>;
     EventsPerProject(params: IEventsPerProjectDTO.Params): Promise<IEventsPerProjectDTO.Result>;
     Summary(params: ISummaryDTO.Params): Promise<ISummaryDTO.Result>;
+    SessionsSummary(params: ISessionsSummaryDTO.Params): Promise<ISessionsSummaryDTO.Result>;
+    SessionsGraph(params: ISessionsGraphDTO.Params): Promise<ISessionsGraphDTO.Result>;
+    ConversionGraph(params: IConversionGraphDTO.Params): Promise<IConversionGraphDTO.Result>;
+    VisitorsGraph(params: IVisitorsGraphDTO.Params): Promise<IVisitorsGraphDTO.Result>;
+    TrafficDevice(params: ITrafficDeviceDTO.Params): Promise<ITrafficDeviceDTO.Result>;
+    TrafficSource(params: ITrafficSourceDTO.Params): Promise<ITrafficSourceDTO.Result>;
+    EventGet(params: IEventGetDTO.Params): Promise<IEventGetDTO.Result>;
 }
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agenus-io/pixel-backend-sdk",
-  "version": "1.1.6",
+  "version": "1.1.8",
   "description": "SDK para envio de vendas para fila AWS SQS do micro-serviço de pixels",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",