Events (v2)

Create Events

There are 5 types of events: - page_view - click - add_to_cart - purchase - element_visible For most integrations, we recommend sending `add_to_cart` events. Note that most of the event fields are not mandatory. See more details about each event field below. For events of type `click` the `recommendation_id` for the clicked recommendation (which is returned from the `/recommend` endpoint) should be set if available. Examples requests: <pre> [{ "tenant": "my_store", "market": "us", "type": "page_view", "user_id": "GA1.2.00000000.0000000000", "url": "https://my_store.com/awesome_mechanical_keyboard.html", "product_id": "BLA-KEY-XXX", "entity_identifiers": { "sku": "31415" }, "entity_price": "100$", "document_width": "300" }] </pre> <pre> [{ "tenant": "my_store", "market": "us", "type": "click", "user_id": "ga1.2.00000000.0000000000", "url": "https://my_store.com/awesome_mechanical_keyboard.html", "product_id": "bla-key-xxx", "entity_identifiers": { "sku": "31415" }, "entity_price": "100$", "document_width": "300", "recommendation_id": "827ada29-92e7-4642-8805-8b7105a9c8a5", "click_location": "landing_page_recommendation_1" }] </pre> <details> <summary>View more examples</summary> <pre> [{ "tenant": "my_store", "market": "us", "type": "add_to_cart", "user_id": "GA1.2.00000000.0000000000", "url": "https://my_store.com/awesome_mechanical_keyboard.html", "product_id": "BLA-KEY-XXX", "entity_identifiers": { "sku": "31415" }, "entity_price": "100$", "document_width": "300" }] </pre> <pre> [{ "tenant": "my_store", "market": "us", "type": "purchase", "user_id": "GA1.2.00000000.0000000000", "url": "https://my_store.com/checkout.html", "product_id": "BLA-KEY-XXX", "entity_identifiers": { "sku": "31415" }, "entity_price": "100$", "document_width": "300" }] </pre> <pre> [{ "tenant": "my_store", "market": "us", "type": "element_visible", "user_id": "GA1.2.00000000.0000000000", "url": "https://my_store.com/checkout.html", "product_id": "BLA-KEY-XXX", "entity_identifiers": { "sku": "31415" }, "entity_price": "100$", "document_width": "300", "recommendation_id": "827ada29-92e7-4642-8805-8b7105a9c8a5" }] </pre> </details>

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

Minimum length: 1

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 User Track V2

Glossary

Shopify app

Data ingestion

Search

Product Listing Pages

Product Listing Pages and Search

Recommendations SDK

Tracking Product Interactions

HTTP API

Create Events

Headers

Body

Response