@pushwoosh/rpc-gateway-statistics-api 1.3.742 → 1.3.743

package/data.js

@@ -3286,10 +3286,16 @@ export const data = {
             },
             "GetMessageDeliveryTimeline": {
                 "request": "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryTimelineRequest",
-                "response": "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryTimelineResponse",
+                "response": "pushwoosh.statistics.statistics.v2.statistics.GetDeliveryTimelineResponse",
                 "method": "post",
                 "path": "/api/v2/statistics/messages/getDeliveryTimeline"
             },
+            "GetCampaignDeliveryTimeline": {
+                "request": "pushwoosh.statistics.statistics.v2.statistics.GetCampaignDeliveryTimelineRequest",
+                "response": "pushwoosh.statistics.statistics.v2.statistics.GetDeliveryTimelineResponse",
+                "method": "post",
+                "path": "/api/v2/statistics/messages/getCampaignDeliveryTimeline"
+            },
             "GetActiveAudience": {
                 "request": "pushwoosh.statistics.statistics.v2.statistics.GetActiveAudienceRequest",
                 "response": "pushwoosh.statistics.statistics.v2.statistics.GetActiveAudienceResponse",
@@ -4351,7 +4357,28 @@ export const data = {
             }
         }
     },
-    "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryTimelineResponse.Metric": {
+    "pushwoosh.statistics.statistics.v2.statistics.GetCampaignDeliveryTimelineRequest": {
+        "type": "I",
+        "fields": {
+            "campaignCode": {
+                "type": "string"
+            },
+            "platforms": {
+                "type": "number",
+                "array": true
+            },
+            "interval": {
+                "type": "pushwoosh.statistics.types.TimeInterval"
+            },
+            "from": {
+                "type": "Date"
+            },
+            "to": {
+                "type": "Date"
+            }
+        }
+    },
+    "pushwoosh.statistics.statistics.v2.statistics.GetDeliveryTimelineResponse.Metric": {
         "type": "E",
         "values": [
             "METRIC_UNSPECIFIED",
@@ -4362,7 +4389,7 @@ export const data = {
             "METRIC_OPENED"
         ]
     },
-    "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryTimelineResponse.Point": {
+    "pushwoosh.statistics.statistics.v2.statistics.GetDeliveryTimelineResponse.Point": {
         "type": "I",
         "fields": {
             "bucket": {
@@ -4373,7 +4400,7 @@ export const data = {
             }
         }
     },
-    "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryTimelineResponse.PlatformSeries": {
+    "pushwoosh.statistics.statistics.v2.statistics.GetDeliveryTimelineResponse.PlatformSeries": {
         "type": "I",
         "fields": {
             "platform": {
@@ -4383,31 +4410,31 @@ export const data = {
                 "type": "number"
             },
             "points": {
-                "type": "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryTimelineResponse.Point",
+                "type": "pushwoosh.statistics.statistics.v2.statistics.GetDeliveryTimelineResponse.Point",
                 "array": true
             }
         }
     },
-    "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryTimelineResponse.MetricSeries": {
+    "pushwoosh.statistics.statistics.v2.statistics.GetDeliveryTimelineResponse.MetricSeries": {
         "type": "I",
         "fields": {
             "metric": {
-                "type": "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryTimelineResponse.Metric"
+                "type": "pushwoosh.statistics.statistics.v2.statistics.GetDeliveryTimelineResponse.Metric"
             },
             "count": {
                 "type": "number"
             },
             "platforms": {
-                "type": "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryTimelineResponse.PlatformSeries",
+                "type": "pushwoosh.statistics.statistics.v2.statistics.GetDeliveryTimelineResponse.PlatformSeries",
                 "array": true
             }
         }
     },
-    "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryTimelineResponse": {
+    "pushwoosh.statistics.statistics.v2.statistics.GetDeliveryTimelineResponse": {
         "type": "I",
         "fields": {
             "series": {
-                "type": "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryTimelineResponse.MetricSeries",
+                "type": "pushwoosh.statistics.statistics.v2.statistics.GetDeliveryTimelineResponse.MetricSeries",
                 "array": true
             },
             "windowFrom": {
@@ -4423,7 +4450,7 @@ export const data = {
                 "type": "pushwoosh.statistics.types.TimeInterval"
             },
             "eventAxisMetrics": {
-                "type": "pushwoosh.statistics.statistics.v2.statistics.GetMessageDeliveryTimelineResponse.Metric",
+                "type": "pushwoosh.statistics.statistics.v2.statistics.GetDeliveryTimelineResponse.Metric",
                 "array": true
             }
         }

package/package.json

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

package/pushwoosh_statistics_statistics_v2_statistics.d.ts

@@ -14,7 +14,8 @@ export type StatisticsService_GetPushApplicationStatistics = RpcMethod<GetPushAp
 export type StatisticsService_GetEmailApplicationStatistics = RpcMethod<GetEmailApplicationStatisticsRequest, GetEmailApplicationStatisticsResponse>;
 export type StatisticsService_GetMessageDeliveryFunnel = RpcMethod<GetMessageDeliveryFunnelRequest, GetDeliveryFunnelResponse>;
 export type StatisticsService_GetCampaignDeliveryFunnel = RpcMethod<GetCampaignDeliveryFunnelRequest, GetDeliveryFunnelResponse>;
-export type StatisticsService_GetMessageDeliveryTimeline = RpcMethod<GetMessageDeliveryTimelineRequest, GetMessageDeliveryTimelineResponse>;
+export type StatisticsService_GetMessageDeliveryTimeline = RpcMethod<GetMessageDeliveryTimelineRequest, GetDeliveryTimelineResponse>;
+export type StatisticsService_GetCampaignDeliveryTimeline = RpcMethod<GetCampaignDeliveryTimelineRequest, GetDeliveryTimelineResponse>;
 export type StatisticsService_GetActiveAudience = RpcMethod<GetActiveAudienceRequest, GetActiveAudienceResponse>;
 /** StatisticsService provides various statistics operations */
 export interface StatisticsService {
@@ -57,6 +58,11 @@ export interface StatisticsService {
      * answers "how many", this answers "when".
      */
     GetMessageDeliveryTimeline: StatisticsService_GetMessageDeliveryTimeline;
+    /**
+     * GetCampaignDeliveryTimeline is GetMessageDeliveryTimeline over a campaign's messages.
+     * Uniques stay unique within a message, so one subscriber can count more than once.
+     */
+    GetCampaignDeliveryTimeline: StatisticsService_GetCampaignDeliveryTimeline;
     /** GetActiveAudience returns active users and active devices groped by application and platform */
     GetActiveAudience: StatisticsService_GetActiveAudience;
 }
@@ -776,11 +782,32 @@ export type GetMessageDeliveryTimelineRequest = {
     from: Date;
     to: Date;
 };
+/**
+ * GetCampaignDeliveryTimelineRequest asks for one campaign's metrics over time. Same
+ * window rules as the message timeline; the window is the campaign's, not one message's.
+ */
+export type GetCampaignDeliveryTimelineRequest = {
+    /** Campaign code, required */
+    campaignCode: string;
+    /** Optional platform ID filter */
+    platforms: number[];
+    /**
+     * Bucket width. Unset lets the server pick from the window as every other series here
+     * does: a year -> month, over a month -> day, over a day -> hour, else minute.
+     */
+    interval: pushwoosh_statistics_types_TimeInterval;
+    /**
+     * The window to read; an unset end is the campaign's own, and narrowing it narrows the
+     * counts. A stated `from` rounds down to the minute, `to` clips exactly, derived — a day wide.
+     */
+    from: Date;
+    to: Date;
+};
 /**
  * Metric is one line of the chart. Metrics, not funnel stages: STAGE_DELIVERIES
  * counts accepted sends, and the number a reader wants there is not a stage at all.
  */
-export type GetMessageDeliveryTimelineResponse_Metric = 'METRIC_UNSPECIFIED'
+export type GetDeliveryTimelineResponse_Metric = 'METRIC_UNSPECIFIED'
 /** taken into processing */
  | 'METRIC_AUDIENCE'
 /** accepted by the gateway */
@@ -795,7 +822,7 @@ export type GetMessageDeliveryTimelineResponse_Metric = 'METRIC_UNSPECIFIED'
  * Point is one bucket of a series, always UTC. Empty buckets are not emitted: the
  * client draws the axis from the window and the interval.
  */
-export type GetMessageDeliveryTimelineResponse_Point = {
+export type GetDeliveryTimelineResponse_Point = {
     /** start of the interval */
     bucket: Date;
     count: number;
@@ -804,21 +831,25 @@ export type GetMessageDeliveryTimelineResponse_Point = {
  * PlatformSeries is one platform's line: a metric's count is the sum of its platforms,
  * and a platform's points sum to its own count.
  */
-export type GetMessageDeliveryTimelineResponse_PlatformSeries = {
+export type GetDeliveryTimelineResponse_PlatformSeries = {
     platform: number;
     count: number;
-    points: GetMessageDeliveryTimelineResponse_Point[];
+    points: GetDeliveryTimelineResponse_Point[];
 };
-export type GetMessageDeliveryTimelineResponse_MetricSeries = {
-    metric: GetMessageDeliveryTimelineResponse_Metric;
+export type GetDeliveryTimelineResponse_MetricSeries = {
+    metric: GetDeliveryTimelineResponse_Metric;
     count: number;
-    platforms: GetMessageDeliveryTimelineResponse_PlatformSeries[];
+    platforms: GetDeliveryTimelineResponse_PlatformSeries[];
 };
-export type GetMessageDeliveryTimelineResponse = {
-    series: GetMessageDeliveryTimelineResponse_MetricSeries[];
+/**
+ * GetDeliveryTimelineResponse is the shared answer of both timeline methods: a campaign's
+ * series is the same shape as a message's, summed over the campaign's messages.
+ */
+export type GetDeliveryTimelineResponse = {
+    series: GetDeliveryTimelineResponse_MetricSeries[];
     /**
-     * The window actually read: what the request asked for, clamped to the data,
-     * or the message's own window when the request asked for neither end.
+     * The window actually read: what the request asked for, clamped to the data, or the
+     * subject's own window when the request asked for neither end.
      */
     windowFrom: Date;
     windowTo: Date;
@@ -836,7 +867,7 @@ export type GetMessageDeliveryTimelineResponse = {
      * These metrics are counted when the device answered, the others when we sent. The
      * metrics of one bucket are therefore not a funnel: they reconcile over the window.
      */
-    eventAxisMetrics: GetMessageDeliveryTimelineResponse_Metric[];
+    eventAxisMetrics: GetDeliveryTimelineResponse_Metric[];
 };
 /** ActiveAudienceType specifies the type of active users calculation */
 export type ActiveAudienceType =