POST
/
create-events

Headers

referer
string
user-agent
string
x-forwarded-for
string
x-forwarded-host
string

Body

application/json · object[]
tenant
string
required

Identifier associated with the API integration

market
string
required

Market identifier

deduplication_id
string | null

If retrying creating events, this should be set to a unique value common across all requests with the same event

type
enum<string>
required

Type of event

Available options:
page_view,
click,
add_to_cart,
purchase,
element_visible,
ws_click,
recommendations_inserted,
native_shopify_collection_click,
native_shopify_collection_view
user_id
string | null

Customer identifier

session_id
string | null

Session identifier

dsid
string | null

Populated for integrations performed by Depict.ai only. Depict.ai Session Id

ab_test_group
string | null

A/B test group identifier. Not required.

product_id
string | null

Main product identifier

variant_ids
string[] | null

Identifiers of variants for this product. Not required.

entity_identifiers
object | null

Key-value object containing additional identifiers for the product

url
string | null

The value of document.location.href in the user's browser

entity_price
string | null

Current price of product. Not required.

currency
string | null

Currency of product (ISO 4217 code). Not required.

document_referrer
string | null

The value of document.referrer in the user's browser

document_width
string | null

The value of document.width in the user's browser

attribution_id
string | null

Keyword specifying what led to this event. Not required.

recommendation_id
string | null

Unique identifier returned from the /recommend endpoint

search_result_id
string | null

Unique identifier of the search result.

product_listing_result_id
string | null

Unique identifier of the product listing result.

click_location
string | null

Keyword specifying what element was clicked. Not required.

page_url
string | null

The URL of the product page visited

recommendation_type
string | null

The type of recommendations inserted

collection_handle
string | null

The handle of the shopify collection the click originates from

shopify_collection_id
string | null

The id of the shopify collection the click originates from

Response

200 - application/json

The response is of type any.

Was this page helpful?

Recommend For Products And UserTrack V2