API docs by Redocly

Signal API (0.1)

URL: http://meetmarigold.com License: All Rights Reserved

Signal Stream Service Server API

Authentication

Authentication for the API

Endpoint generates JWT token based on Basic Authentication header. The header has following structure: Authentication: Basic base64(<Private Key>:<Secret>) In this case Private Key is defined in the respective audience API same as Secret. Private Key needs to be enabled. Combination of the Private Key/Secret needs to be base64 encoded. The API returns in the response JWT token which needs to be used for the signal specific API calls with following header: Authentication: Bearer <JWT>

Authorizations:
basicAuth

Responses

Response Schema: application/json
jwt
string

Generated JWT token

Response samples

Content type
application/json
{
  • "jwt": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxMjM0NTY3ODkxMSIsImF1ZCI6InN0cmluZyIsInJvbGVzIjpbIlJPTEVfVVNFUiJdLCJpc3MiOiJhdGxhcyIsImN1c3RvbWVySWQiOiIxIiwiZXhwIjoxNzMwMTMyOTEzLCJpYXQiOjE3MzAxMjkzMTN9.gzn0ddO3nirDKcp8v7wpk8L86gbl7wF2k-d_mePW_eA"
}

Cart Add Signal

Cart Add Signal endpoint

Processes Cart Add signal

Authorizations:
JwtToken
Request Body schema: application/json
specversion
required
string (Schema version)
Default: "1.0"

Schema version

Value: "1.0"
type
required
string (Type)
Default: "event.signal"

The classification/category of event

Value: "event.signal"
dataschema
required
string (Data Schema)
Default: "evt:signal/v1"

A reference to the definition of the structure of data

Value: "evt:signal/v1"
id
required
string (Event ID)
Default: ""

Identifier for event. Unique per source. GUID

traceId
string (Trace ID)
Default: ""

Unique ID for tracing request across systems

source
string
Default: ""

Globally Unique Platform identifier. ':'

time
required
string (Time)
Default: ""

Date and time an event / activity the event relates to

required
object (Data section of the Signal event)

The payload of the event

site
required
string (Site)
Default: ""

Site or domain

cartId
required
string (Cart ID)
Default: ""

Id of the Cart

email
required
string (Email)
Default: ""

User email

object (Profile Attributes)

Flexible mechanism to store custom attributes of the member profile

object (Event Attributes)

Flexible mechanism to store custom attributes related to the event

required
Array of objects (Items)
Default: []

List of Items

additionalProperties
any

Responses

Request samples

Content type
application/json
{
  • "specversion": "1.0",
  • "type": "event.signal",
  • "dataschema": "evt:signal/v1",
  • "id": "message identifier 1",
  • "time": "2007-04-05T14:32:10.700Z",
  • "data": {
    • "site": "example.com",
    • "cartId": "cart",
    • "email": "john.doe@cheetahdigital.com",
    • "profileAttributes": {
      • "profileCity": "Sunnyvale",
      • "profileState": "CA",
      • "profilePostalCode": "94089",
      • "profileLastName": "Doe",
      • "profileFirstName": "John"
      },
    • "items": [
      • {
        }
      ]
    }
}

Cart Remove Signal

Cart Remove Signal endpoint

Processes Cart Remove signal

Authorizations:
JwtToken
Request Body schema: application/json
specversion
required
string (Schema version)
Default: "1.0"

Schema version

Value: "1.0"
type
required
string (Type)
Default: "event.signal"

The classification/category of event

Value: "event.signal"
dataschema
required
string (Data Schema)
Default: "evt:signal/v1"

A reference to the definition of the structure of data

Value: "evt:signal/v1"
id
required
string (Event ID)
Default: ""

Identifier for event. Unique per source. GUID

traceId
string (Trace ID)
Default: ""

Unique ID for tracing request across systems

source
string
Default: ""

Globally Unique Platform identifier. ':'

time
required
string (Time)
Default: ""

Date and time an event / activity the event relates to

required
object (Data section of the Signal event)

The payload of the event

site
required
string (Site)
Default: ""

Site or domain

email
required
string (Email)
Default: ""

User email

object (Profile Attributes)

Flexible mechanism to store custom attributes of the member profile

