Skip to main content
POST
/
create-events
Create Events
curl --request POST \
  --url 'https://api.example.com/create-events?api_key=' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "tenant": "<string>",
    "market": "<string>",
    "type": "page_view",
    "deduplication_id": "<string>",
    "user_id": "<string>",
    "session_id": "<string>",
    "dsid": "<string>",
    "ab_test_group": "<string>",
    "product_id": "<string>",
    "variant_ids": [
      "<string>"
    ],
    "entity_identifiers": {},
    "url": "<string>",
    "entity_price": "<string>",
    "currency": "<string>",
    "document_referrer": "<string>",
    "document_width": "<string>",
    "attribution_id": "<string>",
    "recommendation_id": "<string>",
    "search_result_id": "<string>",
    "product_listing_result_id": "<string>",
    "click_location": "<string>",
    "page_url": "<string>",
    "recommendation_type": "<string>"
  }
]
'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.depict.ai/llms.txt

Use this file to discover all available pages before exploring further.

This page does not apply to installs made in 2025 or later of the Depict Shopify apps

Authorizations

api_key
string
query
required

Headers

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

Body

application/json
tenant
string
required

Identifier associated with the API integration

market
string
required

Market identifier

type
enum<string>
required

Type of event

Available options:
page_view,
click,
add_to_cart,
purchase,
element_visible,
ws_click,
recommendations_inserted
deduplication_id
string | null

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

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 string 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
Entity Identifiers · object

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

Response

Successful Response