Skip to content

Button Used ​

Button Used is the general-purpose interaction event. It is also the first step of most golden funnels.

Status: sent today

The mobile app, TV apps, and web embeds send Button Used.

Button Used ​

Description: Fired whenever a button is tapped leading to some other action.

Destinations: BigQuery, HubSpot (selective), Amplitude.

Section properties: when a link is opened externally from a feed Section (action open-url, component Link), the event also includes the properties below. They are left out when the link isn't in a Section. Added in APO-12058.

  • sectionId (String, optional): ID of the feed Section (the feature's own ID, e.g. HorizontalCardListFeature:<base64>).
  • sectionLayout (String, optional): feature type of the Section, e.g. HeroListFeature, HorizontalCardListFeature.
  • sectionTitle (String, optional): display title of the Section, e.g. "Featured".
  • position (Integer, optional): zero-based index of the tapped item within its Section.
PropertyTypeRequiredDescription
labelStringYesFriendly text (if applicable) of the action taken by the user.
actionStringYesThe technical term for the action taken by the user.
componentStringYesPart of the page/screen that was acted on by the user.
component_urlStringNoThe URL of the button (if applicable).
user_idStringYesInternal unique identifier for the individual performing the event.
group_idStringYesInternal unique identifier for the organization of the individual performing the event (church slug).
emailStringYesEmail for the individual performing the event.
phoneStringYesPhone for the individual performing the event.
is_logged_inBooleanYesIf the user was logged in when performing the event.

Implementation example:

javascript
analytics.track("Button Used", {
  label: "Create Your Own Hero",
  action: "Tapped",
  component: "Button",
  component_url: "https://megamind-supervillain-plans.com/",
  user_id: "2087903",
  group_id: "megaminds-lair",
  email: "masterofallvillany2000@megamindcorp.com",
  // Only when the link was opened from inside a feed Section:
  sectionId: "HorizontalCardListFeature:eyJhbGdvcml0aG1zIj...",
  sectionLayout: "HorizontalCardListFeature",
  sectionTitle: "Featured",
  position: 0,
});

Apollos Platform Documentation