object (Event Attributes)

Flexible mechanism to store custom attributes related to the event

required
Array of objects (Items)
Default: []

List of Items

additionalProperties
any

Responses

Request samples

Content type
application/json
{
  • "specversion": "1.0",
  • "type": "event.signal",
  • "dataschema": "evt:signal/v1",
  • "id": "message identifier 1",
  • "time": "2007-04-05T14:32:10.700Z",
  • "data": {
    • "site": "www.example.com",
    • "cartId": "id",
    • "email": "john.doe@cheetahdigital.com",
    • "eventAttributes": {
      • "channel": "Email message",
      • "ip": "127.0.0.2",
      • "userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_6 like Mac OS X)",
      • "deviceType": "ios",
      • "country": "US",
      • "state": "CA",
      • "city": "Synnyvale",
      • "postalCode": 94089
      },
    • "profileAttributes": {
      • "profileCity": "Sunnyvale",
      • "profileState": "CA",
      • "profilePostalCode": "94089",
      • "profileLastName": "Doe",
      • "profileFirstName": "John"
      },
    • "items": [
      • {
        }
      ]
    }
}

Cart Clear Signal

Cart Clear Signal endpoint

Processes Cart Clear signal

Authorizations:
JwtToken
Request Body schema: application/json
specversion
required
string (Schema version)
Default: "1.0"

Schema version

Value: "1.0"
type
required
string (Type)
Default: "event.signal"

The classification/category of event

Value: "event.signal"
dataschema
required
string (Data Schema)
Default: "evt:signal/v1"

A reference to the definition of the structure of data

Value: "evt:signal/v1"
id
required
string (Event ID)
Default: ""

Identifier for event. Unique per source. GUID

traceId
string (Trace ID)
Default: ""

Unique ID for tracing request across systems

source
string
Default: ""

Globally Unique Platform identifier. ':'

time
required
string (Time)
Default: ""

Date and time an event / activity the event relates to

required
object (Data section of the Signal event)

The payload of the event

site
required
string (Site)
Default: ""

Site or domain

email
required
string (Email)
Default: ""

User email

object (Profile Attributes)

Flexible mechanism to store custom attributes of the member profile

object (Event Attributes)

Flexible mechanism to store custom attributes related to the event

additionalProperties
any

Responses

Request samples

Content type
application/json
{
  • "specversion": "1.0",
  • "type": "event.signal",
  • "dataschema": "evt:signal/v1",
  • "id": "message identifier 1",
  • "time": "2007-04-05T14:32:10.700Z",
  • "data": {
    • "cartId": "cart",
    • "email": "john.doe@cheetahdigital.com",
    • "site": "www.example.com",
    • "eventAttributes": {
      • "channel": "Email message",
      • "ip": "127.0.0.2",
      • "userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_6 like Mac OS X)",
      • "deviceType": "ios",
      • "country": "US",
      • "state": "CA",
      • "city": "Synnyvale",
      • "postalCode": 94089
      },
    • "profileAttributes": {
      • "profileCity": "Sunnyvale",
      • "profileState": "CA",
      • "profilePostalCode": "94089",
      • "profileLastName": "Doe",
      • "profileFirstName": "John"
      }
    }
}

Cart Purchase Signal

Cart Purchase Signal endpoint

Processes Cart Purchase signal

Authorizations:
JwtToken
Request Body schema: application/json
specversion
required
string (Schema version)
Default: "1.0"

Schema version

Value: "1.0"
type
required
string (Type)
Default: "event.signal"

The classification/category of event

Value: "event.signal"
dataschema
required
string (Data Schema)
Default: "evt:signal/v1"

A reference to the definition of the structure of data

Value: "evt:signal/v1"
id
required
string (Event ID)
Default: ""

Identifier for event. Unique per source. GUID

traceId
string (Trace ID)
Default: ""

Unique ID for tracing request across systems

source
string
Default: ""

Globally Unique Platform identifier. ':'

time
required
string (Time)
Default: ""

Date and time an event / activity the event relates to

required
object (Data section of the Signal event)

The payload of the event

site
required
string (Site)
Default: ""

Site or domain

email
required
string (Email)
Default: ""

User email

transactionId
required
string (Transaction ID)
Default: ""

