The analytics build into the Frontify Style Guide already gives you a convenient way of how often your guidelines or parts of it are consumed by users. However, there is times you may want to dig deeper and get more insights on the type of users, what and where they download files, videos they watch or just how the navigate over your guidelines. This is when you need to hook up your analytics tool to Frontify. Here's how.

What is Segment?

Segment.com is a cloud service that allows you to connect business applications like Frontify to 200+ analytics applications like Google Analytics. By supporting Segment, we allow you to get insights on Style Guide usage in your system of choice.

Segment is free for up to 1'000 users per month. You'll need a Frontify Business subscription to use this feature.

How to prepare Segment for use in Frontify?

First, you have to create a new Segment account. After logging into Segment, you need to add a new JavaScript source with your Frontify domain as the "Website URL", e.g. "company-12345.frontify.com" or your custom domain.

Once you've added the new source, copy your Segment Key (You'll need it later) and create a new destination with "Add Destination".

Choose your preferred destination from a catalogue of 200+ applications e.g. Google Analytics.

How to enable Segment in a Style Guide?

Go to your Style Guide and open the General settings via Powerbar.

Scroll down to the "Segment" section and toggle "Enabled", then configure your Segment Key (see above) to enable tracking. You've successfully setup Segment integration and the data now flows into your destination system(s).

What is tracked?

Currently, we're tracking document, page and section views as well as the user login method, downloads and played videos. This allows you to analyse a variety of metrics regarding your Style Guide content, e.g. No of Views per Page, Read Time, Bounce Rate, Demographics & more. Please let us know if you need more metrics from your Style Guide.

How to test your Segment Integration

The best way to test your integration is in the segment debugger. Open your source and do some downloads on your Frontify styleguide. You should see tracking results in segment debugger instantly.

Please note: if you have any active privacy protection or adblocker extensions in your browser, segment won't be able to track your events.

Tracked default dimensions

  • Event Name (e.g. 'Download', 'Play')
  • Event Category (category, e.g 'styleguide image') 
  • Event Label (label, e.g. the filname of your download)

If you connect e.g. Google Analytics, this properties are displayed in all default reports.

Tracked custom dimensions

Custom dimensions can be sent to your destinations. For now the following dimensions are tracked: 

  • category (e.g. 'styleguide image')
  • block (e.g. 'image') 
  • filename (uploaded file, e.g. 'logo-2x.png') 
  • src (source of a video or download) 
  • url (visitor's current page, e.g. frontify.com/document/420)
  •  signup_mode (tracked per event and per anonymous session, e.g. 'SIMPLE') 
  • isAttachment (true if download is an attachment)
  • isViewer (true if event is tracked from the frontify detail viewer)

The tracked dimensions from a specific event are listed in the segment debugger. (see screenshot below). Also have a look at the available custom dimensions at sources -> schema -> tracks. They will show up as soon as they were triggered the first time. 

Connect custom dimensions

If you like to use some custom dimensions you have to add it to your destination configuration as well as to your analytics tool.

1. Configure your destination tool

E.g. for Google Analytics there are settings in admin -> custom definitions -> custom dimensions.

Further Informations: Google Analytics custom dimensions 

2. Configure Segment
E.g. for Google Analytics there is an option at the destination -> settings (sproket icon) -> 'Custom Dimensions'. Fill in the custom dimension names (E.g. 'url', 'filename', etc.) and a the index number.

Please note that this number has to be the corresponding Google Analytics custom dimension index.  

Further informations: Configure Segment for custom dimensions 

Display your custom dimensions 

The usage of cutom dimensions depends on your tool. E.g. in Google Analytics you have to create a custom report. Add there your custom dimensions and a metric, we recommend 'Total Events'.

Did this answer your question?