What the SDK gives you

The Alldle SDK tells you how players actually do in your game, wherever they play it. It is optional: a link is enough to be listed and to see your audience. The SDK adds what only your game knows.

What you get

Results for every player, free. Win rate, guess distribution, time per round and abandoned rounds, for everyone who plays, on Alldle and on your own site, signed in or not.

How hard each puzzle was. Every puzzle against your usual win rate, so a word that was too obscure shows up the same day, not in the comments.

Your game in players’ daily ritual. A round finished by a signed-in player, inside Alldle or on your site after coming from Alldle, is recorded on their account. Your game page says so with Syncs with Alldle.

What Alldle brings you, measured. Rounds by players who came from Alldle are counted apart from your own players.

Share cards that put your emoji grid above Alldle’s summary, with a link back to you.

What it looks like

<script src="https://www.alldle.net/sdk.js" data-game="your-game-slug"></script>
<script>
  // when the player finishes a round
  alldle.completeMode('classic', { won: true, attempts: 3, maxAttempts: 6 });
</script>

That is a complete integration. Everything else is optional. See Install it.

How it behaves

• It cannot break your game. Nothing the SDK does can throw into your code.
• It works without an Alldle account. Your players do not need one, and you do not have to ask them for anything.
• Requests survive closing the tab. They are sent with keepalive, and as text/plain, so there is no preflight.
• It stays current. /sdk.js always serves the latest version.

What it sends, and what it does not

No cookies. On your site a player is a random id in your domain’s local storage, so a result is counted once. Nothing that identifies them is sent.

Signed-in Alldle players who arrive from Alldle are linked to their account, so their ritual and streak follow them. They arrive with a short-lived token in the address, which lasts 2 hours and works for your game only. The SDK removes it from the address bar when it connects, which the script tag does on load.

Inside Alldle’s frame, your page is sent a signed-in player’s Alldle id, display name and avatar, whether or not you use the SDK. With the SDK, getSession() returns them.

Note

Because the link token is in the first request’s address, it can appear in your server logs. It lets someone report results for that one game as that player, and read what that player finished today.

Results never feed the rankings. They are reported by the player’s browser, which is the same trust any analytics snippet has, so Alldle does not rank games on them.

How it works

• Inside Alldle, the page hands your frame a session over postMessage. Results go straight to Alldle’s API, and the page is told, so it can tick the ritual and show the result card.
• On your site, a player Alldle sent arrives with ?utm_source=alldle. Everyone else is an anonymous player.

Results are accepted from your game’s domain and its subdomains, Alldle’s frame, and localhost. Those from localhost are shown as tests and never counted.

Next: Install itOne script tag, or an npm package with types.