Transaction ID generated by the customer

transactionSource
required
string (Transaction Source)
Default: ""

Transaction source of order

object (Profile Attributes)

Flexible mechanism to store custom attributes of the member profile

object (Event Attributes)

Flexible mechanism to store custom attributes related to the event

required
Array of objects (Items)
Default: []

List of Items

additionalProperties
any

Responses

Request samples

Content type
application/json
{
  • "specversion": "1.0",
  • "type": "event.signal",
  • "dataschema": "evt:signal/v1",
  • "id": "message identifier 1",
  • "time": "2007-04-05T14:32:10.700Z",
  • "data": {
    • "cartId": "cart",
    • "email": "john.doe@cheetahdigital.com",
    • "site": "www.example.com",
    • "transactionId": "2a3c8c6c-54ee-47d6-97fc-0cbc8e0faf39",
    • "transactionSource": "POS-XYZ",
    • "eventAttributes": {
      • "channel": "Email message",
      • "ip": "127.0.0.2",
      • "userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_6 like Mac OS X)",
      • "deviceType": "ios",
      • "country": "US",
      • "state": "CA",
      • "city": "Synnyvale",
      • "postalCode": 94089
      },
    • "profileAttributes": {
      • "profileCity": "Sunnyvale",
      • "profileState": "CA",
      • "profilePostalCode": "94089",
      • "profileLastName": "Doe",
      • "profileFirstName": "John"
      },
    • "items": [
      • {
        }
      ]
    }
}

Cart Replace Signal

Cart Replace Signal endpoint

Processes Cart Replace signal

Authorizations:
JwtToken
Request Body schema: application/json
specversion
required
string (Schema version)
Default: "1.0"

Schema version

Value: "1.0"
type
required
string (Type)
Default: "event.signal"

The classification/category of event

Value: "event.signal"
dataschema
required
string (Data Schema)
Default: "evt:signal/v1"

A reference to the definition of the structure of data

Value: "evt:signal/v1"
id
required
string (Event ID)
Default: ""

Identifier for event. Unique per source. GUID

traceId
string (Trace ID)
Default: ""

Unique ID for tracing request across systems

source
string
Default: ""

Globally Unique Platform identifier. ':'

time
required
string (Time)
Default: ""

Date and time an event / activity the event relates to

required
object (Data section of the Signal event)

The payload of the event

site
required
string (Site)
Default: ""

Site or domain

email
required
string (Email)
Default: ""

User email

object (Profile Attributes)

Flexible mechanism to store custom attributes of the member profile

object (Event Attributes)

Flexible mechanism to store custom attributes related to the event

required
Array of objects (Items)
Default: []

List of Items

additionalProperties
any

Responses

Request samples

Content type
application/json
{
  • "specversion": "1.0",
  • "type": "event.signal",
  • "dataschema": "evt:signal/v1",
  • "id": "message identifier 1",
  • "time": "2007-04-05T14:32:10.700Z",
  • "data": {
    • "email": "john.doe@cheetahdigital.com",
    • "site": "www.example.com",
    • "cartId": "id",
    • "eventAttributes": {
      • "channel": "Email message",
      • "ip": "127.0.0.2",
      • "userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_6 like Mac OS X)",
      • "deviceType": "ios",
      • "country": "US",
      • "state": "CA",
      • "city": "Synnyvale",
      • "postalCode": 94089
      },
    • "profileAttributes": {
      • "profileCity": "Sunnyvale",
      • "profileState": "CA",
      • "profilePostalCode": "94089",
      • "profileLastName": "Doe",
      • "profileFirstName": "John"
      },
    • "items": [
      • {
        }
      ]
    }
}

Game Start Signal

Game Start Signal endpoint

Processes Game Start Signal

Authorizations:
JwtToken
Request Body schema: application/json
specversion
required
string (Schema version)
Default: "1.0"

Schema version

Value: "1.0"
type
required
string (Type)
Default: "event.signal"

The classification/category of event

Value: "event.signal"
dataschema
required
string (Data Schema)
Default: "evt:signal/v1"

A reference to the definition of the structure of data

Value: "evt:signal/v1"
id
required
string (Event ID)
Default: ""

Identifier for event. Unique per source. GUID

traceId
string (Trace ID)
Default: ""

Unique ID for tracing request across systems

source
string
Default: ""

Globally Unique Platform identifier. ':'

time
required
string (Time)
Default: ""

Date and time an event / activity the event relates to

required
object (Data section of the Signal event)

The payload of the event

gameId
required
string (Game ID)
Default: ""

Game identifier

gameName
required
string (Game Name)
Default: ""

Game name

email
required
string (Email)
Default: ""

User email

object (Profile Attributes)

Flexible mechanism to store custom attributes of the member profile

object (Event Attributes)

Flexible mechanism to store custom attributes related to the event

additionalProperties
any

Responses

Request samples

Content type
application/json
{
  • "specversion": "1.0",
  • "type": "event.signal",
  • "dataschema": "evt:signal/v1",
  • "id": "message identifier 1",
  • "time": "2007-04-05T14:32:10.700Z",
  • "data": {
    • "gameId": "G128765",
    • "gameName": "Game #234",
    • "email": "john.doe@cheetahdigital.com",
    • "eventAttributes": {
      • "channel": "Email message",
      • "ip": "127.0.0.2",
      • "userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_6 like Mac OS X)",
      • "deviceType": "ios",
      • "country": "US",
      • "state": "CA",
      • "city": "Synnyvale",
      • "postalCode": 94089
      },
    • "profileAttributes": {
      • "profileCity": "Sunnyvale",
      • "profileState": "CA",
      • "profilePostalCode": "94089",
      • "profileLastName": "Doe",
      • "profileFirstName": "John"
      }
    }
}

Game End Signal

Game End Signal endpoint

Processes Game End Signal

Authorizations:
JwtToken
Request Body schema: application/json
specversion
required
string (Schema version)
Default: "1.0"

Schema version

Value: "1.0"
type
required
string (Type)
Default: "event.signal"

The classification/category of event

Value: "event.signal"
dataschema
required
string (Data Schema)
Default: "evt:signal/v1"

A reference to the definition of the structure of data

Value: "evt:signal/v1"
id
required
string (Event ID)
Default: ""

Identifier for event. Unique per source. GUID

traceId
string (Trace ID)
Default: ""

Unique ID for tracing request across systems

source
string
Default: ""

Globally Unique Platform identifier. ':'

time
required
string (Time)
Default: ""

Date and time an event / activity the event relates to

required
object (Data section of the Signal event)

The payload of the event

gameId
required
string (Game ID)
Default: ""

Game identifier

gameName
required
string (Game Name)
Default: ""

Game name

email
required
string (Email)
Default: ""

User email

object (Profile Attributes)

Flexible mechanism to store custom attributes of the member profile

object (Event Attributes)

Flexible mechanism to store custom attributes related to the event

additionalProperties
any

Responses

Request samples

Content type
application/json
{
  • "specversion": "1.0",
  • "type": "event.signal",
  • "dataschema": "evt:signal/v1",
  • "id": "message identifier 1",
  • "time": "2007-04-05T14:32:10.700Z",
  • "data": {
    • "gameId": "G128765",
    • "gameName": "Game #234",
    • "email": "john.doe@cheetahdigital.com",
    • "eventAttributes": {
      • "channel": "Email message",
      • "ip": "127.0.0.2",
      • "userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_6 like Mac OS X)",
      • "deviceType": "ios",
      • "country": "US",
      • "state": "CA",
      • "city": "Synnyvale",
      • "postalCode": 94089
      },
    • "profileAttributes": {
      • "profileCity": "Sunnyvale",
      • "profileState": "CA",
      • "profilePostalCode": "94089",
      • "profileLastName": "Doe",
      • "profileFirstName": "John"
      }
    }
}

Booking Start Signal

Booking Start Signal endpoint

Processes Booking Start Signal

Authorizations:
JwtToken
Request Body schema: application/json
specversion
required
string (Schema version)
Default: "1.0"

Schema version

Value: "1.0"
type
required
string (Type)
Default: "event.signal"

The classification/category of event

Value: "event.signal"
dataschema
required
string (Data Schema)
Default: "evt:signal/v1"

A reference to the definition of the structure of data

