Skip to content

Commit edb89ed

Browse files
author
markzegarelli
authored
Merge pull request #1862 from segmentio/DOC-318_fullstory-actions
DOC 318 fullstory actions
2 parents b2ca4d7 + b4caf8f commit edb89ed

File tree

6 files changed

+156
-9
lines changed

6 files changed

+156
-9
lines changed

‎src/_data/actions/fullstory.yml

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
config:
2+
- category: Connection Settings
3+
settings:
4+
- name: FS Org
5+
connection_mode:
6+
- device-web
7+
configurable: true
8+
location:
9+
notes: Set during initial configuration, or on the Settings tab after you create the destination.
10+
- category: Other Settings
11+
settings:
12+
- name: Enter FS debug mode
13+
connection_mode:
14+
- device-web
15+
configurable: true
16+
location:
17+
notes: Available on the Settings tab of the destination.
18+
- name: Track All Pages
19+
connection_mode:
20+
- device-web
21+
configurable: true
22+
location:
23+
notes: Available as a subscription where the trigger `Event Type is Page` triggers the Viewed Page action.
24+
- name: Track Categorized Pages
25+
connection_mode:
26+
- device-web
27+
configurable: false
28+
location:
29+
notes:
30+
- name: Track Named Pages
31+
connection_mode:
32+
- device-web
33+
configurable: false
34+
location:
35+
notes:
36+
actions:
37+
- action: Identify User
38+
blurb: Set user identity variables.
39+
fields:
40+
- name: userId
41+
description: The user's ID in FullStory.
42+
default: userId
43+
- name: anonymous
44+
description: The user's anonymousId in FullStory.
45+
default: anonymousId
46+
- name: displayName
47+
description: The user's display name.
48+
default: traits.name
49+
- name: email
50+
description: The user's email address.
51+
default: traits.email
52+
- name: traits
53+
description: The Segment traits forwarded to FullStory.
54+
default: traits
55+
- action: Track Event
56+
blurb: Send event details to FullStory.
57+
fields:
58+
- name: name
59+
description: The name of the event
60+
default: name
61+
- name: properties
62+
description: A JSON object that contains additional information about the event, and is indexed by FullStory.
63+
default: properties
64+
- action: Viewed Page
65+
blurb: Set the properties of a page event, and send them to FullStory.
66+
fields:
67+
- name: name
68+
description: The name of the viewed page.
69+
default: name
70+
- name: category
71+
description: The category of the viewed page
72+
default: category
73+
- name: properties
74+
description: The properties of the viewed page.
75+
default: properties
76+
settings:
77+
- category: Connection Settings
78+
settings:
79+
- name: Debug mode
80+
description: Enables FullStory debug mode
81+
default: off
82+
- name: FS Org (required)
83+
description: The organization ID for FullStory
84+
default:
85+

‎src/_includes/content/spec-field-page-category.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
<tr>
2+
<td markdown="span">`category`</td>
3+
<td markdown="span">*optional*</td>
4+
<td markdown="span">String</td>
5+
<td markdown="span">The category of the page, added to the properties object.
6+
7+
Passed as the first argument in a page call, for example `analytics.page("category", "name");`</td>
8+
</tr>

‎src/connections/destinations/catalog/actions-amplitude/index.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -94,12 +94,12 @@ By default a new Amplitude (Actions) destination comes with the following subscr
9494

9595
You can select these subscriptions by choosing "Quick Setup" when you first configure the destination. You can enable, edit, and disable them from the screen that appears.
9696

97-
| Subscription Name | Trigger | Amplitude Action | Non-default mapped fields |
98-
| ----------------- | ------------------------------------------------ | ---------------- | -------------------------------------------------------------- |
99-
| Track Calls | All **track** calls from the connected source | Log Event | Event Type = `event`<br>for example, `Order Completed` |
100-
| Page Calls | All **page** calls from the connected source | Log Event | Event Type = Viewed `name`<br>for example, `Viewed Homepage` |
101-
| Screen Calls | All **screen** calls from the connected source | Log Event | Event Type = Viewed `name`<br>for example, `Viewed Homescreen` |
102-
| Identify Calls | All **identify** calls from the connected source | Identify User | |
97+
| Subscription Name | Trigger | Amplitude Action |
98+
| ----------------- | ------------------------------------------------ | ---------------- |
99+
| Track Calls | All **track** calls from the connected source | Log Event |
100+
| Page Calls | All **page** calls from the connected source | Log Event |
101+
| Screen Calls | All **screen** calls from the connected source | Log Event |
102+
| Identify Calls | All **identify** calls from the connected source | Identify User |
103103

104104
## Available Amplitude Actions
105105

‎src/connections/destinations/catalog/actions-fullstory/index.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
title: Fullstory (Actions)
3+
hide-boilerplate: true
4+
hide-dossier: true
5+
---
6+
{% include content/plan-grid.md name="actions" %}
7+
8+
[FullStory](https://www.fullstory.com/){:target="_blank"} lets product and support teams easily understand everything about the customer experience. The Segment integration for FullStory helps accurately identify your customers within the FullStory dashboard.
9+
10+
> info ""
11+
> This document is about a feature which is in beta. This means that the Destination Actions are in active development, and some functionality may change before it becomes generally available
12+
13+
14+
> success ""
15+
> **Good to know**: This page is about the [Actions-framework](/docs/connections/destinations/actions/) FullStory Segment destination. There's also a page about the [non-Actions FullStory destination](/docs/connections/destinations/catalog/fullstory/). Both of these destinations receives data from Segment.
16+
17+
18+
19+
## Getting started
20+
21+
1. From the Segment web app, click **Catalog**, then click **Destinations**.
22+
2. Find the Destinations Actions item in the left navigation, and click it.
23+
3. Select FullStory (Actions), then click **Configure FullStory (Actions)**.
24+
4. Select an existing Source to connect to FullStory (Actions).
25+
5. Click Customized Setup to start from a blank mapping.
26+
27+
{% include components/actions-fields.html name="fullstory" connection="true" %}
28+
29+
30+
## Pre-built subscriptions
31+
32+
By default a new FullStory (Actions) destination comes with the following subscriptions.
33+
34+
You can select these subscriptions by choosing "Quick Setup" when you first configure the destination. You can enable, edit, and disable them from the screen that appears.
35+
36+
| Subscription Name | Trigger | FullStory Action |
37+
| ----------------- | ------------------------------------------------ | ---------------- |
38+
| Identify User | All **identify** calls from the connected source | Identify User |
39+
| Track Event | All **track** calls from the connected source | Track Event |
40+
| Track Page Events | All **page** calls from the connected source | Track Event |
41+
42+
## Available FullStory actions
43+
44+
Combine the supported [triggers](/docs/connections/destinations/actions/#components-of-a-destination-action) with the following FullStory-supported actions:
45+
- [Identify User](#identify-user)
46+
- [Track Event](#track-event)
47+
- [Viewed Page](#viewed-page)
48+
49+
{% include components/actions-fields.html name="fullstory" %}
50+
51+
## Migration from the classic FullStory destination
52+
53+
Follow the table below to map your existing FullStory destination configuration to FullStory (Actions).
54+
55+
{% include components/actions-map-table.html name="fullstory" %}

‎src/connections/destinations/catalog/fullstory/index.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@ rewrite: true
44
---
55
[FullStory](https://help.fullstory.com/11269-Develop) lets product and support teams easily understand everything about the customer experience. The Segment integration for FullStory helps accurately identify your customers within the FullStory dashboard.
66

7-
This document was last updated on January 25, 2018. If you notice any gaps, outdated information or simply want to leave some feedback to help us improve our documentation, [let us know](https://segment.com/help/contact)!
8-
97
## Getting Started
108

119
{% include content/connection-modes.md %}

‎src/connections/spec/page.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,14 @@ Here's the payload of a typical `page` call with most [common fields](/docs/conn
2424
And here's the corresponding Javascript event that would generate the above payload. If you're using Segment's Javascript library, the page name and URL are automatically gathered and passed as properties into the event payload:
2525

2626
```js
27-
analytics.page("Home");
27+
analytics.page("Retail Page","Home");
2828
```
2929

3030
Beyond the common fields, the `page` call takes the following fields:
3131

3232
<table>
3333
{% include content/spec-table-header.md %}
34+
{% include content/spec-field-page-category.md %}
3435
{% include content/spec-field-page-name.md %}
3536
{% include content/spec-field-page-properties.md %}
3637
</table>

0 commit comments

Comments
 (0)