Disclaimer: This website requires Please enable JavaScript in your browser settings for the best experience.

Dev GuideAPI Reference
Dev GuideAPI ReferenceUser GuideGitHubDev CommunityOptimizely AcademySubmit a ticketLog In
Dev Guide

Customers

This topic describes customers and how to identify them in Optimizely Data Platform (ODP).

Customers are at the core of Optimizely Data Platform (ODP). ODP uses customer data to create user profiles, segmentation and reports. Aggregating customer data provides a more holistic view of your customers and lets you create distinct segments that target different sets of your customers.

Additionally, ODP lets you synchronize customer data with other products to enhance your marketing activities.

Customer data

Customer data are composed of fields that are typically grouped into attributes or identifiers. You can use the default fields ODP provides or create custom fields to store your external customer data. To send past customer data to ODP, see Import historical data.

Attributes

The following table shows the default attributes for customers (sorted alphabetically by field name):

Display name

Field name

Type

Description

CCPA Opted-out

ccpa_opted_out

Boolean

California Consumer Privacy Act (CCPA) Opt-out status.

City

city

Text

Country

country

Text

Country in ISO-3166-1 format

Customer Source

data_source

Text

The source of the update for this record.
For example, the ID of the app or the filename of the CSV.

Customer Source: Details

data_source_details

Text

Additional details about the source.

Customer Source: Instance

data_source_instance

Text

The unique namespace for the provided source.
For example, a store name in Shopify or a company name in Zendesk. This allows multiple versions of the same app to be installed.

Customer Source: Type

data_source_type

Text

The categorization of the source that updated this record. Examples include, csv, app, campaign, zaius, sdk, api.

Customer Source: Version

data_source_version

Text

If the source of the update has an associated version, the version is included in this field.

Birthday (Day)

dob_day

Number

The numeric day of the month the customer was born.
For example, 1-31.

Birthday (Month)

dob_month

Number

The numeric month the customer was born.
For example, 1-12.

Birthday (Year)

dob_year

Number

The numeric year the customer was born.
For example, 1980.

First Name

first_name

Text

Gender

gender

Text

Stored as M, F

Image URL

image_url

Text

URL of user profile image.

Last Modified At

last_modified_at

Timestamp

Last Name

last_name

Text

Time Zone (Last Seen)

last_observed_timezone

Text

Name

name

Text

State

state

Text

Street1

street1

Text

Street2

street2

Text

Time Zone

timezone

Text

Time zone in IANA format.
For example, America/New_York.

GDPR Opt-out Timpestamp

ts_gdpr_opted_out

Timestamp

General Data Protection Regulation opt-out timestamp.

ZIP code

zip

Text

📘

Note

You may see more default attributes than are listed in the table. Integrations within ODP can create their own attributes and display them in the ODP application.