Merge pull request #421 from dlackty/statistics-per-unit

Implement getStatisticsPerUnit

Author: louis70109

docs/api-reference/client.md

@@ -84,6 +84,7 @@ class Client {
   getNumberOfFollowers(date: string): Promise<Types.NumberOfFollowersResponse>
   getFriendDemographics(): Promise<Types.FriendDemographics>
   getUserInteractionStatistics(requestId: string): Promise<Types.UserInteractionStatistics>
+  getStatisticsPerUnit(customAggregationUnit: string, from: string, to: string): Promise<Types.StatisticsPerUnit>
 
   // AudienceGroup
   createUploadAudienceGroup(uploadAudienceGroup: {
@@ -751,6 +752,14 @@ It corresponds to the [Get number of followers](https://developers.line.biz/en/r
 
 It corresponds to the [Get friend demographics](https://developers.line.biz/en/reference/messaging-api/#get-demographic) API.
 
+#### `getUserInteractionStatistics(): Promise<Types.UserInteractionStatistics>`
+
+It corresponds to the [Get user interaction statistics](https://developers.line.biz/en/reference/messaging-api/#get-message-event) API.
+
+#### `getStatisticsPerUnit(): Promise<Types.StatisticsPerUnit>`
+
+It corresponds to the [Get statistics per unit](https://developers.line.biz/en/reference/messaging-api/#get-statistics-per-unit) API.
+
 ### Bot
 
 #### `getBotInfo(): Promise<BotInfoResponse>`

lib/client.ts

@@ -515,6 +515,17 @@ export default class Client {
     return ensureJSON(res);
   }
 
+  public async getStatisticsPerUnit(
+    customAggregationUnit: string,
+    from: string,
+    to: string,
+  ): Promise<Types.StatisticsPerUnit> {
+    const res = await this.http.get<Types.StatisticsPerUnit>(
+      `${MESSAGING_API_PREFIX}/insight/message/event/aggregation?customAggregationUnit=${customAggregationUnit}&from=${from}&to=${to}`,
+    );
+    return ensureJSON(res);
+  }
+
   public async createUploadAudienceGroup(uploadAudienceGroup: {
     description: string;
     isIfaAudience?: boolean;

lib/types.ts

@@ -2518,6 +2518,20 @@ export type UserInteractionStatistics = {
   clicks: UserInteractionStatisticsOfEachURL[];
 };
 
+/**
+ * https://developers.line.biz/en/reference/messaging-api/#get-statistics-per-unit
+ */
+export type StatisticsPerUnit = {
+  overview: {
+    uniqueImpression: number;
+    uniqueClick: number;
+    uniqueMediaPlayed: number;
+    uniqueMediaPlayed100Percent: number;
+  };
+  messages: UserInteractionStatisticsOfEachMessage[];
+  clicks: UserInteractionStatisticsOfEachURL[];
+};
+
 type FilterOperatorObject<T> = {
   type: "operator";
 } & (

test/client.spec.ts

@@ -744,6 +744,24 @@ describe("client", () => {
     equal(scope.isDone(), true);
   });
 
+  it("getStatisticsPerUnit", async () => {
+    const customAggregationUnit = "promotion_a";
+    const from = "20210301";
+    const to = "20210331";
+    const scope = mockGet(
+      MESSAGING_API_PREFIX,
+      "/insight/message/event/aggregation",
+      {
+        customAggregationUnit,
+        from,
+        to,
+      },
+    );
+
+    await client.getStatisticsPerUnit(customAggregationUnit, from, to);
+    equal(scope.isDone(), true);
+  });
+
   it("createUploadAudienceGroup", async () => {
     const requestBody = {
       description: "audienceGroupName",