Skip to content

Commit 8e55a0b

Browse files
authored
Merge pull request #3436 from segmentio/iterate-actions-documentation
Iterate actions documentation
2 parents b1017ea + a8c83b6 commit 8e55a0b

File tree

1 file changed

+83
-0
lines changed
  • src/connections/destinations/catalog/actions-iterate

1 file changed

+83
-0
lines changed
Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
---
2+
title: Iterate (Actions) Destination
3+
hide-boilerplate: true
4+
hide-dossier: true
5+
hidden: true
6+
private: true
7+
id: 62fec615a42fa3dbfd208ce7
8+
---
9+
10+
11+
{% include content/plan-grid.md name="actions" %}
12+
13+
<!-- Include a brief description of the destination here, along with a link to your website. -->
14+
[Iterate](https://iteratehq.com){:target="_blank"} helps you harness customer insights across your whole business with the world’s leading Customer Insights Manager. Put customer insights at the center of your business with user-friendly research tools that look and feel like your brand. With mobile, website and email surveys that are highly targeted, user-friendly, and on-brand, you can learn directly from your visitors, customers, and users.
15+
16+
Iterate maintains this destination. See [Iterate's documentation](http://help.iteratehq.com/en/articles/6515486-segment-integration){:target="_blank"} or contact [[email protected]](mailto:[email protected]) with any questions.
17+
18+
<!-- This include describes the requirement of A.js 2.0 or higher for Actions compatibility, and is required if your destination has a web component. -->
19+
20+
{% include content/ajs-upgrade.md %}
21+
22+
<!-- In the section below, explain the value of this actions-based destination. If you don't have a classic version of the destination, remove this section. -->
23+
24+
## Benefits of Iterate (Actions)
25+
26+
Iterate (Actions) provides the following benefits:
27+
28+
- **Simple setup** - Iterate (Actions) has a streamlined default setup process making it easier to get started in a way that "just works".
29+
- **More control** - Actions-based destinations enable you to define the mapping between the data Segment receives from your sources, and the data Segment sends to Iterate.
30+
- **Default property mappings** - Default mappings from the Segment like userId, userTraits, and more, allow data to be mapped correctly without any setup required.
31+
32+
<!-- The section below explains how to enable and configure the destination. Include any configuration steps not captured below. For example, obtaining an API key from your platform and any configuration steps required to connect to the destination. -->
33+
34+
## Getting started
35+
36+
1. From the Segment web app, navigate to **Connections > Catalog > Destinations**.
37+
2. Click the **Destination Actions** category item in the left navigation.
38+
3. Search for *Iterate (Actions)* and select it.
39+
4. Click **Configure Iterate (Actions)**.
40+
5. Select an existing Source to connect to Iterate (Actions).
41+
6. Set your Embed API Key. See [Getting your Embed API Key](#getting-your-embed-api-key) for details.
42+
43+
<!-- The line below renders a table of connection settings (if applicable), Pre-built Mappings, and available actions. -->
44+
45+
{% include components/actions-fields.html %}
46+
47+
<!--
48+
Additional Context
49+
50+
Include additional information that you think will be useful to the user here. For information that is specific to an individual mapping, please add that as a comment so that the Segment docs team can include it in the auto-generated content for that mapping.
51+
-->
52+
53+
## Get your Embed API Key
54+
55+
To get your Embed API Key:
56+
1. Log in to Iterate.
57+
2. Create a Website survey.
58+
3. Click **Preview and publish**.
59+
4. In the 'Embed your survey script' section, select the value of the 'apiKey' property in the embed code.
60+
61+
## Create and configure your Iterate survey
62+
63+
Once the Iterate (Actions) destination is configured, you're ready to create your survey and display it in response to an event. To create and configure your Iterate survey:
64+
65+
1. Log in to your Iterate account.
66+
2. Create a new website survey. Learn more about [setting up your website survey](https://help.iteratehq.com/en/articles/2835011-creating-a-website-survey){:target="_blank"}.
67+
3. Add questions to your survey.
68+
4. Customize your survey.
69+
5. Enable event targeting.
70+
1. Click the **targeting options** tab.
71+
2. In the **Where the survey is displayed** section select **In response to an event**.
72+
3. Enter the name of the event(s) you would like to trigger this survey to be displayed.
73+
6. Choose the rest of your your targeting options.
74+
7. Test your survey.
75+
1. Click **Preview and publish**.
76+
2. Copy the `iterate_preview` parameter from the **Test your survey** section.
77+
3. Go to your website and add the `iterate_preview` parameter to the url.
78+
4. Trigger one of the events you are targeting to get the survey to display.
79+
7. Publish your survey.
80+
81+
## Associate user data with your survey
82+
83+
You can associate user data with the responses to your survey by using the [Segment Identify](docs/connections/spec/identify/) call. Any data sent in this call associates with that user's responses to all surveys.

0 commit comments

Comments
 (0)