Segment
Setup
- 1.
- 2.During development and testing it is often helpful to use the debug version of analytics.js. Follow the instructions here to enable it.
- 3.Install the target:1npm install --save @redux-beacon/segmentCopied!
Usage
1
import Segment from '@redux-beacon/segment';
2
3
// Create or import an events map.
4
// See "getting started" pages for instructions.
5
6
const segment = Segment();
7
8
const segmentMiddleware = createMiddleware(eventsMap, segment);
9
const segmentMetaReducer = createMetaReducer(eventsMap, segment);
Copied!
Event Definitions
Don't see your event listed? Please submit a pull request to the Redux Beacon repository with the missing event. Use the source of the existing
event-helpers to guide your work. If you need any support feel free to make the pull request with all you're able to do. We can fill in the gaps from there.pageView
Docs:
1
import { trackPageView } from '@redux-beacon/segment';
2
3
const pageView = trackPageView((action, prevState, nextState) => {
4
return {
5
category: /* (optional) */
6
name: /* (optional) */
7
properties: /* (optional) */
8
options: /* (optional) */
9
};
10
});
Copied!
The last line of the tracking snippet
analytics.page(); hits Segment.io with a page view that matches the first loaded route. If you're tracking page views using Redux Beacon, be sure to remove this line so the initial page load isn't recorded twice.event
Docs:
1
import { trackEvent } from '@redux-beacon/segment';
2
3
const event = trackEvent((action, prevState, nextState) => {
4
return {
5
name: /* fill me in */,
6
properties: /* (optional) */,
7
options: /* (optional) */,
8
};
9
});
Copied!
alias
Docs:
1
import { setAlias } from '@redux-beacon/segment';
2
3
const alias = setAlias((action, prevState, nextState) => {
4
return {
5
userId: /* fill me in */,
6
previousId: /* (optional) */,
7
options: /* (optional) */,
8
};
9
});
Copied!
group
Docs:
1
import { setGroup } from '@redux-beacon/segment';
2
3
const group = setGroup((action, prevState, nextState) => {
4
return {
5
groupId: /* fill me in */,
6
traits: /* (optional) */,
7
options: /* (optional) */,
8
};
9
});
Copied!
identify
Docs:
1
import { identifyUser } from '@redux-beacon/segment';
2
3
const user = identifyUser((action, prevState, nextState) => {
4
return {
5
userId: /* (optional) */,
6
traits: /* (optional) */,
7
options: /* (optional) */,
8
};
9
});
Copied!
reset
Docs:
1
import { reset } from '@redux-beacon/segment';
2
3
const resetRequest = reset();
Copied!
Last modified 4yr ago