analytics packages
There is a set of official Analytics Frontity packages that you can use to easily add web analytics services to your project.
These packages are:
Table of Contents
Installation
Install the analytics package you need for your project:
Settings
Each package will require some custom configuration to add things such as the tracking IDs for the services behind. In the description of each package you'll find the details of each configuration:
Once we have properly installed and configured these
analytics packages, their actions will be centralized by the analytics namespace.In
frontity.settings.js we can enable/disable specific analytics packages for pageviews or events through the following properties in the state (under the analytics namespace):state.analytics.pageviewsstate.analytics.events
These properties can be set directly in
frontity.settings.js from state.analytics...1
const settings = {
2
name: ...,
3
state: {
4
frontity: {...},
5
analytics: {
6
pageviews: {
7
googleAnalytics: false,
8
comscoreAnalytics: true,
9
},
10
events: {
11
googleAnalytics: true,
12
comscoreAnalytics: false,
13
}
14
},
15
},
16
packages: [{...}, {...}]
17
};
18
19
export default settings;
Copied!
Or from each Analytics package setting...
1
const settings = {
2
...,
3
packages: [
4
{
5
name: "@frontity/google-analytics",
6
state: {
7
analytics: {
8
pageviews: { googleAnalytics: true },
9
events: { googleAnalytics: true }
10
},
11
},
12
},
13
{
14
name: "@frontity/comscoreAnalytics",
15
state: {
16
analytics: {
17
pageviews: { comscoreAnalytics: false },
18
events: { comscoreAnalytics: false }
19
},
20
},
21
},
22
...
23
],
24
};
25
export default settings;
Copied!
state.analytics.pageviews
state.analytics.pageviewsMap of Analytics packages namespaces with boolean values.
This object is used by
actions.analytics.pageview to know which analytics packages should send the pageview to their respective services.If you want to disable sending pageviews for a specific analytics package, the respective namespace of that package should be set here to
false.All analytics namespaces will be
true by default in this setting.state.analytics.events
state.analytics.eventsMap of Analytics packages namespaces with boolean values.
This object is used by
actions.analytics.event to know which analytics packages should send the event to their respective services.If you want to disable sending events for a specific analytics package, the respective namespace of that package should be set here to
false.All analytics namespaces will be
true by default in this setting.How to use
Once everything is properly configured, the following
actions under the namespace analytics will be ready to be used:actions.analytics.pageviewactions.analytics.event
actions.analytics.pageview
actions.analytics.pageviewSend a pageview to all active analytics packages.
This action takes all namespaces defined in
state.analytics.pageviews that are true and calls the pageview action of each one with the specified Pageview object.actions.analytics.pageview is automatically launched every time link changes (or every time action.router.set(link) is launched).This action is is not meant to be called directly but in case you still want to do this it would be something like this:
1
actions.analytics.pageview({
2
link: "/2016/the-beauties-of-gullfoss",
3
title: "The Beauties Of Gullfoss",
4
});
Copied!
actions.analytics.event
actions.analytics.eventSend an event to all enabled analytics packages.
This action takes all namespaces defined in
state.analytics.events that are true and calls the event action of each one with the specified Event object.This is the method you can call from any component of your React app to track specific events.
Example:
1
actions.analytics.event({
2
name: "click",
3
payload: {
4
category: "video",
5
label: "featured-media",
6
},
7
});
Copied!
The
actions.analytics.event() must receive an event object with the following properties.Name
Type
Required
Description
namestring
yes
The value of this property is mapped to the proper name event of each analytics package
payloadobject
yes
Event payload.
This method will send the event tracking information to all the packages enabled in
state.analytics.events.Each package will handle the information sent through this
actions.analytics.event() in a different way:Last modified 1yr ago