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

/cce/push

This API can be used for feeding of CCE events to the processing system.

Request

The request object has the following fields:

Name

Type

Required

Description

events

Array of CCE_Event

Yes

An array containing exactly one CCE event to feed.

Each CCE_Event object has the following fields:

Name

Type

Required

Description

eventType

Enum

No

One of 'dmp' (CCE_DMP_Event) and 'conversion' (CCE_Conversion_Event). Default: 'dmp'.

userIds

Array of Object

Yes

List of known user identities to identify the user. Note that different users must be fed as different events.

siteId

String

Yes

The analytics site identifier to be associated with the events.

consent

Array of String

No

The list of classes the end-user has given consent to. If provided, the special class 'y' must be present in the list. More information can be found

here

.

pageViewEventId

Integer

No*

A value uniquely identifying the corresponding page view event. In order to link CCE events to page views this value must be identical to the eventId value of an

exported page view event

.

eventId

Integer

No*

A value uniquely identifying this event. Multiple events on the same page view must have distinct eventId values. Values of previously imported events can be obtained via

/dmp/traffic/data

.

prnd

String

No*

An alternative specification for pageViewEventId, meant to be used by the

sendEvent(..)

function or similar. In order to link CCE events to page views this value must be identical to the rnd value of the

page view event

.

rnd

String

No*

An alternative specification for eventId, meant to be used by the

sendEvent(..)

function or similar. Multiple events on the same page view must have distinct rnd values.

Each user identifier object has the following fields:

Name

Type

Required

Description

type

String

Yes

Site specific identifier (type cx) or

external user identifier

type.

id

String

Yes

Value of the user identifier.

* Please observe that the CCE_Event object can't be sent directly and concrete implementations of it, described below, must be used instead.

Event identifier clarification

  • While not mandatory, it is highly recommended to specify eventId/rnd and pageViewEventId/prnd for each event. pageViewEventId/prnd is needed to distinguish between events corresponding to different page views, and eventId/rnd is needed to distinguish between different events for a single page view. For correct linking with page views, the pageViewEventId value must correspond to the eventId value of the corresponding page view event.

  • Generally speaking, eventId and pageViewEventId should be used when the eventId value of the original page view event is available (e.g., importing new DMP event based on the previous results from /traffic/data and /dmp/traffic/data), while rnd and prnd specification should be used when the rnd value of the originating page view event is available (i.e., alongside sending a page view event from cx.js).

  • Missing eventId/rnd will result in eventId being set to 0, missing pageViewEventId/prnd will result in pageViewEventId being set to 0. If two events for the same user have the same eventId/rnd and pageViewEventId/prnd, then the two events will be considered as duplicates. Duplicate events is subject to de-duplication.



  • To be able to link CCE events against page view events, userIds, pageViewEventId/prnd and siteId of each event must match the values fed with the corresponding event id.

  • Note also that time of fed events will be set to current server time.


CCE DMP Event

Creates a DMP event. Has same limitations as the /dmp/push API with a few exceptions:

  • 'time' field is not supported.

  • this API is public and does not require authentication (or persisted query).

  • api.cxense.com is not supported (only comcluster.cxense.com)

The prefixes used in the user identities and the origin must match those configured on the provided site.

The site must be set up with long-term, dmp and conversion engine capabilities.

Each CCE_DMP_Event object includes all the CCE_Event fields plus the following:

Name

Type

Required

Description

eventType

Enum

No

If provided, must be 'dmp'.

origin

String

Yes

Differentiates various DMP applications used by the customer. Must be prefixed by the

customer prefix

e.g. pre-origin0.

type

String

Yes

Differentiates various event types, e.g., "click", "impression", "conversion", etc.

customParameters

Array of Object

No

An optional list of customer-defined parameters. Parameters fed with DMP events follow the

same syntactical restrictions and limits as for ordinary custom-parameters for analytics events

.

For the custom parameter object, the following fields apply:

Name

Type

Required

Description

group

String

Yes

Parameter name, e.g., "campaign", "adspace" or "creative". The group name must be unique within the customParameters.

type

String

No

Parameter type, e.g. 'number' or 'string'. Use number for items to be used as

DMP metrics

, and string for items to be used in top-lists.

item

String

Yes

Parameter value, e.g. '"sale"', '0.32', '42'. The format must agree with the specified type, i.e., use "42" for string and 42 for number.

Syntactical Restrictions

  • STRING PARAMETERS: The maximum length of string parameters is 30 characters.

  • CUSTOM_PARAMETERS: The maximum number of distinct type/origin combinations per customer is 10.

  • CUSTOM_PARAMETERS: The maximum number of distinct group/item combinations per type/origin combination is 1000.


CCE Conversion Event

Creates a conversion event. In order to use this event type you need to obtain a conversion product object identifier first.

We recommend to use the cx.cce.js function - sendConversionEvent(..) when sending conversion events with a client-side approach (whenever it is possible). The function automatically sets the correct values for userIds and siteId.

The prefixes used in the user identities must match those configured on the provided site.

The site must be set up with conversion engine capabilities.

Each CCE_Conversion_Event object includes all the CCE_Event fields plus the following:

Name

Type

Required

Description

eventType

Enum

Yes

Must be 'conversion'.

productId

String

Yes

An identifier of the

conversion product object

the conversion is associated with.

funnelStep

String

Yes

A current step in the conversion funnel the event represents. Can be one of the pre-defined 'convertProduct', 'terminateProduct' and 'renewProduct' or alternatively any string representing the step e.g. 'creditCardDetails'. See the clarification below.

Syntactical Restrictions

  • STRING PARAMETERS: The maximum length of string parameters is 30 characters.


Funnel step clarification

  • Funnel step can be used both to identify the special 'convertProduct', 'terminateProduct' and 'renewProduct' conversion events (used internally by the system) and to identify any additional step each particular user has in their system. Therefore the recommended way is to use the pre-defined steps whenever possible even if there is a strong desire to use the custom name (e.g. the step in the user system is called 'subscription' but in reality represents the product conversion hence the name 'convertProduct' must be used instead).


Response

The normal response is an empty object.

Examples

Bash
$ curl https://comcluster.cxense.com/cce/push -H "Content-Type: application/json" -d '{
 "events": [
 {
 "eventType": "dmp",
 "userIds": [
 {
 "type": "cxd",
 "id": "123456"
 }
 ],
 "pageViewEventId": 12345,
 "eventId": 12,
 "siteId": "987654321",
 "type": "impression",
 "origin": "cxd-ads",
 "customParameters": [
 {
 "group": "ad",
 "item": "shoead5"
 },
 {
 "group": "campaign",
 "item": "shoesale"
 },
 {
 "group": "creative",
 "item": "fancyshoe"
 },
 {
 "group": "adspace",
 "item": "header"
 }
 ]
 },
 {
 "eventType": "conversion",
 "userIds": [
 {
 "type": "cxd",
 "id": "123456"
 }
 ],
 "siteId": "987654321",
 "productId": "8n3fb6l8q1by",
 "funnelStep": "convertProduct"
 }
 ]
}'
{}

Last updated: