For the complete documentation index, see llms.txt.

Track custom variables

Dernière mise à jour Voir en Markdown

Custom variables attach additional information about the screen, user, or session to screenview events. For example, they can include information on the current layout of a screen, like day/night mode.

To define and send custom variables, follow this:

CSQ.trackScreenview("screen_name", cvars: [
CustomVar(key: "key1", value: "value1"),
CustomVar(key: "key2", value: "value2"),
])
  • It is possible to save up to 20 distinct custom variables per screenview. If more are received, only the first 20 custom variables, based on their index value, will be kept.
  • The index value of the custom variable is used to determine which custom variables to be kept. Only index value between 1 and 20 will be taken into account.
  • Every custom variable is composed of index, name and value.
  • If you are using the same index twice in the same screen, only the first (name, value) pair associated with the index will be kept.
  • In case name(max. 512 characters) or value(max. 255 characters) maximum character length is reached, the SDK will automatically trim the exceeding characters.
  • If name or value are empty, the SDK will instead send the literal string "cs-empty".
  • Use a consistent index for a given custom var within an application — for instance, if the "screen layout" is collected with an index of 3, use the slot 3 for this information on every screen of the application.