Value: "evt:signal/v1"
id
required
string (Event ID)
Default: ""

Identifier for event. Unique per source. GUID

traceId
string (Trace ID)
Default: ""

Unique ID for tracing request across systems

source
string
Default: ""

Globally Unique Platform identifier. ':'

time
required
string (Time)
Default: ""

Date and time an event / activity the event relates to

required
object (Data section of the Signal event)

The payload of the event

bookingId
required
string (Booking ID)
Default: ""

Booking identifier

bookingName
required
string (Booking Name)
Default: ""

Booking name

email
required
string (Email)
Default: ""

User email

object (Profile Attributes)

Flexible mechanism to store custom attributes of the member profile

object (Event Attributes)

Flexible mechanism to store custom attributes related to the event

additionalProperties
any

Responses

Request samples

Content type
application/json
{
  • "specversion": "1.0",
  • "type": "event.signal",
  • "dataschema": "evt:signal/v1",
  • "id": "message identifier 1",
  • "time": "2007-04-05T14:32:10.700Z",
  • "data": {
    • "bookingId": "B128765",
    • "bookingName": "Hotel Booking #234",
    • "email": "john.doe@cheetahdigital.com",
    • "eventAttributes": {
      • "channel": "Email message",
      • "ip": "127.0.0.2",
      • "userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_6 like Mac OS X)",
      • "deviceType": "ios",
      • "country": "US",
      • "state": "CA",
      • "city": "Synnyvale",
      • "postalCode": 94089
      },
    • "profileAttributes": {
      • "profileCity": "Sunnyvale",
      • "profileState": "CA",
      • "profilePostalCode": "94089",
      • "profileLastName": "Doe",
      • "profileFirstName": "John"
      }
    }
}

Booking Complete Signal

Booking Complete Signal endpoint

Processes Booking Complete Signal

Authorizations:
JwtToken
Request Body schema: application/json
specversion
required
string (Schema version)
Default: "1.0"

Schema version

Value: "1.0"
type
required
string (Type)
Default: "event.signal"

The classification/category of event

Value: "event.signal"
dataschema
required
string (Data Schema)
Default: "evt:signal/v1"

A reference to the definition of the structure of data

Value: "evt:signal/v1"
id
required
string (Event ID)
Default: ""

Identifier for event. Unique per source. GUID

traceId
string (Trace ID)
Default: ""

Unique ID for tracing request across systems

source
string
Default: ""

Globally Unique Platform identifier. ':'

time
required
string (Time)
Default: ""

Date and time an event / activity the event relates to

required
object (Data section of the Signal event)

The payload of the event

bookingId
required
string (Booking ID)
Default: ""

Booking identifier

bookingName
required
string (Booking Name)
Default: ""

Booking name

email
required
string (Email)
Default: ""

User email

object (Profile Attributes)

Flexible mechanism to store custom attributes of the member profile

object (Event Attributes)

Flexible mechanism to store custom attributes related to the event

additionalProperties
any

Responses

Request samples

Content type
application/json
{
  • "specversion": "1.0",
  • "type": "event.signal",
  • "dataschema": "evt:signal/v1",
  • "id": "message identifier 1",
  • "time": "2007-04-05T14:32:10.700Z",
  • "data": {
    • "bookingId": "B128765",
    • "bookingName": "Hotel Booking #234",
    • "email": "john.doe@cheetahdigital.com",
    • "eventAttributes": {
      • "channel": "Email message",
      • "ip": "127.0.0.2",
      • "userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_6 like Mac OS X)",
      • "deviceType": "ios",
      • "country": "US",
      • "state": "CA",
      • "city": "Synnyvale",
      • "postalCode": 94089
      },
    • "profileAttributes": {
      • "profileCity": "Sunnyvale",
      • "profileState": "CA",
      • "profilePostalCode": "94089",
      • "profileLastName": "Doe",
      • "profileFirstName": "John"
      }
    }
}

Survey Start Signal

Survey Start Signal endpoint

Processes Survey Start Signal

Authorizations:
JwtToken
Request Body schema: application/json
specversion
required
string (Schema version)
Default: "1.0"

Schema version

Value: "1.0"
type
required
string (Type)
Default: "event.signal"

The classification/category of event

