Contentful Personalization & Analytics
Preparing search index...
@contentful/optimization-core
Signals
Interface Signals
interface
Signals
{
changes
:
Signal
<
|
undefined
|
{
key
:
string
;
meta
:
{
experienceId
:
string
;
variantIndex
:
number
}
;
type
:
"Variable"
;
value
:
null
|
string
|
number
|
boolean
|
Record
<
string
,
JSONType
>
;
}
[]
,
>
;
consent
:
Signal
<
undefined
|
boolean
>
;
event
:
Signal
<
|
undefined
|
{
channel
:
"mobile"
|
"server"
|
"web"
;
context
:
{
app
?:
{
name
:
string
;
version
:
string
}
;
campaign
:
{
content
?:
string
;
medium
?:
string
;
name
?:
string
;
source
?:
string
;
term
?:
string
;
}
;
gdpr
:
{
isConsentGiven
:
boolean
}
;
library
:
{
name
:
string
;
version
:
string
}
;
locale
:
string
;
location
?:
{
city
?:
string
;
continent
?:
string
;
coordinates
?:
{
latitude
:
number
;
longitude
:
number
}
;
country
?:
string
;
countryCode
?:
string
;
postalCode
?:
string
;
region
?:
string
;
regionCode
?:
string
;
timezone
?:
string
;
}
;
page
?:
{
path
:
string
;
query
:
Record
<
string
,
string
>
;
referrer
:
string
;
search
:
string
;
title
?:
string
;
url
:
string
;
[
key
:
string
]:
JSONType
;
}
;
screen
?:
{
name
:
string
;
[
key
:
string
]:
JSONType
}
;
userAgent
?:
string
;
}
;
messageId
:
string
;
originalTimestamp
:
string
;
sentAt
:
string
;
timestamp
:
string
;
type
:
"alias"
;
userId
?:
string
;
}
|
{
channel
:
"mobile"
|
"server"
|
"web"
;
componentId
:
string
;
componentType
:
"Entry"
|
"Variable"
;
context
:
{
app
?:
{
name
:
string
;
version
:
string
}
;
campaign
:
{
content
?:
string
;
medium
?:
string
;
name
?:
string
;
source
?:
string
;
term
?:
string
;
}
;
gdpr
:
{
isConsentGiven
:
boolean
}
;
library
:
{
name
:
string
;
version
:
string
}
;
locale
:
string
;
location
?:
{
city
?:
string
;
continent
?:
string
;
coordinates
?:
{
latitude
:
number
;
longitude
:
number
}
;
country
?:
string
;
countryCode
?:
string
;
postalCode
?:
string
;
region
?:
string
;
regionCode
?:
string
;
timezone
?:
string
;
}
;
page
?:
{
path
:
string
;
query
:
Record
<
string
,
string
>
;
referrer
:
string
;
search
:
string
;
title
?:
string
;
url
:
string
;
[
key
:
string
]:
JSONType
;
}
;
screen
?:
{
name
:
string
;
[
key
:
string
]:
JSONType
}
;
userAgent
?:
string
;
}
;
experienceId
?:
string
;
messageId
:
string
;
originalTimestamp
:
string
;
sentAt
:
string
;
timestamp
:
string
;
type
:
"component"
;
userId
?:
string
;
variantIndex
:
number
;
}
|
{
channel
:
"mobile"
|
"server"
|
"web"
;
context
:
{
app
?:
{
name
:
string
;
version
:
string
}
;
campaign
:
{
content
?:
string
;
medium
?:
string
;
name
?:
string
;
source
?:
string
;
term
?:
string
;
}
;
gdpr
:
{
isConsentGiven
:
boolean
}
;
library
:
{
name
:
string
;
version
:
string
}
;
locale
:
string
;
location
?:
{
city
?:
string
;
continent
?:
string
;
coordinates
?:
{
latitude
:
number
;
longitude
:
number
}
;
country
?:
string
;
countryCode
?:
string
;
postalCode
?:
string
;
region
?:
string
;
regionCode
?:
string
;
timezone
?:
string
;
}
;
page
?:
{
path
:
string
;
query
:
Record
<
string
,
string
>
;
referrer
:
string
;
search
:
string
;
title
?:
string
;
url
:
string
;
[
key
:
string
]:
JSONType
;
}
;
screen
?:
{
name
:
string
;
[
key
:
string
]:
JSONType
}
;
userAgent
?:
string
;
}
;
messageId
:
string
;
originalTimestamp
:
string
;
sentAt
:
string
;
timestamp
:
string
;
type
:
"group"
;
userId
?:
string
;
}
|
{
channel
:
"mobile"
|
"server"
|
"web"
;
context
:
{
app
?:
{
name
:
string
;
version
:
string
}
;
campaign
:
{
content
?:
string
;
medium
?:
string
;
name
?:
string
;
source
?:
string
;
term
?:
string
;
}
;
gdpr
:
{
isConsentGiven
:
boolean
}
;
library
:
{
name
:
string
;
version
:
string
}
;
locale
:
string
;
location
?:
{
city
?:
string
;
continent
?:
string
;
coordinates
?:
{
latitude
:
number
;
longitude
:
number
}
;
country
?:
string
;
countryCode
?:
string
;
postalCode
?:
string
;
region
?:
string
;
regionCode
?:
string
;
timezone
?:
string
;
}
;
page
?:
{
path
:
string
;
query
:
Record
<
string
,
string
>
;
referrer
:
string
;
search
:
string
;
title
?:
string
;
url
:
string
;
[
key
:
string
]:
JSONType
;
}
;
screen
?:
{
name
:
string
;
[
key
:
string
]:
JSONType
}
;
userAgent
?:
string
;
}
;
messageId
:
string
;
originalTimestamp
:
string
;
sentAt
:
string
;
timestamp
:
string
;
traits
:
Record
<
string
,
JSONType
>
;
type
:
"identify"
;
userId
?:
string
;
}
|
{
channel
:
"mobile"
|
"server"
|
"web"
;
context
:
{
app
?:
{
name
:
string
;
version
:
string
}
;
campaign
:
{
content
?:
string
;
medium
?:
string
;
name
?:
string
;
source
?:
string
;
term
?:
string
;
}
;
gdpr
:
{
isConsentGiven
:
boolean
}
;
library
:
{
name
:
string
;
version
:
string
}
;
locale
:
string
;
location
?:
{
city
?:
string
;
continent
?:
string
;
coordinates
?:
{
latitude
:
number
;
longitude
:
number
}
;
country
?:
string
;
countryCode
?:
string
;
postalCode
?:
string
;
region
?:
string
;
regionCode
?:
string
;
timezone
?:
string
;
}
;
page
:
{
path
:
string
;
query
:
Record
<
string
,
string
>
;
referrer
:
string
;
search
:
string
;
title
?:
string
;
url
:
string
;
[
key
:
string
]:
JSONType
;
}
;
userAgent
?:
string
;
}
;
messageId
:
string
;
name
?:
string
;
originalTimestamp
:
string
;
properties
:
{
path
:
string
;
query
:
Record
<
string
,
string
>
;
referrer
:
string
;
search
:
string
;
title
?:
string
;
url
:
string
;
[
key
:
string
]:
JSONType
;
}
;
sentAt
:
string
;
timestamp
:
string
;
type
:
"page"
;
userId
?:
string
;
}
|
{
channel
:
"mobile"
|
"server"
|
"web"
;
context
:
{
app
?:
{
name
:
string
;
version
:
string
}
;
campaign
:
{
content
?:
string
;
medium
?:
string
;
name
?:
string
;
source
?:
string
;
term
?:
string
;
}
;
gdpr
:
{
isConsentGiven
:
boolean
}
;
library
:
{
name
:
string
;
version
:
string
}
;
locale
:
string
;
location
?:
{
city
?:
string
;
continent
?:
string
;
coordinates
?:
{
latitude
:
number
;
longitude
:
number
}
;
country
?:
string
;
countryCode
?:
string
;
postalCode
?:
string
;
region
?:
string
;
regionCode
?:
string
;
timezone
?:
string
;
}
;
screen
:
{
name
:
string
;
[
key
:
string
]:
JSONType
}
;
userAgent
?:
string
;
}
;
messageId
:
string
;
name
:
string
;
originalTimestamp
:
string
;
properties
?:
Record
<
string
,
JSONType
>
;
sentAt
:
string
;
timestamp
:
string
;
type
:
"screen"
;
userId
?:
string
;
}
|
{
channel
:
"mobile"
|
"server"
|
"web"
;
context
:
{
app
?:
{
name
:
string
;
version
:
string
}
;
campaign
:
{
content
?:
string
;
medium
?:
string
;
name
?:
string
;
source
?:
string
;
term
?:
string
;
}
;
gdpr
:
{
isConsentGiven
:
boolean
}
;
library
:
{
name
:
string
;
version
:
string
}
;
locale
:
string
;
location
?:
{
city
?:
string
;
continent
?:
string
;
coordinates
?:
{
latitude
:
number
;
longitude
:
number
}
;
country
?:
string
;
countryCode
?:
string
;
postalCode
?:
string
;
region
?:
string
;
regionCode
?:
string
;
timezone
?:
string
;
}
;
page
?:
{
path
:
string
;
query
:
Record
<
string
,
string
>
;
referrer
:
string
;
search
:
string
;
title
?:
string
;
url
:
string
;
[
key
:
string
]:
JSONType
;
}
;
screen
?:
{
name
:
string
;
[
key
:
string
]:
JSONType
}
;
userAgent
?:
string
;
}
;
event
:
string
;
messageId
:
string
;
originalTimestamp
:
string
;
properties
:
Record
<
string
,
JSONType
>
;
sentAt
:
string
;
timestamp
:
string
;
type
:
"track"
;
userId
?:
string
;
}
,
>
;
flags
:
ReadonlySignal
<
undefined
|
Flags
>
;
online
:
Signal
<
undefined
|
boolean
>
;
personalizations
:
Signal
<
|
undefined
|
{
experienceId
:
string
;
sticky
?:
boolean
;
variantIndex
:
number
;
variants
:
Record
<
string
,
string
>
;
}
[]
,
>
;
profile
:
Signal
<
|
undefined
|
{
audiences
:
string
[]
;
id
:
string
;
location
:
{
city
?:
string
;
continent
?:
string
;
coordinates
?:
{
latitude
:
number
;
longitude
:
number
}
;
country
?:
string
;
countryCode
?:
string
;
postalCode
?:
string
;
region
?:
string
;
regionCode
?:
string
;
timezone
?:
string
;
}
;
random
:
number
;
session
:
{
activeSessionLength
:
number
;
averageSessionLength
:
number
;
count
:
number
;
id
:
string
;
isReturningVisitor
:
boolean
;
landingPage
:
{
path
:
string
;
query
:
Record
<
string
,
string
>
;
referrer
:
string
;
search
:
string
;
title
?:
string
;
url
:
string
;
[
key
:
string
]:
JSONType
;
}
;
}
;
stableId
:
string
;
traits
:
Record
<
string
,
JSONType
>
;
}
,
>
;
}
Index
Properties
changes
consent
event
flags
online
personalizations
profile
Properties
changes
changes
:
Signal
<
|
undefined
|
{
key
:
string
;
meta
:
{
experienceId
:
string
;
variantIndex
:
number
}
;
type
:
"Variable"
;
value
:
null
|
string
|
number
|
boolean
|
Record
<
string
,
JSONType
>
;
}
[]
,
>
consent
consent
:
Signal
<
undefined
|
boolean
>
event
event
:
Signal
<
|
undefined
|
{
channel
:
"mobile"
|
"server"
|
"web"
;
context
:
{
app
?:
{
name
:
string
;
version
:
string
}
;
campaign
:
{
content
?:
string
;
medium
?:
string
;
name
?:
string
;
source
?:
string
;
term
?:
string
;
}
;
gdpr
:
{
isConsentGiven
:
boolean
}
;
library
:
{
name
:
string
;
version
:
string
}
;
locale
:
string
;
location
?:
{
city
?:
string
;
continent
?:
string
;
coordinates
?:
{
latitude
:
number
;
longitude
:
number
}
;
country
?:
string
;
countryCode
?:
string
;
postalCode
?:
string
;
region
?:
string
;
regionCode
?:
string
;
timezone
?:
string
;
}
;
page
?:
{
path
:
string
;
query
:
Record
<
string
,
string
>
;
referrer
:
string
;
search
:
string
;
title
?:
string
;
url
:
string
;
[
key
:
string
]:
JSONType
;
}
;
screen
?:
{
name
:
string
;
[
key
:
string
]:
JSONType
}
;
userAgent
?:
string
;
}
;
messageId
:
string
;
originalTimestamp
:
string
;
sentAt
:
string
;
timestamp
:
string
;
type
:
"alias"
;
userId
?:
string
;
}
|
{
channel
:
"mobile"
|
"server"
|
"web"
;
componentId
:
string
;
componentType
:
"Entry"
|
"Variable"
;
context
:
{
app
?:
{
name
:
string
;
version
:
string
}
;
campaign
:
{
content
?:
string
;
medium
?:
string
;
name
?:
string
;
source
?:
string
;
term
?:
string
;
}
;
gdpr
:
{
isConsentGiven
:
boolean
}
;
library
:
{
name
:
string
;
version
:
string
}
;
locale
:
string
;
location
?:
{
city
?:
string
;
continent
?:
string
;
coordinates
?:
{
latitude
:
number
;
longitude
:
number
}
;
country
?:
string
;
countryCode
?:
string
;
postalCode
?:
string
;
region
?:
string
;
regionCode
?:
string
;
timezone
?:
string
;
}
;
page
?:
{
path
:
string
;
query
:
Record
<
string
,
string
>
;
referrer
:
string
;
search
:
string
;
title
?:
string
;
url
:
string
;
[
key
:
string
]:
JSONType
;
}
;
screen
?:
{
name
:
string
;
[
key
:
string
]:
JSONType
}
;
userAgent
?:
string
;
}
;
experienceId
?:
string
;
messageId
:
string
;
originalTimestamp
:
string
;
sentAt
:
string
;
timestamp
:
string
;
type
:
"component"
;
userId
?:
string
;
variantIndex
:
number
;
}
|
{
channel
:
"mobile"
|
"server"
|
"web"
;
context
:
{
app
?:
{
name
:
string
;
version
:
string
}
;
campaign
:
{
content
?:
string
;
medium
?:
string
;
name
?:
string
;
source
?:
string
;
term
?:
string
;
}
;
gdpr
:
{
isConsentGiven
:
boolean
}
;
library
:
{
name
:
string
;
version
:
string
}
;
locale
:
string
;
location
?:
{
city
?:
string
;
continent
?:
string
;
coordinates
?:
{
latitude
:
number
;
longitude
:
number
}
;
country
?:
string
;
countryCode
?:
string
;
postalCode
?:
string
;
region
?:
string
;
regionCode
?:
string
;
timezone
?:
string
;
}
;
page
?:
{
path
:
string
;
query
:
Record
<
string
,
string
>
;
referrer
:
string
;
search
:
string
;
title
?:
string
;
url
:
string
;
[
key
:
string
]:
JSONType
;
}
;
screen
?:
{
name
:
string
;
[
key
:
string
]:
JSONType
}
;
userAgent
?:
string
;
}
;
messageId
:
string
;
originalTimestamp
:
string
;
sentAt
:
string
;
timestamp
:
string
;
type
:
"group"
;
userId
?:
string
;
}
|
{
channel
:
"mobile"
|
"server"
|
"web"
;
context
:
{
app
?:
{
name
:
string
;
version
:
string
}
;
campaign
:
{
content
?:
string
;
medium
?:
string
;
name
?:
string
;
source
?:
string
;
term
?:
string
;
}
;
gdpr
:
{
isConsentGiven
:
boolean
}
;
library
:
{
name
:
string
;
version
:
string
}
;
locale
:
string
;
location
?:
{
city
?:
string
;
continent
?:
string
;
coordinates
?:
{
latitude
:
number
;
longitude
:
number
}
;
country
?:
string
;
countryCode
?:
string
;
postalCode
?:
string
;
region
?:
string
;
regionCode
?:
string
;
timezone
?:
string
;
}
;
page
?:
{
path
:
string
;
query
:
Record
<
string
,
string
>
;
referrer
:
string
;
search
:
string
;
title
?:
string
;
url
:
string
;
[
key
:
string
]:
JSONType
;
}
;
screen
?:
{
name
:
string
;
[
key
:
string
]:
JSONType
}
;
userAgent
?:
string
;
}
;
messageId
:
string
;
originalTimestamp
:
string
;
sentAt
:
string
;
timestamp
:
string
;
traits
:
Record
<
string
,
JSONType
>
;
type
:
"identify"
;
userId
?:
string
;
}
|
{
channel
:
"mobile"
|
"server"
|
"web"
;
context
:
{
app
?:
{
name
:
string
;
version
:
string
}
;
campaign
:
{
content
?:
string
;
medium
?:
string
;
name
?:
string
;
source
?:
string
;
term
?:
string
;
}
;
gdpr
:
{
isConsentGiven
:
boolean
}
;
library
:
{
name
:
string
;
version
:
string
}
;
locale
:
string
;
location
?:
{
city
?:
string
;
continent
?:
string
;
coordinates
?:
{
latitude
:
number
;
longitude
:
number
}
;
country
?:
string
;
countryCode
?:
string
;
postalCode
?:
string
;
region
?:
string
;
regionCode
?:
string
;
timezone
?:
string
;
}
;
page
:
{
path
:
string
;
query
:
Record
<
string
,
string
>
;
referrer
:
string
;
search
:
string
;
title
?:
string
;
url
:
string
;
[
key
:
string
]:
JSONType
;
}
;
userAgent
?:
string
;
}
;
messageId
:
string
;
name
?:
string
;
originalTimestamp
:
string
;
properties
:
{
path
:
string
;
query
:
Record
<
string
,
string
>
;
referrer
:
string
;
search
:
string
;
title
?:
string
;
url
:
string
;
[
key
:
string
]:
JSONType
;
}
;
sentAt
:
string
;
timestamp
:
string
;
type
:
"page"
;
userId
?:
string
;
}
|
{
channel
:
"mobile"
|
"server"
|
"web"
;
context
:
{
app
?:
{
name
:
string
;
version
:
string
}
;
campaign
:
{
content
?:
string
;
medium
?:
string
;
name
?:
string
;
source
?:
string
;
term
?:
string
;
}
;
gdpr
:
{
isConsentGiven
:
boolean
}
;
library
:
{
name
:
string
;
version
:
string
}
;
locale
:
string
;
location
?:
{
city
?:
string
;
continent
?:
string
;
coordinates
?:
{
latitude
:
number
;
longitude
:
number
}
;
country
?:
string
;
countryCode
?:
string
;
postalCode
?:
string
;
region
?:
string
;
regionCode
?:
string
;
timezone
?:
string
;
}
;
screen
:
{
name
:
string
;
[
key
:
string
]:
JSONType
}
;
userAgent
?:
string
;
}
;
messageId
:
string
;
name
:
string
;
originalTimestamp
:
string
;
properties
?:
Record
<
string
,
JSONType
>
;
sentAt
:
string
;
timestamp
:
string
;
type
:
"screen"
;
userId
?:
string
;
}
|
{
channel
:
"mobile"
|
"server"
|
"web"
;
context
:
{
app
?:
{
name
:
string
;
version
:
string
}
;
campaign
:
{
content
?:
string
;
medium
?:
string
;
name
?:
string
;
source
?:
string
;
term
?:
string
;
}
;
gdpr
:
{
isConsentGiven
:
boolean
}
;
library
:
{
name
:
string
;
version
:
string
}
;
locale
:
string
;
location
?:
{
city
?:
string
;
continent
?:
string
;
coordinates
?:
{
latitude
:
number
;
longitude
:
number
}
;
country
?:
string
;
countryCode
?:
string
;
postalCode
?:
string
;
region
?:
string
;
regionCode
?:
string
;
timezone
?:
string
;
}
;
page
?:
{
path
:
string
;
query
:
Record
<
string
,
string
>
;
referrer
:
string
;
search
:
string
;
title
?:
string
;
url
:
string
;
[
key
:
string
]:
JSONType
;
}
;
screen
?:
{
name
:
string
;
[
key
:
string
]:
JSONType
}
;
userAgent
?:
string
;
}
;
event
:
string
;
messageId
:
string
;
originalTimestamp
:
string
;
properties
:
Record
<
string
,
JSONType
>
;
sentAt
:
string
;
timestamp
:
string
;
type
:
"track"
;
userId
?:
string
;
}
,
>
flags
flags
:
ReadonlySignal
<
undefined
|
Flags
>
online
online
:
Signal
<
undefined
|
boolean
>
personalizations
personalizations
:
Signal
<
|
undefined
|
{
experienceId
:
string
;
sticky
?:
boolean
;
variantIndex
:
number
;
variants
:
Record
<
string
,
string
>
;
}
[]
,
>
profile
profile
:
Signal
<
|
undefined
|
{
audiences
:
string
[]
;
id
:
string
;
location
:
{
city
?:
string
;
continent
?:
string
;
coordinates
?:
{
latitude
:
number
;
longitude
:
number
}
;
country
?:
string
;
countryCode
?:
string
;
postalCode
?:
string
;
region
?:
string
;
regionCode
?:
string
;
timezone
?:
string
;
}
;
random
:
number
;
session
:
{
activeSessionLength
:
number
;
averageSessionLength
:
number
;
count
:
number
;
id
:
string
;
isReturningVisitor
:
boolean
;
landingPage
:
{
path
:
string
;
query
:
Record
<
string
,
string
>
;
referrer
:
string
;
search
:
string
;
title
?:
string
;
url
:
string
;
[
key
:
string
]:
JSONType
;
}
;
}
;
stableId
:
string
;
traits
:
Record
<
string
,
JSONType
>
;
}
,
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
changes
consent
event
flags
online
personalizations
profile
Contentful Personalization & Analytics
Loading...