diff --git a/.changeset/fuzzy-apes-talk.md b/.changeset/fuzzy-apes-talk.md new file mode 100644 index 0000000..4fd35f2 --- /dev/null +++ b/.changeset/fuzzy-apes-talk.md @@ -0,0 +1,5 @@ +--- +'fingerprint-pro-server-api-openapi': minor +--- + +Added new `ipEvents`, `distinctIpByLinkedId`, and `distinctVisitorIdByLinkedId` fields to the `velocity` Smart Signal. diff --git a/schemas/components/schemas/VelocityIntervalResult.yaml b/schemas/components/schemas/VelocityIntervalResult.yaml index 3b7be1b..52b1934 100644 --- a/schemas/components/schemas/VelocityIntervalResult.yaml +++ b/schemas/components/schemas/VelocityIntervalResult.yaml @@ -12,8 +12,8 @@ properties: 24h: type: integer description: > - The `24h` interval of `distinctIp`, `distinctLinkedId`, and - `distinctCountry` will be omitted if the number of `events`` for the + The `24h` interval of `distinctIp`, `distinctLinkedId`, `distinctCountry`, `distinctIpByLinkedId` and + `distinctVisitorIdByLinkedId` 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 diff --git a/schemas/components/schemas/VelocityResult.yaml b/schemas/components/schemas/VelocityResult.yaml index b300564..0f11c4f 100644 --- a/schemas/components/schemas/VelocityResult.yaml +++ b/schemas/components/schemas/VelocityResult.yaml @@ -1,28 +1,41 @@ type: object -description: > - Sums key data points for a specific `visitorId` at three distinct time +description: | + Sums key data points for a specific `visitorId`, `ipAddress` and `linkedId` 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. + - Number of identification events associated with the visitor ID. + - Number of distinct linked IDs associated with the visitor ID. + - Number of distinct IP addresses associated to the visitor ID. + - Number of distinct countries associated with the visitor ID. + - Number of events associated for the detected IP address. + - Number of distinct IP addresses associated with the provided linked ID. + - Number of distinct visitor IDs associated with the provided linked 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 + The `24h` interval of `distinctIp`, `distinctLinkedId`, `distinctCountry`, + `distinctIpByLinkedId` and `distinctVisitorIdByLinkedId` 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: + events: $ref: VelocityIntervals.yaml distinctLinkedId: $ref: VelocityIntervals.yaml + distinctIp: + $ref: VelocityIntervals.yaml distinctCountry: $ref: VelocityIntervals.yaml - events: + ipEvents: + $ref: VelocityIntervals.yaml + distinctIpByLinkedId: + $ref: VelocityIntervals.yaml + distinctVisitorIdByLinkedId: $ref: VelocityIntervals.yaml required: - - distinctIp + - events - distinctLinkedId + - distinctIp - distinctCountry - - events + - ipEvents + - distinctIpByLinkedId + - distinctVisitorIdByLinkedId diff --git a/schemas/paths/examples/get_event_200.json b/schemas/paths/examples/get_event_200.json index cd2c1d1..e45810a 100644 --- a/schemas/paths/examples/get_event_200.json +++ b/schemas/paths/examples/get_event_200.json @@ -303,6 +303,27 @@ "1h": 5, "24h": 5 } + }, + "ipEvents": { + "intervals": { + "5m": 1, + "1h": 5, + "24h": 5 + } + }, + "distinctIpByLinkedId": { + "intervals": { + "5m": 1, + "1h": 5, + "24h": 5 + } + }, + "distinctVisitorIdByLinkedId": { + "intervals": { + "5m": 1, + "1h": 5, + "24h": 5 + } } } }, diff --git a/schemas/paths/examples/webhook.json b/schemas/paths/examples/webhook.json index 018d399..dea65ab 100644 --- a/schemas/paths/examples/webhook.json +++ b/schemas/paths/examples/webhook.json @@ -216,6 +216,27 @@ "1h": 5, "24h": 5 } + }, + "ipEvents": { + "intervals": { + "5m": 1, + "1h": 5, + "24h": 5 + } + }, + "distinctIpByLinkedId": { + "intervals": { + "5m": 1, + "1h": 5, + "24h": 5 + } + }, + "distinctVisitorIdByLinkedId": { + "intervals": { + "5m": 1, + "1h": 5, + "24h": 5 + } } }, "developerTools": {