Variable eventsConst

events: {
    "help.breadcrumb.clicked": (
        payloads: HelpBreadcrumbClicked,
    ) => DLStructured;
    "help.contactoption.clicked": (
        payloads: HelpContactOptionClicked,
    ) => DLStructured;
    "help.furthersupport_article.clicked": (
        payloads: HelpFurtherSupportArticleClicked,
    ) => DLStructured;
    "help.furthersupport_category.expanded": (
        payloads: HelpFurtherSupportCategoryExpanded,
    ) => DLStructured;
    "help.helptopics_topic.clicked": (
        payloads: HelpHelpTopicsTopicClicked,
    ) => DLStructured;
    "help.mainCTA.clicked": (payloads: HelpMainCTAClicked) => DLStructured;
    "help.page.view": (payloads: HelpPageView) => void;
    "help.related_topic.clicked": (
        payloads: HelpRelatedTopicClicked,
    ) => DLStructured;
    "help.search.focus": () => DLStructured;
    "help.search.submit": (payloads: HelpSearchSubmit) => DLStructured;
    "help.section_link.clicked": (
        payloads: HelpSectionLinkClicked,
    ) => DLStructured;
    "help.selfservice_category.clicked": (
        payloads: HelpSelfServiceCategoryClicked,
    ) => DLStructured;
    "help.subsection.expanded": (
        payloads: HelpSubsectionExpanded,
    ) => DLStructured;
    "help.tableofcontents_link.clicked": (
        payloads: HelpTableOfContentsLinkClicked,
    ) => DLStructured;
    "help.webchat_button.clicked": () => DLStructured;
    "webchat.start": (payloads: WebchatStart) => DLStructured;
} = ...

List of help events