Value: "event.signal"
dataschema
required
string (Data Schema)
Default: "evt:signal/v1"

A reference to the definition of the structure of data

Value: "evt:signal/v1"
id
required
string (Event ID)
Default: ""

Identifier for event. Unique per source. GUID

traceId
string (Trace ID)
Default: ""

Unique ID for tracing request across systems

source
string
Default: ""

Globally Unique Platform identifier. ':'

time
required
string (Time)
Default: ""

Date and time an event / activity the event relates to

required
object (Data section of the Signal event)

The payload of the event

surveyId
required
string (Survey ID)
Default: ""

Survey identifier

surveyName
required
string (Survey Name)
Default: ""

Survey name

email
required
string (Email)
Default: ""

User email

object (Profile Attributes)

Flexible mechanism to store custom attributes of the member profile

object (Event Attributes)

Flexible mechanism to store custom attributes related to the event

additionalProperties
any

Responses

Request samples

Content type
application/json
{
  • "specversion": "1.0",
  • "type": "event.signal",
  • "dataschema": "evt:signal/v1",
  • "id": "message identifier 1",
  • "time": "2007-04-05T14:32:10.700Z",
  • "data": {
    • "surveyId": "S128765",
    • "surveyName": "Survey #234",
    • "email": "john.doe@cheetahdigital.com",
    • "eventAttributes": {
      • "channel": "Email message",
      • "ip": "127.0.0.2",
      • "userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_6 like Mac OS X)",
      • "deviceType": "ios",
      • "country": "US",
      • "state": "CA",
      • "city": "Synnyvale",
      • "postalCode": 94089
      },
    • "profileAttributes": {
      • "profileCity": "Sunnyvale",
      • "profileState": "CA",
      • "profilePostalCode": "94089",
      • "profileLastName": "Doe",
      • "profileFirstName": "John"
      }
    }
}

Survey Complete Signal

Survey Complete Signal endpoint

Processes Survey Complete Signal

Authorizations:
JwtToken
Request Body schema: application/json
specversion
required
string (Schema version)
Default: "1.0"

Schema version

Value: "1.0"
type
required
string (Type)
Default: "event.signal"

The classification/category of event

Value: "event.signal"
dataschema
required
string (Data Schema)
Default: "evt:signal/v1"

A reference to the definition of the structure of data

Value: "evt:signal/v1"
id
required
string (Event ID)
Default: ""

Identifier for event. Unique per source. GUID

traceId
string (Trace ID)
Default: ""

Unique ID for tracing request across systems

source
string
Default: ""

Globally Unique Platform identifier. ':'

time
required
string (Time)
Default: ""

Date and time an event / activity the event relates to

required
object (Data section of the Signal event)

The payload of the event

surveyId
required
string (Survey ID)
Default: ""

Survey identifier

surveyName
required
string (Survey Name)
Default: ""

Survey name

email
required
string (Email)
Default: ""

User email

object (Profile Attributes)

Flexible mechanism to store custom attributes of the member profile

object (Event Attributes)

Flexible mechanism to store custom attributes related to the event

additionalProperties
any

Responses

Request samples

Content type
application/json
{
  • "specversion": "1.0",
  • "type": "event.signal",
  • "dataschema": "evt:signal/v1",
  • "id": "message identifier 1",
  • "time": "2007-04-05T14:32:10.700Z",
  • "data": {
    • "surveyId": "S128765",
    • "surveyName": "Survey #234",
    • "email": "john.doe@cheetahdigital.com",
    • "eventAttributes": {
      • "channel": "Email message",
      • "ip": "127.0.0.2",
      • "userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_6 like Mac OS X)",
      • "deviceType": "ios",
      • "country": "US",
      • "state": "CA",
      • "city": "Synnyvale",
      • "postalCode": 94089
      },
    • "profileAttributes": {
      • "profileCity": "Sunnyvale",
      • "profileState": "CA",
      • "profilePostalCode": "94089",
      • "profileLastName": "Doe",
      • "profileFirstName": "John"
      }
    }
}

Browse Category Signal

Browse Category Signal endpoint

Browse Category Complete Signal

Authorizations:
JwtToken
Request Body schema: application/json
specversion
required
string (Schema version)
Default: "1.0"

