@agenus-io/pixel-backend-sdk 1.1.7 → 1.1.9

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, ISessionsSummaryDTO, ISessionsGraphDTO, IConversionGraphDTO, IVisitorsGraphDTO, ITrafficDeviceDTO, ITrafficSourceDTO } 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
  */
@@ -42,4 +42,5 @@ export declare class PixelSDK implements IPixelSdk {
     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

@@ -539,5 +539,28 @@ class PixelSDK {
             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

@@ -253,14 +253,140 @@ export declare namespace IEventsPerPageDTO {
         data: Record<string, number>;
     };
 }
+export type DeviceOs = {
+    name: string;
+    version: string;
+};
+export type DeviceEngine = {
+    name: string;
+    version: string;
+};
+export type DeviceScreen = {
+    width: number;
+    height: number;
+    pixel_ratio: number;
+};
+export type DeviceBrowser = {
+    name: string;
+    version: string;
+};
+export type EventDevice = {
+    id: string;
+    os: DeviceOs;
+    type: string;
+    engine: DeviceEngine;
+    screen: DeviceScreen;
+    browser: DeviceBrowser;
+    language: string;
+    userAgent: string;
+};
+export type EventScriptMeta = {
+    pageId: string;
+    version: string;
+    projectId: string;
+    script_url: string;
+    environment: string;
+    pixel_source: string;
+};
+export 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;
+    };
+};
+export type BehaviorCriticalEvent = {
+    type: string;
+    pageId: string;
+    sessionId: string;
+    timestamp: number;
+    visitorId: string;
+};
+export type BehaviorSummaryData = {
+    path: string;
+    hostname: string;
+    page_url: string;
+    sessionId: string;
+    timestamp: number;
+    visitorId: string;
+    behaviorSnapshots: BehaviorSnapshot[];
+    behaviorCriticalEvents: BehaviorCriticalEvent[];
+};
+export type UserIdleData = {
+    path: string;
+    hostname: string;
+    page_url: string;
+    active_ms: number;
+    timestamp: number;
+    idle_threshold_ms: number;
+};
+export type EventPayload = BehaviorSummaryData | UserIdleData | Record<string, unknown>;
+export 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;
+};
 export declare namespace IEventsPerProjectDTO {
     type Params = {
         workSpaceId: string;
         startDate: Date;
         endDate: Date;
     };
+    type PaginationMeta = {
+        total: number;
+        totalPages: number;
+        page: number;
+        pageSize: number;
+    };
     type Result = {
-        data: Record<string, number>;
+        data: EventItem[];
+        meta: PaginationMeta;
     };
 }
 export declare namespace ISummaryDTO {
@@ -375,6 +501,25 @@ export declare namespace ITrafficSourceDTO {
         utmSource: string;
     }[];
 }
+export declare namespace IEventGetDTO {
+    type Params = {
+        workSpaceId: string;
+        startDate?: Date;
+        endDate?: Date;
+        pixelId?: string;
+        type?: string[];
+        category?: string[];
+    };
+    type Result = {
+        data: EventItem[];
+        meta: {
+            total: number;
+            totalPages: number;
+            page: number;
+            pageSize: number;
+        };
+    };
+}
 export interface IPixelSdk {
     Create(params: ICreatePixelDTO.Params): Promise<ICreatePixelDTO.Result>;
     Update(params: IUpdatePixelDTO.Params): Promise<void>;
@@ -396,5 +541,6 @@ export interface IPixelSdk {
     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.7",
+  "version": "1.1.9",
   "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",