Skip to content

Commit

Permalink
fix: improve opaque user id definition
Browse files Browse the repository at this point in the history
  • Loading branch information
jilanglois committed Jan 7, 2025
1 parent 7f5189a commit 187e86d
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions topsort-api-v2.yml
Original file line number Diff line number Diff line change
Expand Up @@ -411,11 +411,13 @@ components:
OpaqueUserID:
type: string
description:
Ideally the same user for events. The opaque user ID allows correlating user activity, such as Impressions, Clicks and Purchases,
whether or not they are actually logged in. It must be long lived (at least a year) so that Topsort can
attribute purchases. If your users are always logged in you may use a hash of your customer ID. If your users
may interact with your app or site while logged out we recommend generating a random identifier (UUIDv4) on
first load and store it on local storage (cookie, local storage, etc) and let it live for at least a year.
An anonymized unique identifier that maps to the original user ID without revealing the original value.
Ideally the same user for events. The opaque user ID allows correlating user activity, such as Impressions,
Clicks and Purchases, whether or not they are actually logged in. It must be long lived (at least a year) so
that Topsort can attribute purchases. If your users are always logged in you may use a hash of your customer ID.
If your users may interact with your app or site while logged out we recommend generating a random identifier
(UUIDv4) on first load and store it on local storage (cookie, local storage, etc) and let it live for at least
a year.
example: 71303ce0-de89-496d-8270-6434589615e8

PlacementId:
Expand Down

0 comments on commit 187e86d

Please sign in to comment.