Skip to end of metadata
Go to start of metadata

User Group Pattern Service

The User Group Pattern Service allows you to divide a hypothetical audience into up to five discrete buckets, each bucket defined to cover a percentage of total users. The most common use case for doing this is defining user groups for A/B testing of campaign targeting strategies (see Test and Control Targeting (Standard Line Item) for more information - customer login required).

It is important to note that a pattern does not perform any actual targeting; it simply helps you calculate user group targeting values that you can manually apply to your campaign profiles.

Here's the general process:

  1. You create a JSON file that defines your pattern.
  2. You make the POST request shown below.
  3. The response includes usergroup_target values for your pattern. You update the relevant profiles with these values (see user_group_targets in the Profile Service for more details).
On This Page

REST API

Add a new user group pattern:

View a specific user group pattern:

View all of your user group patterns:

JSON Fields

Field

Type (Length)

Description

Default

Required On

id

int

The ID of the user group pattern.

member_id

in

The member to which the user group pattern belongs.

POST

name

string (255)

The name of the user group pattern.

POST

cookieless

boolean

If true, the first user group in the groups array will be set to include cookieless users. By default, this is set to false because you cannot track clicks or conversions for cookieless users and, therefore, cannot test performance on them.

false

POST

groups

array of objects

The user groups in the pattern. No more than five groups can be included. See Groups below for more details.

POST

last_modified

timestamp

The date on which the user group pattern was last modified.

Groups

Field

Type (Length)

Description

Default

Required On

id

int

The ID of the user group.

name

string

The name of the user group.

POST

percent

int

The percent of users that this group will target. The total for all user groups must add up to 100%.

POST

usergroup_target

object

This object is returned on POST and GET and specifies the information that you would use in the user_group_targets array of a profile. See the example below for formatting.

Examples

Add a new user group pattern
View user group pattern 430