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

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 } from './interface';
 /**
  * Classe responsável por com vendas e pixels
  */
@@ -35,5 +35,11 @@ export declare class PixelSDK implements IPixelSdk {
     EventsDevice({ workSpaceId, startDate, endDate }: IEventsDeviceDTO.Params): Promise<IEventsDeviceDTO.Result>;
     EventsPerPage({ workSpaceId, startDate, endDate }: IEventsPerPageDTO.Params): Promise<IEventsPerPageDTO.Result>;
     EventsPerProject({ workSpaceId, startDate, endDate }: IEventsPerProjectDTO.Params): Promise<IEventsPerProjectDTO.Result>;
-    Summary({ workSpaceId, startDate, endDate }: ISummaryDTO.Params): Promise<ISummaryDTO.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>;
 }

package/dist/Class/index.js

@@ -378,7 +378,7 @@ class PixelSDK {
             throw "Erro ao obter eventos por projeto";
         }
     }
-    async Summary({ workSpaceId, startDate, endDate }) {
+    async Summary({ workSpaceId, startDate, endDate, projectId, pageId }) {
         try {
             const token = {
                 appId: this.appId,
@@ -387,7 +387,7 @@ class PixelSDK {
             };
             const response = await axios_1.default.get(`${this.apiUrl}/metrics/events/summary`, {
                 headers: { "app-id": token.appId, "app-secret-token": token.secretToken, "work-space-id": token.workSpaceId },
-                params: { startDate, endDate },
+                params: { startDate, endDate, projectId, pageId },
             });
             return response.data;
         }
@@ -401,5 +401,143 @@ 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";
+        }
+    }
 }
 exports.PixelSDK = PixelSDK;

package/dist/Class/interface.d.ts

@@ -268,6 +268,8 @@ export declare namespace ISummaryDTO {
         workSpaceId: string;
         startDate: Date;
         endDate: Date;
+        projectId?: string;
+        pageId?: string;
     };
     type Result = {
         totalVisitors: number;
@@ -278,6 +280,101 @@ 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 interface IPixelSdk {
     Create(params: ICreatePixelDTO.Params): Promise<ICreatePixelDTO.Result>;
     Update(params: IUpdatePixelDTO.Params): Promise<void>;
@@ -293,5 +390,11 @@ 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>;
 }
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agenus-io/pixel-backend-sdk",
-  "version": "1.1.5",
+  "version": "1.1.7",
   "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",