SMSI-666: Add new smart signal: Velocity (#102)

Author: soniabhishek

examples/get_event_200.json

@@ -277,6 +277,32 @@
       "data": {
         "result": false
       }
+    },
+    "velocity": {
+      "data": {
+        "distinctIp": {
+          "intervals": {
+            "5m": 1,
+            "1h": 1,
+            "24h": 1
+          }
+        },
+        "distinctLinkedId": {},
+        "distinctCountry": {
+          "intervals": {
+            "5m": 1,
+            "1h": 2,
+            "24h": 2
+          }
+        },
+        "events": {
+          "intervals": {
+            "5m": 1,
+            "1h": 5,
+            "24h": 5
+          }
+        }
+      }
     }
   }
-}
+}

examples/get_event_200_all_errors.json

@@ -141,6 +141,12 @@
         "code": "Failed",
         "message": "internal server error"
       }
+    },
+    "velocity": {
+      "error": {
+        "code": "Failed",
+        "message": "internal server error"
+      }
     }
   }
 }

examples/webhook.json

@@ -191,5 +191,29 @@
   },
   "remoteControl": {
     "result": false
+  },
+  "velocity": {
+    "distinctIp": {
+      "intervals": {
+        "5m": 1,
+        "1h": 1,
+        "24h": 1
+      }
+    },
+    "distinctLinkedId": {},
+    "distinctCountry": {
+      "intervals": {
+        "5m": 1,
+        "1h": 2,
+        "24h": 2
+      }
+    },
+    "events": {
+      "intervals": {
+        "5m": 1,
+        "1h": 5,
+        "24h": 5
+      }
+    }
   }
 }

schemas/fingerprint-server-api.yaml

@@ -250,7 +250,7 @@ paths:
       tags:
         - Events
       operationId: 'updateEvent'
-      summary: Update an event with a given request ID 
+      summary: Update an event with a given request ID
       description: |
         Change information in existing events specified by `requestId` or *flag suspicious events*.
 
@@ -635,7 +635,7 @@ paths:
                   summary: Error response when the secret API key was not provided.
                   externalValue: '/examples/shared/403_error_token_required.json'
                 403-wrong-region:
-                  summary: Error response when the API region is different from the region, the calling application is configured with. 
+                  summary: Error response when the API region is different from the region, the calling application is configured with.
                   externalValue: '/examples/shared/403_error_wrong_region.json'
 
         '404':
@@ -918,6 +918,8 @@ components:
               $ref: '#/components/schemas/SuspectScoreResult'
             remoteControl:
               $ref: '#/components/schemas/RemoteControlResult'
+            velocity:
+              $ref: '#/components/schemas/VelocityResult'
           required:
             - visitorId
         - $ref: '#/components/schemas/Visit'
@@ -1414,6 +1416,15 @@ components:
               $ref: '#/components/schemas/RemoteControlResult'
             error:
               $ref: '#/components/schemas/ProductError'
+        velocity:
+          title: SignalResponseVelocity
+          type: object
+          additionalProperties: false
+          properties:
+            data:
+              $ref: '#/components/schemas/VelocityResult'
+            error:
+              $ref: '#/components/schemas/ProductError'
     EventResponse:
       description: Contains results from all activated products - Fingerprint Pro, Bot Detection, and others.
       type: object
@@ -1672,6 +1683,33 @@ components:
           example: 0
       required:
         - result
+    VelocityResult:
+      type: object
+      description: >
+        Sums key data points for a specific `visitorId` at three distinct time intervals: 5 minutes, 1 hour, and 24 hours as follows: 
+
+        - Number of identification events attributed to the visitor ID
+        - Number of distinct IP addresses associated to the visitor ID.
+        - Number of distinct countries associated with the visitor ID.
+        - Number of distinct `linkedId`s associated with the visitor ID.
+
+        The `24h` interval of `distinctIp`, `distinctLinkedId`, and `distinctCountry` will be omitted if the number of `events` for the visitor ID in the last 24 hours (`events.intervals.['24h']`) is higher than 20.000.
+
+      additionalProperties: false
+      properties:
+        distinctIp:
+          $ref: '#/components/schemas/VelocityIntervals'
+        distinctLinkedId:
+          $ref: '#/components/schemas/VelocityIntervals'
+        distinctCountry:
+          $ref: '#/components/schemas/VelocityIntervals'
+        events:
+          $ref: '#/components/schemas/VelocityIntervals'
+      required:
+        - distinctIp
+        - distinctLinkedId
+        - distinctCountry
+        - events
     RawDeviceAttributesResult:
       type: object
       description: >
@@ -1931,3 +1969,30 @@ components:
           required:
             - code
             - message
+    VelocityIntervals:
+      type: object
+      additionalProperties: false
+      properties:
+        'intervals':
+          $ref: '#/components/schemas/VelocityIntervalResult'
+    VelocityIntervalResult:
+      type: object
+      description: >
+        Is absent if the velocity data could not be generated for the visitor ID.
+      additionalProperties: false
+      properties:
+        '5m':
+          type: integer
+          example: 1
+        '1h':
+          type: integer
+          example: 1
+        '24h':
+          type: integer
+          description: >
+            The `24h` interval of `distinctIp`, `distinctLinkedId`, and `distinctCountry` will be omitted if the number of `events`` for the visitor ID in the last 24 hours (`events.intervals.['24h']`) is higher than 20.000.
+          example: 1
+      required:
+        - 5m
+        - 1h
+