Dashboard Walkthrough

The WhiskrKit dashboard is where you create surveys, decide who sees them and read the responses. Your app code stays minimal: most behaviour is controlled here.

Signing in

During the beta, WhiskrKit is invite-only. When you’re invited, you receive an email with a link to app.whiskrkit.eu.

1. Open the link and choose Sign in or create an account
2. Use the same email address you were invited with, and confirm it when asked
3. Sign in with a passkey or a password

Once you’re signed in, you’re part of your organization. Want access for someone on your team? See Roles and Permissions.

Adding your app

Before creating surveys, you need to register your app. Adding apps requires the admin or owner role.

1. Click Add App in the app switcher at the top of the sidebar
2. Choose the platforms your app ships on: iOS, Android, or both
3. For iOS, paste your App Store link, or enter the bundle identifier yourself. For Android, paste your Play Store link or enter the package name
4. Check the app name and icon. When you use a store link, they’re filled in for you
5. Choose the languages your surveys should support
6. Save. Your app now appears in the app switcher

All surveys you create belong to one app, so make sure the right app is selected in the app switcher before creating surveys.

API keys

Your app needs an API key to talk to WhiskrKit. Go to API Keys in the sidebar to create one, and use it in your initialize call:

WhiskrKit.shared.initialize(
    apiKey: "wk_live_your_api_key",
)

Each app can have two active keys at a time, so you can rotate a key without downtime: create a new one, ship it, then revoke the old one. API keys are only visible to admins and owners.

Keep your API keys private. Do not commit them to source control.

Note

As long as WhiskrKit is in beta, only wk_test_ keys are possible. When WhiskrKit reaches production you will be able to separate test from production data.

Creating a survey

1. Select your app in the app switcher
2. Go to Surveys and click New Survey
3. Choose a survey type: NPS, star rating, thumbs up/down, textual, or multiple choice
4. Set your question text and any follow-up question
5. Choose a presentation style: sheet, toast, or full-screen cover
6. Add targeting rules (see below)
7. Save

The survey identifier

Every survey has an identifier. This is what you pass to .whiskrKitSurvey(identifier:) or present(surveyId:) in your app. It’s generated from the title, and you can change it while creating the survey.

Later on you can still change it on the survey’s Details tab, as long as the survey has no responses yet. After the first response it’s locked, because apps in your users’ hands already use it.

Multiple choice surveys

Multiple choice surveys have a few additional configuration options compared to other types.

After choosing Multiple choice as your survey type, you will:

• Add answer options: enter each option and its label. Options support the same localization as your question text, so you can provide translations per language.
• Choose a selection mode: single select allows respondents to pick one answer; multi-select allows them to pick one or more. This is configured with the Allow multiple selections toggle.

Note

Multiple choice surveys require at least two answer options before they can be saved.

Targeting rules

Targeting rules decide who sees a survey and when. Configure them per survey on the Targeting tab. A survey is only shown when all of its rules match.

• Minimum Sessions: the user has opened your app at least this many times
• Days Since Install: the app has been installed for at least this many days
• Cooldown Period: at least this many days have passed since the user saw any survey
• Minimum App Version: the user runs at least this version of your app, optionally per platform
• Allowed Locales: only show to users with one of these languages
• Allowed Platforms: only show on iOS, only on Android, or both
• Sample Rate: only show to a percentage of eligible users. The same device always gets the same answer
• Days of Week: only show on the selected days

Caution

A survey without any targeting rules is not shown automatically to anyone. This is on purpose, so a survey can’t reach your whole user base by accident. Surveys you open yourself with present(surveyId:) are always shown, whatever the rules.

Repeat behaviour

Under Repeat Behavior you choose how often the same user can see a survey:

• Once: a single time per device
• Cooldown: again after a waiting period you choose, in days
• Always: every time the targeting rules match

Changes to targeting rules and repeat behaviour take effect immediately, without an app update.

Survey priority

When a user qualifies for more than one survey, the order on the Survey Priority page decides which one comes first. Drag the surveys into the order you want.

Viewing responses

Open a survey to see its responses. At the top you’ll find the totals: the number of responses, averages, how often the survey was shown and its conversion, the share of showings that led to a response. Times your app opened the survey directly with present(surveyId:) are counted separately as manual.

Below that are the individual submissions. Filter them by date range, score, platform and app version to zoom in on a specific group.

For multiple choice surveys, the overview also shows a breakdown of selections per option, so you can see at a glance which answers are most popular.

Response data accumulates over time. Trends become more meaningful after several weeks of data, as you can compare across app versions, seasons, or feature releases.

Your profile

Click your name at the bottom of the sidebar to open your profile. There you can:

• Manage your email address, password, passkeys and active sessions
• Set your display name, avatar and timezone
• Choose which emails you receive from us

If you belong to more than one organization, switch between them with the organization name at the top of the sidebar, or under More → Organization on your phone. See Working in more than one organization.