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

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 } from './interface';
+import { ICreatePixelDTO, IGetOnePixelDTO, IGetPixelDTO, IDeletePixelDTO, IUpdatePixelDTO, IPixelSdk, IUpdateOffersDTO, IMetricsDTO, IFunilSummaryDTO, IAccessGraphDTO, IEventsSourceDTO, IEventsDeviceDTO, IEventsPerPageDTO, IEventsPerProjectDTO, ISummaryDTO } from './interface';
 /**
  * Classe responsável por com vendas e pixels
  */
@@ -30,4 +30,10 @@ export declare class PixelSDK implements IPixelSdk {
     UpdateOffers({ id, workspaceId, offerIds, type }: IUpdateOffersDTO.Params): Promise<void>;
     Metrics({ workSpaceId, platform, productIds, offerIds, filter }: IMetricsDTO.Params): Promise<IMetricsDTO.Result>;
     FunilSummary({ workSpaceId, startDate, endDate, campaigns }: IFunilSummaryDTO.Params): Promise<IFunilSummaryDTO.Result>;
+    AccessGraph({ workSpaceId, startDate, endDate }: IAccessGraphDTO.Params): Promise<IAccessGraphDTO.Result>;
+    EventsSource({ workSpaceId, startDate, endDate }: IEventsSourceDTO.Params): Promise<IEventsSourceDTO.Result>;
+    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, projectId, pageId }: ISummaryDTO.Params): Promise<ISummaryDTO.Result>;
 }

package/dist/Class/index.js

@@ -263,5 +263,143 @@ class PixelSDK {
             throw "Erro ao obter resumo da funil";
         }
     }
+    async AccessGraph({ workSpaceId, startDate, endDate }) {
+        try {
+            const token = {
+                appId: this.appId,
+                secretToken: this.appToken,
+                workSpaceId: workSpaceId,
+            };
+            const response = await axios_1.default.get(`${this.apiUrl}/metrics/events/access/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 acesso";
+        }
+    }
+    async EventsSource({ workSpaceId, startDate, endDate }) {
+        try {
+            const token = {
+                appId: this.appId,
+                secretToken: this.appToken,
+                workSpaceId: workSpaceId,
+            };
+            const response = await axios_1.default.get(`${this.apiUrl}/metrics/events/source`, {
+                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 fonte de eventos";
+        }
+    }
+    async EventsDevice({ workSpaceId, startDate, endDate }) {
+        try {
+            const token = {
+                appId: this.appId,
+                secretToken: this.appToken,
+                workSpaceId: workSpaceId,
+            };
+            const response = await axios_1.default.get(`${this.apiUrl}/metrics/events/device`, {
+                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 dispositivos";
+        }
+    }
+    async EventsPerPage({ workSpaceId, startDate, endDate }) {
+        try {
+            const token = {
+                appId: this.appId,
+                secretToken: this.appToken,
+                workSpaceId: workSpaceId,
+            };
+            const response = await axios_1.default.get(`${this.apiUrl}/metrics/events/per-page`, {
+                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 eventos por página";
+        }
+    }
+    async EventsPerProject({ workSpaceId, startDate, endDate }) {
+        try {
+            const token = {
+                appId: this.appId,
+                secretToken: this.appToken,
+                workSpaceId: workSpaceId,
+            };
+            const response = await axios_1.default.get(`${this.apiUrl}/metrics/events/per-project`, {
+                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 eventos por projeto";
+        }
+    }
+    async Summary({ workSpaceId, startDate, endDate, projectId, pageId }) {
+        try {
+            const token = {
+                appId: this.appId,
+                secretToken: this.appToken,
+                workSpaceId: workSpaceId,
+            };
+            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, projectId, pageId },
+            });
+            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 eventos";
+        }
+    }
 }
 exports.PixelSDK = PixelSDK;

package/dist/Class/interface.d.ts

@@ -191,6 +191,95 @@ export declare namespace IFunilSummaryDTO {
         }[];
     };
 }
+export declare namespace IAccessGraphDTO {
+    type Params = {
+        workSpaceId: string;
+        startDate: Date;
+        endDate: Date;
+    };
+    type Result = {
+        graph: {
+            visitors: number;
+            sessions: number;
+            pageViews: number;
+            date: string;
+        }[];
+        percentageEvolutionVisitors: number;
+        percentageEvolutionSessions: number;
+        percentageEvolutionPageViews: number;
+    };
+}
+export declare namespace IEventsSourceDTO {
+    type Params = {
+        workSpaceId: string;
+        startDate: Date;
+        endDate: Date;
+    };
+    type Result = {
+        data: Record<string, number>;
+    };
+}
+type DayData = {
+    os: Record<string, number>;
+    browser: Record<string, number>;
+    type: Record<string, number>;
+};
+export type IEventsDeviceType = {
+    monday: DayData;
+    tuesday: DayData;
+    wednesday: DayData;
+    thursday: DayData;
+    friday: DayData;
+    saturday: DayData;
+    sunday: DayData;
+};
+export declare namespace IEventsDeviceDTO {
+    type Params = {
+        workSpaceId: string;
+        startDate: Date;
+        endDate: Date;
+    };
+    type Result = {
+        data: IEventsDeviceType;
+    };
+}
+export declare namespace IEventsPerPageDTO {
+    type Params = {
+        workSpaceId: string;
+        startDate: Date;
+        endDate: Date;
+    };
+    type Result = {
+        data: Record<string, number>;
+    };
+}
+export declare namespace IEventsPerProjectDTO {
+    type Params = {
+        workSpaceId: string;
+        startDate: Date;
+        endDate: Date;
+    };
+    type Result = {
+        data: Record<string, number>;
+    };
+}
+export declare namespace ISummaryDTO {
+    type Params = {
+        workSpaceId: string;
+        startDate: Date;
+        endDate: Date;
+        projectId?: string;
+        pageId?: string;
+    };
+    type Result = {
+        totalVisitors: number;
+        totalSessions: number;
+        totalPageViews: number;
+        conversionRate: number;
+        averageTimeOnPage: number;
+        engagementRate: number;
+    };
+}
 export interface IPixelSdk {
     Create(params: ICreatePixelDTO.Params): Promise<ICreatePixelDTO.Result>;
     Update(params: IUpdatePixelDTO.Params): Promise<void>;
@@ -200,5 +289,11 @@ export interface IPixelSdk {
     UpdateOffers(params: IUpdateOffersDTO.Params): Promise<void>;
     Metrics(params: IMetricsDTO.Params): Promise<IMetricsDTO.Result>;
     FunilSummary(params: IFunilSummaryDTO.Params): Promise<IFunilSummaryDTO.Result>;
+    AccessGraph(params: IAccessGraphDTO.Params): Promise<IAccessGraphDTO.Result>;
+    EventsSource(params: IEventsSourceDTO.Params): Promise<IEventsSourceDTO.Result>;
+    EventsDevice(params: IEventsDeviceDTO.Params): Promise<IEventsDeviceDTO.Result>;
+    EventsPerPage(params: IEventsPerPageDTO.Params): Promise<IEventsPerPageDTO.Result>;
+    EventsPerProject(params: IEventsPerProjectDTO.Params): Promise<IEventsPerProjectDTO.Result>;
+    Summary(params: ISummaryDTO.Params): Promise<ISummaryDTO.Result>;
 }
 export {};

package/package.json

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