The group method is designed to track group-related activities within an application. It collects data about group interactions based on provided parameters and logs this information for analytical purposes, provided the user has opted in and the data is valid.

Usage Example

const groupParams = {
  accountId: '12345',
  eventTitle: 'New User Group',
  accountAttributes: {
    leader: 'John Doe',
    size: 10
  }
};

intempt.group(groupParams);

In this example, the group method is used to log information about a new user group, including details about the group leader and size.

Declaration

The group method is declared as follows in TypeScript, indicating that it does not return any value:

group(params:GroupParams):void

Params

The parameters for the group method are defined by the GroupParams type, which allows for detailed user tracking and event categorization:

type GroupParams = {
  accountId: string,
  eventTitle?: string,
  accountAttributes?: {[key:string]:any}
}

Forbidden event names for use

Certain event names are reserved or forbidden to prevent conflicts or misidentification in the tracking system. They include common actions and default functionalities that are automatically tracked or handled differently:

• auto-track: Reserved for automatic tracking mechanisms.
• view page: Used specifically for page view tracking.
• leave page: Indicates a user leaving a page, automatically tracked.
• change on: Indicates a user leaving a page, automatically tracked.
• click on: Indicates a user leaving a page, automatically tracked.
• submit on: Used for tracking form submissions.
• identify: Special use within the identify function itself.
• consent: Special use within the identify function itself.

These names should not be used as custom event titles to avoid system errors and ensure accurate event categorization and analysis.