Schema version

Value: "1.0"
type
required
string (Type)
Default: "event.signal"

The classification/category of event

Value: "event.signal"
dataschema
required
string (Data Schema)
Default: "evt:signal/v1"

A reference to the definition of the structure of data

Value: "evt:signal/v1"
id
required
string (Event ID)
Default: ""

Identifier for event. Unique per source. GUID

traceId
string (Trace ID)
Default: ""

Unique ID for tracing request across systems

source
string
Default: ""

Globally Unique Platform identifier. ':'

time
required
string (Time)
Default: ""

Date and time an event / activity the event relates to

required
object (Data section of the Signal event)

The payload of the event

site
required
string (Site)
Default: ""

Site or site identifier

email
required
string (Email)
Default: ""

User email

object (Profile Attributes)

Flexible mechanism to store custom attributes of the member profile

object (Event Attributes)

Flexible mechanism to store custom attributes related to the event

sections
required
Array of strings (Sections) [ items ]
Default: []

List of Sections

additionalProperties
any

Responses

Request samples

Content type
application/json
{
  • "specversion": "1.0",
  • "type": "event.signal",
  • "dataschema": "evt:signal/v1",
  • "id": "message identifier 1",
  • "time": "2007-04-05T14:32:10.700Z",
  • "data": {
    • "email": "john.doe@cheetahdigital.com",
    • "site": "www.example.com",
    • "eventAttributes": {
      • "channel": "Email message",
      • "ip": "127.0.0.2",
      • "userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_6 like Mac OS X)",
      • "deviceType": "ios",
      • "country": "US",
      • "state": "CA",
      • "city": "Synnyvale",
      • "postalCode": 94089
      },
    • "profileAttributes": {
      • "profileCity": "Sunnyvale",
      • "profileState": "CA",
      • "profilePostalCode": "94089",
      • "profileLastName": "Doe",
      • "profileFirstName": "John"
      },
    • "sections": [
      • [
        ],
      • [
        ]
      ]
    }
}

Browse Product Signal

Browse Product Signal endpoint

Processes Browse Product Signal

Authorizations:
JwtToken
Request Body schema: application/json
specversion
required
string (Schema version)
Default: "1.0"

Schema version

Value: "1.0"
type
required
string (Type)
Default: "event.signal"

The classification/category of event

Value: "event.signal"
dataschema
required
string (Data Schema)
Default: "evt:signal/v1"

A reference to the definition of the structure of data

Value: "evt:signal/v1"
id
required
string (Event ID)
Default: ""

Identifier for event. Unique per source. GUID

traceId
string (Trace ID)
Default: ""

Unique ID for tracing request across systems

source
string
Default: ""

Globally Unique Platform identifier. ':'

time
required
string (Time)
Default: ""

Date and time an event / activity the event relates to

required
object (Data section of the Signal event)

The payload of the event

site
required
string (Site)
Default: ""

Site or Site identifier

email
required
string (Email)
Default: ""

User email

object (Profile Attributes)

Flexible mechanism to store custom attributes of the member profile

object (Event Attributes)

Flexible mechanism to store custom attributes related to the event

sections
required
Array of strings (Sections) [ items ]
Default: []

List of Sections

required
Array of objects (Items)
Default: []

List of Items

additionalProperties
any

Responses

Request samples

Content type
application/json
{
  • "specversion": "1.0",
  • "type": "event.signal",
  • "dataschema": "evt:signal/v1",
  • "id": "message identifier 1",
  • "time": "2007-04-05T14:32:10.700Z",
  • "data": {
    • "site": "www.example.com",
    • "email": "john.doe@cheetahdigital.com",
    • "eventAttributes": {
      • "channel": "Email message",
      • "ip": "127.0.0.2",
      • "userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_6 like Mac OS X)",
      • "deviceType": "ios",
      • "country": "US",
      • "state": "CA",
      • "city": "Synnyvale",
      • "postalCode": 94089
      },
    • "profileAttributes": {
      • "profileCity": "Sunnyvale",
      • "profileState": "CA",
      • "profilePostalCode": "94089",
      • "profileLastName": "Doe",
      • "profileFirstName": "John"
      },
    • "sections": [
      • [
        ],
      • [
        ]
      ],
    • "items": [
      • {
        }
      ]
    }
}