Type declaration

  • help.breadcrumb.clicked: (payloads: HelpBreadcrumbClicked) => DLStructured

    help.breadcrumb.clicked event

    Example

    DataLayer Event example

    {
      event: 'ga_event',
      eventCategory: 'Help',
      eventAction: 'help.breadcrumb.clicked',
      eventLabel: 'breadcrumb-title',
      eventProperty: '{"href":"/help/page"}'
    }

    Example

    SQL Query Example

    SELECT
       *
    FROM
       LAMBDA_DB.CUSTOMER_JOURNEY_MODELLED.STRUCTURED_EVENTS
    WHERE se_category = 'Help' AND se_action = 'help.breadcrumb.clicked'
      AND event_date BETWEEN CURRENT_DATE - 3 AND CURRENT_DATE
  • help.contactoption.clicked: (payloads: HelpContactOptionClicked) => DLStructured

    help.contactoption.clicked event

    Example

    DataLayer Event example

    {
      event: 'ga_event',
      eventCategory: 'Help',
      eventAction: 'help.contactoption.clicked',
      eventLabel: 'contact-type'
    }

    Example

    SQL Query Example

    SELECT
       *
    FROM
       LAMBDA_DB.CUSTOMER_JOURNEY_MODELLED.STRUCTURED_EVENTS
    WHERE se_category = 'Help' AND se_action = 'help.contactoption.clicked'
      AND event_date BETWEEN CURRENT_DATE - 3 AND CURRENT_DATE
  • help.furthersupport_article.clicked: (payloads: HelpFurtherSupportArticleClicked) => DLStructured

    help.furthersupport_article.clicked event

    Example

    DataLayer Event example

    {
      event: 'ga_event',
      eventCategory: 'Help',
      eventAction: 'help.furthersupport_article.clicked',
      eventLabel: 'Category - Article Title',
      eventProperty: '{"href":"/help/article"}'
    }

    Example

    SQL Query Example

    SELECT
       *
    FROM
       LAMBDA_DB.CUSTOMER_JOURNEY_MODELLED.STRUCTURED_EVENTS
    WHERE se_category = 'Help' AND se_action = 'help.furthersupport_article.clicked'
      AND event_date BETWEEN CURRENT_DATE - 3 AND CURRENT_DATE
  • help.furthersupport_category.expanded: (payloads: HelpFurtherSupportCategoryExpanded) => DLStructured

    help.furthersupport_category.expanded event

    Example

    DataLayer Event example

    {
      event: 'ga_event',
      eventCategory: 'Help',
      eventAction: 'help.furthersupport_category.expanded',
      eventLabel: 'category-title'
    }

    Example

    SQL Query Example

    SELECT
       *
    FROM
       LAMBDA_DB.CUSTOMER_JOURNEY_MODELLED.STRUCTURED_EVENTS
    WHERE se_category = 'Help' AND se_action = 'help.furthersupport_category.expanded'
      AND event_date BETWEEN CURRENT_DATE - 3 AND CURRENT_DATE
  • help.helptopics_topic.clicked: (payloads: HelpHelpTopicsTopicClicked) => DLStructured

    help.helptopics_topic.clicked event

    Example

    DataLayer Event example

    {
      event: 'ga_event',
      eventCategory: 'Help',
      eventAction: 'help.helptopics_topic.clicked',
      eventLabel: 'Category - Topic Title',
      eventProperty: '/help/topic'
    }

    Example

    SQL Query Example

    SELECT
       *
    FROM
       LAMBDA_DB.CUSTOMER_JOURNEY_MODELLED.STRUCTURED_EVENTS
    WHERE se_category = 'Help' AND se_action = 'help.helptopics_topic.clicked'
      AND event_date BETWEEN CURRENT_DATE - 3 AND CURRENT_DATE
  • help.mainCTA.clicked: (payloads: HelpMainCTAClicked) => DLStructured

    help.mainCTA.clicked event

    Example

    DataLayer Event example

    {
      event: 'ga_event',
      eventCategory: 'Help',
      eventAction: 'help.mainCTA.clicked',
      eventLabel: '/help/page'
    }

    Example

    SQL Query Example

    SELECT
       *
    FROM
       LAMBDA_DB.CUSTOMER_JOURNEY_MODELLED.STRUCTURED_EVENTS
    WHERE se_category = 'Help' AND se_action = 'help.mainCTA.clicked'
      AND event_date BETWEEN CURRENT_DATE - 3 AND CURRENT_DATE
  • help.page.view: (payloads: HelpPageView) => void

    help.page.view event Pushes a content_group to the dataLayer for GA4 content grouping. This is a raw dataLayer push, not a ga_event.

    Example

    DataLayer Event example

    {
      content_group: 'Help_TopicPage'
    }

    Remarks

    This event is NOT tracked in STRUCTURED_EVENTS. It is a raw GA4 dataLayer push and can be found in the GA4 BigQuery export under the content_group parameter.

  • help.related_topic.clicked: (payloads: HelpRelatedTopicClicked) => DLStructured

    help.related_topic.clicked event

    Example

    DataLayer Event example

    {
      event: 'ga_event',
      eventCategory: 'Help',
      eventAction: 'help.related_topic.clicked',
      eventLabel: 'topic-title',
      eventProperty: '/help/topic'
    }

    Example

    SQL Query Example

    SELECT
       *
    FROM
       LAMBDA_DB.CUSTOMER_JOURNEY_MODELLED.STRUCTURED_EVENTS
    WHERE se_category = 'Help' AND se_action = 'help.related_topic.clicked'
      AND event_date BETWEEN CURRENT_DATE - 3 AND CURRENT_DATE
  • help.search.focus: () => DLStructured

    help.search.focus event

    Example

    DataLayer Event example

    {
      event: 'ga_event',
      eventCategory: 'Help',
      eventAction: 'help.search.focus'
    }

    Example

    SQL Query Example

    SELECT
       *
    FROM
       LAMBDA_DB.CUSTOMER_JOURNEY_MODELLED.STRUCTURED_EVENTS
    WHERE se_category = 'Help' AND se_action = 'help.search.focus'
      AND event_date BETWEEN CURRENT_DATE - 3 AND CURRENT_DATE
  • help.search.submit: (payloads: HelpSearchSubmit) => DLStructured

    help.search.submit event

    Example

    DataLayer Event example

    {
      event: 'ga_event',
      eventCategory: 'Help',
      eventAction: 'help.search.submit',
      eventLabel: 'search-term'
    }

    Example

    SQL Query Example

    SELECT
       *
    FROM
       LAMBDA_DB.CUSTOMER_JOURNEY_MODELLED.STRUCTURED_EVENTS
    WHERE se_category = 'Help' AND se_action = 'help.search.submit'
      AND event_date BETWEEN CURRENT_DATE - 3 AND CURRENT_DATE
  • help.section_link.clicked: (payloads: HelpSectionLinkClicked) => DLStructured

    help.section_link.clicked event

    Example

    DataLayer Event example

    {
      event: 'ga_event',
      eventCategory: 'Help',
      eventAction: 'help.section_link.clicked',
      eventLabel: '/help/page'
    }

    Example

    SQL Query Example

    SELECT
       *
    FROM
       LAMBDA_DB.CUSTOMER_JOURNEY_MODELLED.STRUCTURED_EVENTS
    WHERE se_category = 'Help' AND se_action = 'help.section_link.clicked'
      AND event_date BETWEEN CURRENT_DATE - 3 AND CURRENT_DATE
  • help.selfservice_category.clicked: (payloads: HelpSelfServiceCategoryClicked) => DLStructured

    help.selfservice_category.clicked event

    Example

    DataLayer Event example

    {
      event: 'ga_event',
      eventCategory: 'Help',
      eventAction: 'help.selfservice_category.clicked',
      eventLabel: 'icon-name',
      eventProperty: '{"title":"category-title","href":"/help/category"}'
    }

    Example

    SQL Query Example

    SELECT
       *
    FROM
       LAMBDA_DB.CUSTOMER_JOURNEY_MODELLED.STRUCTURED_EVENTS
    WHERE se_category = 'Help' AND se_action = 'help.selfservice_category.clicked'
      AND event_date BETWEEN CURRENT_DATE - 3 AND CURRENT_DATE
  • help.subsection.expanded: (payloads: HelpSubsectionExpanded) => DLStructured

    help.subsection.expanded event

    Example

    DataLayer Event example

    {
      event: 'ga_event',
      eventCategory: 'Help',
      eventAction: 'help.subsection.expanded',
      eventLabel: 'Section Title - Subsection Title'
    }

    Example

    SQL Query Example

    SELECT
       *
    FROM
       LAMBDA_DB.CUSTOMER_JOURNEY_MODELLED.STRUCTURED_EVENTS
    WHERE se_category = 'Help' AND se_action = 'help.subsection.expanded'
      AND event_date BETWEEN CURRENT_DATE - 3 AND CURRENT_DATE
  • help.tableofcontents_link.clicked: (payloads: HelpTableOfContentsLinkClicked) => DLStructured

    help.tableofcontents_link.clicked event

    Example

    DataLayer Event example

    {
      event: 'ga_event',
      eventCategory: 'Help',
      eventAction: 'help.tableofcontents_link.clicked',
      eventLabel: 'link-title'
    }

    Example

    SQL Query Example

    SELECT
       *
    FROM
       LAMBDA_DB.CUSTOMER_JOURNEY_MODELLED.STRUCTURED_EVENTS
    WHERE se_category = 'Help' AND se_action = 'help.tableofcontents_link.clicked'
      AND event_date BETWEEN CURRENT_DATE - 3 AND CURRENT_DATE
  • help.webchat_button.clicked: () => DLStructured

    help.webchat_button.clicked event

    Example

    DataLayer Event example

    {
      event: 'ga_event',
      eventCategory: 'Help',
      eventAction: 'help.webchat_button.clicked'
    }

    Example

    SQL Query Example

    SELECT
       *
    FROM
       LAMBDA_DB.CUSTOMER_JOURNEY_MODELLED.STRUCTURED_EVENTS
    WHERE se_category = 'Help' AND se_action = 'help.webchat_button.clicked'
      AND event_date BETWEEN CURRENT_DATE - 3 AND CURRENT_DATE
  • webchat.start: (payloads: WebchatStart) => DLStructured

    webchat.start event

    Example

    DataLayer Event example

    {
      event: 'ga_event',
      eventCategory: 'WebChat',
      eventAction: 'webchat.start',
      eventProperty: '{"cognigy_session_id":"session-id","cognigy_user_id":"user-id","correlation_id":null}'
    }

    Example

    SQL Query Example

    SELECT
       *
    FROM
       LAMBDA_DB.CUSTOMER_JOURNEY_MODELLED.STRUCTURED_EVENTS
    WHERE se_category = 'WebChat' AND se_action = 'webchat.start'
      AND event_date BETWEEN CURRENT_DATE - 3 AND CURRENT_DATE

Settings

Member Visibility