This preview of pull request 1639 is meant for internal use only.

UserIQ Destination

UserIQ quick info

UserIQ is in beta, and accepts Track, Page, Identify, Group, and Alias calls. If you reference it in the Integrations object, call it “useriq", or "UserIQ”.

UserIQ accepts cloud-mode data from all Segment source types. It does not offer device-mode connections.

UserIQ empowers companies to deliver what each user needs to be successful in every moment, starting with adoption. Our platform collects user engagement data from your product and allows you to communicate to your users when they are most engaged: within the product itself.

This destination is maintained by UserIQ. For any issues with the destination, contact the UserIQ Support team.

This document is about a destination which is in beta

This means that the UserIQ Destination is in active development, and some functionality may change before it becomes generally available.

Getting Started

Before you start, make sure UserIQ supports the source type and connection mode you’ve chosen to implement. You can learn more about connection modes here.

Web Mobile Server
📱 Device-mode ⬜️ ⬜️ ⬜️
☁️ Cloud-mode
  1. From the Segment web app, click Catalog.
  2. Search for “UserIQ” in the Catalog, select it, and choose which of your sources to connect the destination to.
  3. Enter the “API Key” into your Segment Settings UI which you can find from your UserIQ dashboard [Site Settings -> API Key].

Page

If you’re not familiar with the Segment Specs, take a look to understand what the Page method does. An example call would look like:

analytics.page("pageName")

Page calls will be sent to UserIQ as a pageview.

Screen

If you’re not familiar with the Segment Specs, take a look to understand what the Screen method does. An example call would look like:

[[SEGAnalytics sharedAnalytics] screen:@"Home"];

Screen calls will be sent to UserIQ as a screenview.

Identify

If you’re not familiar with the Segment Specs, take a look to understand what the Identify method does. An example call would look like:

analytics.identify('userId123', {
  email: 'john.doe@example.com'
});

Identify calls will be sent to UserIQ as an identify event.

Track

If you’re not familiar with the Segment Specs, take a look to understand what the Track method does. An example call would look like:

analytics.track('Clicked Login Button')

Track calls will be sent to UserIQ as a track event.

Personas

You can send computed traits and audiences generated using Segment Personas to this destination as a user property. To learn more about Personas, contact us for a demo.

For user-property destinations, an identify call is sent to the destination for each user being added and removed. The property name is the snake_cased version of the audience name, with a true/false value to indicate membership. For example, when a user first completes an order in the last 30 days, Personas sends an Identify call with the property order_completed_last_30days: true. When the user no longer satisfies this condition (for example, it’s been more than 30 days since their last order), Personas sets that value to false.

When you first create an audience, Personas sends an Identify call for every user in that audience. Later audience syncs only send updates for users whose membership has changed since the last sync.

Settings

Segment lets you change these destination settings from the Segment app without having to touch any code.

API Key

You can find your API key in the accounts page

Adding UserIQ to the integrations object

To add UserIQ to the integrations JSON object (for example, to filter data from a specific source), use one of the following valid names for this integration:

  • useriq

  • UserIQ

This page was last modified: 20 Oct 2020



Get started with Segment

Segment is the easiest way to integrate your websites & mobile apps data to over 300 analytics and growth tools.
or
Create free account