Site Signin Signal

Site Signin Signal endpoint

Site Signin Product Signal

Authorizations:
JwtToken
Request Body schema: application/json
specversion
required
string (Schema version)
Default: "1.0"

Schema version

Value: "1.0"
type
required
string (Type)
Default: "event.signal"

The classification/category of event

Value: "event.signal"
dataschema
required
string (Data Schema)
Default: "evt:signal/v1"

A reference to the definition of the structure of data

Value: "evt:signal/v1"
id
required
string (Event ID)
Default: ""

Identifier for event. Unique per source. GUID

traceId
string (Trace ID)
Default: ""

Unique ID for tracing request across systems

source
string
Default: ""

Globally Unique Platform identifier. ':'

time
required
string (Time)
Default: ""

Date and time an event / activity the event relates to

required
object (Data section of the Signal event)

The payload of the event

site
required
string (Site)
Default: ""

Site or domain

email
required
string (Email)
Default: ""

User email

object (Profile Attributes)

Flexible mechanism to store custom attributes of the member profile

object (Event Attributes)

Flexible mechanism to store custom attributes related to the event

additionalProperties
any

Responses

Request samples

Content type
application/json
{
  • "specversion": "1.0",
  • "type": "event.signal",
  • "dataschema": "evt:signal/v1",
  • "id": "message identifier 1",
  • "time": "2007-04-05T14:32:10.700Z",
  • "data": {
    • "site": "www.example.com",
    • "email": "john.doe@cheetahdigital.com",
    • "eventAttributes": {
      • "channel": "Email message",
      • "ip": "127.0.0.2",
      • "userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_6 like Mac OS X)",
      • "deviceType": "ios",
      • "country": "US",
      • "state": "CA",
      • "city": "Synnyvale",
      • "postalCode": 94089
      },
    • "profileAttributes": {
      • "profileCity": "Sunnyvale",
      • "profileState": "CA",
      • "profilePostalCode": "94089",
      • "profileLastName": "Doe",
      • "profileFirstName": "John"
      }
    }
}

Site Signout Signal

Site Signout Signal endpoint

Site Signout Product Signal

Authorizations:
JwtToken
Request Body schema: application/json
specversion
required
string (Schema version)
Default: "1.0"

Schema version

Value: "1.0"
type
required
string (Type)
Default: "event.signal"

The classification/category of event

Value: "event.signal"
dataschema
required
string (Data Schema)
Default: "evt:signal/v1"

A reference to the definition of the structure of data

Value: "evt:signal/v1"
id
required
string (Event ID)
Default: ""

Identifier for event. Unique per source. GUID

traceId
string (Trace ID)
Default: ""

Unique ID for tracing request across systems

source
string
Default: ""

Globally Unique Platform identifier. ':'

time
required
string (Time)
Default: ""

Date and time an event / activity the event relates to

required
object (Data section of the Signal event)

The payload of the event

site
required
string (Site)
Default: ""

Site or domain

email
required
string (Email)
Default: ""

User email

object (Profile Attributes)

Flexible mechanism to store custom attributes of the member profile

object (Event Attributes)

Flexible mechanism to store custom attributes related to the event

additionalProperties
any

Responses

Request samples

Content type
application/json
{
  • "specversion": "1.0",
  • "type": "event.signal",
  • "dataschema": "evt:signal/v1",
  • "id": "message identifier 1",
  • "time": "2007-04-05T14:32:10.700Z",
  • "data": {
    • "site": "www.example.com",
    • "profileName": "John Doe",
    • "email": "john.doe@cheetahdigital.com",
    • "eventAttributes": {
      • "channel": "Email message",
      • "ip": "127.0.0.2",
      • "userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_6 like Mac OS X)",
      • "deviceType": "ios",
      • "country": "US",
      • "state": "CA",
      • "city": "Synnyvale",
      • "postalCode": 94089
      },
    • "profileAttributes": {
      • "profileCity": "Sunnyvale",
      • "profileState": "CA",
      • "profilePostalCode": "94089",
      • "profileLastName": "Doe",
      • "profileFirstName": "John"
      }
    }
}