We’ve migrated our documentation to a new site, which means some URLs have changed.
Audience
Audience
Breadcrumbs

Customer Prefix

Maintained by Piano, customer prefix can be configured on site-group level provided that the prefix string is available and permitted to use for the customer ID you belong to. Ask your onboarding or support contact about your customer prefix.

The prefix (a three-character lower-case alpha-numeric string, like xyz,  cxn or cx2), is used to control data visibility in Piano Audience, Insight and Content. With customer prefix, one customer profile can support multiple customer specific dimensions, and customers having permissions to site groups with configured customer prefixes get controlled access to this profile data.
Be aware that, after initial configuration, it can take up to 30 minutes before a new prefix works on all sites and site groups.

Customer prefix can be used either standalone or as a prefix to a key. The most common example used throughout this doc is "xyz":

Use case

Description

Examples

Custom parameters

Used as a prefix

cX.callQueue.push(['setCustomParameters', { 'xyz-registered': 'true', 'xyz-subscriber': 'yes' }]);

Document parsing

Used as a prefix

<meta name="cXenseParse:xyz-fruit" content="banana"/>

User Interests

 and 

User Intents

As a key named group-prefix in the Excel workbook or JSON object dictionaries being used for the configuration

As a prefix for the user profile groups 'xyz-categories' or 'xyz-intent'

Audience Estimation

Used as a prefix

<meta name="cXenseParse:xyz-audience" content="age/25-40"/>

Performance Events

Must be used as a prefix for the "origin"

as part of /dmp/push => "origin": "xyz-website"

or client-side: cX.setEventAttributes({ origin: 'xyz-website', persistedQueryId: '123456' });

Traffic filters

Used as a prefix for "group" values

Or as key for "group" values of type "type":"user"

{"type":"custom", "group":"xyz-subscriber", "item":["yes", "no"]}

{"type":"keyword", "group":"xyz-fruits", "item":"banana"}

{"type":"user-keyword", "group":"xyz-categories", "items":["news/business/bank", "news/business/investments"]}

{"type":"intent", "group":"xyz-intent", "items":["travel", "shopping"]}

{"type":"user", "group":"xyz", "item":"subscriber14"}

Content recommendations

/public/widget/data

Can be used as a type in the "user > ids" mapping

Standard Piano ID:

"user": { "ids": { "usi": "12343123411343595" } },

With external-id linked with the customer-prefix "xyz"

"user": { "ids": { "xyz": "subscriber14" } },

External User Identifiers

/profile/user/external/* API family

As a key named 'type'

As prefix of the 1st party data profile objects 'group' values

Client side

cX.callQueue.push(['addExternalId', { 'id': 'subscriber14', 'type': 'xyz'}]);)

Server side as authenticated API requests

cx.py /profile/user/external/link/update '{"id":"subscriber14", "type":"xyz", "cxid":"12343123411343595"}'

cx.py /profile/user/external/update '{"id":"subscriber14","type":"xyz","profile":[{"group":"xyz-gender","item":"male"},{"group":"xyz-interests","item":"cooking"},{"group":"xyz-interests","item":"motorcyckling"}]}'

Last updated: