User Account IDs

In order to perform identity mapping successfully we require certain external IDs to be passed along with the event data. This is summarized in the below table:

Supported ID	Details	Supported Platforms
`psid`	PSN Online ID	Playstation 4, Playstation 5, Web
`psn_uid`	PSN Account ID (internal ID)	Playstation 4 , Playstation 5 , Web
`pxuid`	Xbox User ID (Publisher-Unique ID)	Xbox One, Xbox Series X/S, Web
`na_name`	Nintendo Account Name	Nintendo Switch, Web
`na_id`	Nintendo Account ID	Nintendo Switch *, Web
`twitter`	Twitter Handle (no leading @)	Playstation 4, Playstation 5, Xbox One, Xbox Series X/S, Web
`twitch`	Twitch Account Name	Playstation 4, Playstation 5, Xbox One, Xbox Series X/S, Web
`steamid64`	SteamID64	PC, Mac, Linux, Web
`epicgs_id`	Epic Game Store Account ID	PC, Mac, Linux, Web
`email`	Email address	Playstation 4, Playstation 5, Xbox One, Xbox Series X/S, PC, Mac, Linux, Web
Custom company-specific ID	See Cross-Game IDs below	Playstation 4, Playstation 5, Xbox One, Xbox Series X/S, PC, Mac, Linux, Web

* In the above table indicates that the ID is recommended on that platform

curl https://api.ingest.marketing.gamesight.io/events \
	-X POST \
	-H 'Authorization: SOMEAPIKEYHERE' \
	-H 'X-Api-Version: 1.1.0' \
	-H 'Content-Type: application/json' \
	-d "$(cat <<-EOF
  {
    "user_id": "b91f8k5r",
    "type": "skin_purchase",
    "external_ids":[{
      "external_id_type": "psid",
      "external_id": "username"
    }],
    "identifiers": {...},
  }
EOF)"

Cross-Game IDs

If you have additional ID information that is available within your organization, such as a shared account system or wallet ID, you can specify custom external IDs that are scoped to be available to all games in your organization. This will allow the ID mapping in the device graph to be shared between your games to improve attribution.

To enable cross-game IDs you will need to pass the scope_type and scope_id values along with your External ID. Ensure the scope type is set to org and put your Organization ID as the scope_id.

Below is an example of how to send an event with an Organization scoped ID.

curl https://api.ingest.marketing.gamesight.io/events \
	-X POST \
	-H 'Authorization: SOMEAPIKEYHERE' \
	-H 'X-Api-Version: 1.1.0' \
	-H 'Content-Type: application/json' \
	-d "$(cat <<-EOF
  {
    "user_id": "b91f8k5r",
    "type": "skin_purchase",
    "external_ids":[{
      "external_id_type": "my_account_id",
      "external_id": "username",
      "scope_type": "org",
      "scope_id": "1"
    }],
    "identifiers": {...},
  }
EOF)"