@pushwoosh/rpc-gateway-statistics-api 1.3.817 → 1.3.819

package/data.js

@@ -281,6 +281,12 @@ export const data = {
                 "response": "pushwoosh.statistics.statistics.v1.GetEmailLinkStatisticsResponse",
                 "method": "post",
                 "path": "/api/v2/statistics/emails/linksInteractions"
+            },
+            "GetAdCampaignStatistics": {
+                "request": "pushwoosh.statistics.statistics.v1.GetAdCampaignStatisticsRequest",
+                "response": "pushwoosh.statistics.statistics.v1.GetAdCampaignStatisticsResponse",
+                "method": "post",
+                "path": "/api/v2/statistics/emails/adCampaign"
             }
         }
     },
@@ -2261,6 +2267,49 @@ export const data = {
             }
         }
     },
+    "pushwoosh.statistics.statistics.v1.GetAdCampaignStatisticsRequest": {
+        "type": "I",
+        "fields": {
+            "campaignId": {
+                "type": "number"
+            },
+            "dateRange": {
+                "type": "pushwoosh.statistics.types.DateRange"
+            }
+        }
+    },
+    "pushwoosh.statistics.statistics.v1.AdCampaignStatisticsItem": {
+        "type": "I",
+        "fields": {
+            "creativeId": {
+                "type": "number"
+            },
+            "sends": {
+                "type": "number"
+            },
+            "opens": {
+                "type": "number"
+            },
+            "clicks": {
+                "type": "number"
+            },
+            "totalClicks": {
+                "type": "number"
+            },
+            "messages": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.statistics.statistics.v1.GetAdCampaignStatisticsResponse": {
+        "type": "I",
+        "fields": {
+            "items": {
+                "type": "pushwoosh.statistics.statistics.v1.AdCampaignStatisticsItem",
+                "array": true
+            }
+        }
+    },
     "pushwoosh.statistics.statistics.v1.GetEmailLinkStatisticsRequest": {
         "type": "I",
         "fields": {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@pushwoosh/rpc-gateway-statistics-api",
-    "version": "1.3.817",
+    "version": "1.3.819",
     "description": "Statistics API gateway HTTP API Types and Data",
     "main": "index.js",
     "module": "index.js",

package/pushwoosh_statistics_statistics_v1.d.ts

@@ -33,6 +33,7 @@ export type StatisticsService_GetMessagesFunnelStatisticsCP = RpcMethod<GetMessa
 export type StatisticsService_GetFrequencyCappingTotalStatisticsCP = RpcMethod<GetFrequencyCappingTotalStatisticsCPRequest, GetFrequencyCappingTotalStatisticsCPResponse>;
 export type StatisticsService_GetUsersPAEStatisticsCP = RpcMethod<GetUsersPAEStatisticsCPRequest, GetUsersPAEStatisticsCPResponse>;
 export type StatisticsService_GetEmailLinkStatistics = RpcMethod<GetEmailLinkStatisticsRequest, GetEmailLinkStatisticsResponse>;
+export type StatisticsService_GetAdCampaignStatistics = RpcMethod<GetAdCampaignStatisticsRequest, GetAdCampaignStatisticsResponse>;
 /** StatisticsService provides statistics operations for messages, campaigns, and applications */
 export interface StatisticsService {
     /** TODO: delete? */
@@ -97,6 +98,8 @@ export interface StatisticsService {
     GetUsersPAEStatisticsCP: StatisticsService_GetUsersPAEStatisticsCP;
     /** GetEmailLinkStatistics returns email link click statistics with optional full link details */
     GetEmailLinkStatistics: StatisticsService_GetEmailLinkStatistics;
+    /** GetAdCampaignStatistics returns per-creative results of an ad campaign sold in emails */
+    GetAdCampaignStatistics: StatisticsService_GetAdCampaignStatistics;
 }
 /** StatisticsByApplicationIDRequest represents a request for application statistics */
 export type StatisticsByApplicationIDRequest = {
@@ -942,6 +945,30 @@ export type EmailLinkFilter = {
 export type EmailLinkParams = {
     withFullLinks: boolean;
 };
+export type GetAdCampaignStatisticsRequest = {
+    campaignId: number;
+    dateRange: pushwoosh_statistics_types_DateRange;
+};
+/**
+ * One row per creative of the campaign. Opens are opens of the letters that
+ * carried it: the creative is chosen once per send, so the send is the unit.
+ */
+export type AdCampaignStatisticsItem = {
+    creativeId: number;
+    /** letters of those sends */
+    sends: number;
+    /** unique devices that opened them */
+    opens: number;
+    /** unique devices that clicked the banner */
+    clicks: number;
+    /** every click on the banner */
+    totalClicks: number;
+    /** sends the creative was attached to */
+    messages: number;
+};
+export type GetAdCampaignStatisticsResponse = {
+    items: AdCampaignStatisticsItem[];
+};
 export type GetEmailLinkStatisticsRequest = {
     filters: EmailLinkFilter;
     params: EmailLinkParams;