Skip to content
Open Screeb

Assign your users to groups such as a company, a plan or a cohort, so you can target and analyze them by group.

A group gathers users who share something: the company they work for, their plan, a cohort. A user can belong to several groups. In Screeb, you then target surveys and messages on group membership. Groups are also how segments get users from your code: see Create user segments.

A group has a type (company, plan) and a name (Apple, Growth). The type is optional: without one, the group gets the default type.

import app.screeb.sdk.kmp.Screeb
Screeb.assignGroup(groupType = "company", groupName = "Apple")
Screeb.assignGroup(groupType = "plan", groupName = "Growth")
Screeb.assignGroup(groupName = "cohort-42") // default group type

The group type and the group name are less than 128 characters. They contain letters, digits, spaces and the characters -, _, ., / and :. The user must be known to Screeb first: assign groups after the SDK has started.

Properties describe the group. Identify the group by an id that never changes rather than by its display name, and send the name as a property:

Screeb.assignGroup(
groupType = "company",
groupName = "nuR4eecu",
properties = mapOf(
"name" to "Apple",
"city" to "Cupertino",
"employees" to 160000,
),
)

A group has at most 1000 properties. Property names are 128 characters at most. Values are strings, numbers, booleans or dates.

Screeb.unassignGroup(groupType = "company", groupName = "nuR4eecu")