SDK setup

SDK setup lives in the Settings area of the dashboard, under Apps & data.

At a glance#

What it does#

SDK setup is the in-dashboard integration guide, with your own SDK key already filled in. It shows the install and initialisation code for your app's platform in copyable blocks, and includes the setup for optional capabilities — engagement, and coachmark anchors — rather than only the minimum.

Because it resolves your platform and your key, the snippets are ready to paste rather than templates you have to edit.

When to use it#

At the start of an integration, and when adding a capability to an existing one. The pre-filled key is the whole advantage: copying a key by hand into a snippet is where a surprising number of failed integrations begin.

For the full reference — every configuration option, every method, and the reasoning — this documentation is the canonical source. That page is a quick start; these are the details.

Workflow#

1. 1

   Confirm the platform is right

   The snippets are platform-resolved. If they look wrong for your stack, the app's platform setting is wrong — see Apps.

2. 2

   Install and initialise, then stop and verify

   Do not add anything else until data arrives. Check Devices, which populates before analytics do.

3. 3

   Add identify next

   Almost every person-shaped feature depends on it — retention, profiles, the identity graph. See Identity.

4. 4

   Then add the capabilities you actually want

   Replay, engagement, performance. Each is separately enabled; adding all of them at once makes a failure hard to attribute.

Permissions and prerequisites#

Requires an app to exist with a platform set, and an SDK key. Reading the key requires a role that can see it.

Limits and edge cases#

• A snippet is a starting point, not a configuration. The defaults it shows are not necessarily the right ones for you — sampling rates in particular deserve a deliberate decision.

• The key shown is for the selected environment. Copying while pointed at staging puts a staging key into your production build, which reports successfully into the wrong place.

• Snippets cover the platforms the dashboard knows about. For anything not shown, use Install the SDK.

• It cannot verify your integration — it only shows you what to write.

Troubleshooting#

Pasted the snippet and no data. Check the environment the key came from, and confirm initialisation actually runs — a call inside a conditional that is false looks identical to no call.

Snippets are for the wrong platform. Fix the app's platform in Apps.

Where the data comes from#

From the SDK

• Install

• Configuration

Served by

• SDK config

• SDK keys

Related#

• Install the SDK

• SDK keys

• Environments

• Data & privacy

• Symbolication

• Settings overview