Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -16,23 +16,26 @@ This destination is maintained by StackAdapt. For any issues with the destinatio

## Getting started

### Getting your StackAdapt GraphQL token

If you do not have an existing StackAdapt read & write API key, contact the [StackAdapt team](https://support.stackadapt.com/hc/en-us/requests/new?ticket_form_id=360006572593){:target="_blank"}.
> info "Getting your StackAdapt GraphQL token"
> If you do not have an existing StackAdapt read & write API key, contact the [StackAdapt team](https://support.stackadapt.com/hc/en-us/requests/new?ticket_form_id=360006572593){:target="_blank"}.

### Setting up the StackAdapt Audiences destination in Engage

1. In your Segment workspace, navigate to **Connections > Catalog > Destinations**.
2. Search for and select "StackAdapt Audiences".
3. Click **Add Destination**.
4. Select an existing source that is Engage Space to connect to the StackAdapt Audience destination.
4. Select an existing Engage space source to connect to the StackAdapt Audience destination.
5. Enter a name for your destination.
6. On the Settings screen, provide your StackAdapt GraphQL API token.
7. Toggle on the destination using **Enable Destination**.
6. On the Settings screen, provide your StackAdapt GraphQL API token. Then, put in the ID of the advertiser you want to sync the audience with. You can [find the advertiser ID in StackAdapt](#finding-the-advertiser-id-in-stackadapt).
7. Toggle the destination on using **Enable Destination**.
8. Click **Save Changes**.
9. Follow the steps in the Destinations Actions documentation to [customize mappings](/docs/connections/destinations/actions/#customize-mappings) or [sync an Engage Audience](#sync-an-engage-audience).
9. Follow the Destinations Actions documentation to [customize mappings](/docs/connections/destinations/actions/#customize-mappings) or [sync an Engage Audience](#sync-an-engage-audience).
10. Enable the destination and click **Save Changes**.

#### Finding the advertiser ID in StackAdapt
In StackAdapt, go to **Execute** (or **Overview**) and click **Advertiser**.
From the **Filter** section, select the advertiser. The advertiser ID appears in the URL after `advertiser=`.

### Sync an Engage Audience

To sync an Engage audience with StackAdapt:
Expand All @@ -41,25 +44,32 @@ To sync an Engage audience with StackAdapt:
2. Add a condition to the Engage audience to ensure the required email trait is included.
3. Open the previously created StackAdapt Audience destination.
4. Create a mapping: In the mappings tab, click **New Mapping** and select **Forward Audience Event**.
- To reuse your Segment audience on the StackAdapt platform, select **Sync Audience**.
- To apply import profiles to the StackAdapt platform, select **Forward Profile**.
- **Note**: you don't have to set up both mappings.
5. Define the event trigger: Click **Add Condition** and add this condition: **Event Type is `Track` or `Identify`**.
6. Map fields: Select the advertiser you want to sync the audience with. You can identify a specific advertiser by finding its ID in StackAdapt.

> info ""
> When you're on StackAdapt platform, navigate to **Execute** (or **Overview**), then click on **Advertiser**. Next, select an advertiser from the **Filter** section. You can find the advertiser ID in the URL after `advertiser=`.
6. Map fields:
- (**Required**:) Select a default value for `Marketing Status`.
- (**Required**:) Select the source field for `Email`.
- Select source field for `Standard User Properties`,
- Create mappings for `Custom User Properties` if applicable.

![Image showing sample map fields](images/map-fields-example.png)

To verify that your audience is syncing with StackAdapt, open StackAdapt and navigate to **Audience & Attribution > Customer Data > Profiles**. On the Profiles tab, you should be able to see a list of profiles being synced to StackAdapt platform.
To verify that your audience syncs with StackAdapt, open StackAdapt and navigate to **Audience & Attribution > Customer Data > Profiles**. On the Profiles tab, you should be able to see a list of profiles being synced to StackAdapt platform.

> info "Syncs can take up to 4 hours"
> It can take up to 4 hours from the time you initiate a sync for profiles to show up in StackAdapt.

If you want to create a StackAdapt audience from your Engage audience:
To create a StackAdapt audience from your Engage audience:

1. Open StackAdapt and navigate to **Audience & Attribution > Data Data > Segments**, then click **Create Segment**.
2. Select the advertiser you have synced your audience to.
3. Choose **Profile Properties > Segment** and select **External Audience Name** as the rule.
4. Select a condition and put in the audience name as the filter.
5. Click **Submit** to create the segment.

1. Open StackAdapt and navigate to **Audience & Attribution > Customer Data > Segments**, then click **Create Segment**.
2. Choose **Segment Engage Audience ID** or **Segment Engage Audience Name** as the rule.
3. Select the value for the corresponding filter.
4. Click **Submit** to create the segment.
> info "Audience name format"
> Use the *snake_case* name of the Segment Engage audience which can be found in **Settings**, shown in the following screenshot.
![Image showing sample audience settings tab](./images/audience-example.png)

### Sending an audience to StackAdapt

Expand Down