Create Events
curl --request POST \
--url https://api.depict.ai/create-events \
--header 'Content-Type: application/json' \
--data '
[
{
"tenant": "<string>",
"market": "<string>",
"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>",
"collection_handle": "<string>",
"shopify_collection_id": "<string>",
"grid_item_id": 123,
"grid_item_link": "<string>",
"depict_ab_variant": "<string>"
}
]
'import requests
url = "https://api.depict.ai/create-events"
payload = [
{
"tenant": "<string>",
"market": "<string>",
"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>",
"collection_handle": "<string>",
"shopify_collection_id": "<string>",
"grid_item_id": 123,
"grid_item_link": "<string>",
"depict_ab_variant": "<string>"
}
]
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify([
{
tenant: '<string>',
market: '<string>',
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>',
collection_handle: '<string>',
shopify_collection_id: '<string>',
grid_item_id: 123,
grid_item_link: '<string>',
depict_ab_variant: '<string>'
}
])
};
fetch('https://api.depict.ai/create-events', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.depict.ai/create-events",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
[
'tenant' => '<string>',
'market' => '<string>',
'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>',
'collection_handle' => '<string>',
'shopify_collection_id' => '<string>',
'grid_item_id' => 123,
'grid_item_link' => '<string>',
'depict_ab_variant' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.depict.ai/create-events"
payload := strings.NewReader("[\n {\n \"tenant\": \"<string>\",\n \"market\": \"<string>\",\n \"deduplication_id\": \"<string>\",\n \"user_id\": \"<string>\",\n \"session_id\": \"<string>\",\n \"dsid\": \"<string>\",\n \"ab_test_group\": \"<string>\",\n \"product_id\": \"<string>\",\n \"variant_ids\": [\n \"<string>\"\n ],\n \"entity_identifiers\": {},\n \"url\": \"<string>\",\n \"entity_price\": \"<string>\",\n \"currency\": \"<string>\",\n \"document_referrer\": \"<string>\",\n \"document_width\": \"<string>\",\n \"attribution_id\": \"<string>\",\n \"recommendation_id\": \"<string>\",\n \"search_result_id\": \"<string>\",\n \"product_listing_result_id\": \"<string>\",\n \"click_location\": \"<string>\",\n \"page_url\": \"<string>\",\n \"recommendation_type\": \"<string>\",\n \"collection_handle\": \"<string>\",\n \"shopify_collection_id\": \"<string>\",\n \"grid_item_id\": 123,\n \"grid_item_link\": \"<string>\",\n \"depict_ab_variant\": \"<string>\"\n }\n]")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.depict.ai/create-events")
.header("Content-Type", "application/json")
.body("[\n {\n \"tenant\": \"<string>\",\n \"market\": \"<string>\",\n \"deduplication_id\": \"<string>\",\n \"user_id\": \"<string>\",\n \"session_id\": \"<string>\",\n \"dsid\": \"<string>\",\n \"ab_test_group\": \"<string>\",\n \"product_id\": \"<string>\",\n \"variant_ids\": [\n \"<string>\"\n ],\n \"entity_identifiers\": {},\n \"url\": \"<string>\",\n \"entity_price\": \"<string>\",\n \"currency\": \"<string>\",\n \"document_referrer\": \"<string>\",\n \"document_width\": \"<string>\",\n \"attribution_id\": \"<string>\",\n \"recommendation_id\": \"<string>\",\n \"search_result_id\": \"<string>\",\n \"product_listing_result_id\": \"<string>\",\n \"click_location\": \"<string>\",\n \"page_url\": \"<string>\",\n \"recommendation_type\": \"<string>\",\n \"collection_handle\": \"<string>\",\n \"shopify_collection_id\": \"<string>\",\n \"grid_item_id\": 123,\n \"grid_item_link\": \"<string>\",\n \"depict_ab_variant\": \"<string>\"\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.depict.ai/create-events")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "[\n {\n \"tenant\": \"<string>\",\n \"market\": \"<string>\",\n \"deduplication_id\": \"<string>\",\n \"user_id\": \"<string>\",\n \"session_id\": \"<string>\",\n \"dsid\": \"<string>\",\n \"ab_test_group\": \"<string>\",\n \"product_id\": \"<string>\",\n \"variant_ids\": [\n \"<string>\"\n ],\n \"entity_identifiers\": {},\n \"url\": \"<string>\",\n \"entity_price\": \"<string>\",\n \"currency\": \"<string>\",\n \"document_referrer\": \"<string>\",\n \"document_width\": \"<string>\",\n \"attribution_id\": \"<string>\",\n \"recommendation_id\": \"<string>\",\n \"search_result_id\": \"<string>\",\n \"product_listing_result_id\": \"<string>\",\n \"click_location\": \"<string>\",\n \"page_url\": \"<string>\",\n \"recommendation_type\": \"<string>\",\n \"collection_handle\": \"<string>\",\n \"shopify_collection_id\": \"<string>\",\n \"grid_item_id\": 123,\n \"grid_item_link\": \"<string>\",\n \"depict_ab_variant\": \"<string>\"\n }\n]"
response = http.request(request)
puts response.read_body{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Events
Create Events
POST
/
create-events
Create Events
curl --request POST \
--url https://api.depict.ai/create-events \
--header 'Content-Type: application/json' \
--data '
[
{
"tenant": "<string>",
"market": "<string>",
"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>",
"collection_handle": "<string>",
"shopify_collection_id": "<string>",
"grid_item_id": 123,
"grid_item_link": "<string>",
"depict_ab_variant": "<string>"
}
]
'import requests
url = "https://api.depict.ai/create-events"
payload = [
{
"tenant": "<string>",
"market": "<string>",
"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>",
"collection_handle": "<string>",
"shopify_collection_id": "<string>",
"grid_item_id": 123,
"grid_item_link": "<string>",
"depict_ab_variant": "<string>"
}
]
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify([
{
tenant: '<string>',
market: '<string>',
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>',
collection_handle: '<string>',
shopify_collection_id: '<string>',
grid_item_id: 123,
grid_item_link: '<string>',
depict_ab_variant: '<string>'
}
])
};
fetch('https://api.depict.ai/create-events', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.depict.ai/create-events",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
[
'tenant' => '<string>',
'market' => '<string>',
'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>',
'collection_handle' => '<string>',
'shopify_collection_id' => '<string>',
'grid_item_id' => 123,
'grid_item_link' => '<string>',
'depict_ab_variant' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.depict.ai/create-events"
payload := strings.NewReader("[\n {\n \"tenant\": \"<string>\",\n \"market\": \"<string>\",\n \"deduplication_id\": \"<string>\",\n \"user_id\": \"<string>\",\n \"session_id\": \"<string>\",\n \"dsid\": \"<string>\",\n \"ab_test_group\": \"<string>\",\n \"product_id\": \"<string>\",\n \"variant_ids\": [\n \"<string>\"\n ],\n \"entity_identifiers\": {},\n \"url\": \"<string>\",\n \"entity_price\": \"<string>\",\n \"currency\": \"<string>\",\n \"document_referrer\": \"<string>\",\n \"document_width\": \"<string>\",\n \"attribution_id\": \"<string>\",\n \"recommendation_id\": \"<string>\",\n \"search_result_id\": \"<string>\",\n \"product_listing_result_id\": \"<string>\",\n \"click_location\": \"<string>\",\n \"page_url\": \"<string>\",\n \"recommendation_type\": \"<string>\",\n \"collection_handle\": \"<string>\",\n \"shopify_collection_id\": \"<string>\",\n \"grid_item_id\": 123,\n \"grid_item_link\": \"<string>\",\n \"depict_ab_variant\": \"<string>\"\n }\n]")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.depict.ai/create-events")
.header("Content-Type", "application/json")
.body("[\n {\n \"tenant\": \"<string>\",\n \"market\": \"<string>\",\n \"deduplication_id\": \"<string>\",\n \"user_id\": \"<string>\",\n \"session_id\": \"<string>\",\n \"dsid\": \"<string>\",\n \"ab_test_group\": \"<string>\",\n \"product_id\": \"<string>\",\n \"variant_ids\": [\n \"<string>\"\n ],\n \"entity_identifiers\": {},\n \"url\": \"<string>\",\n \"entity_price\": \"<string>\",\n \"currency\": \"<string>\",\n \"document_referrer\": \"<string>\",\n \"document_width\": \"<string>\",\n \"attribution_id\": \"<string>\",\n \"recommendation_id\": \"<string>\",\n \"search_result_id\": \"<string>\",\n \"product_listing_result_id\": \"<string>\",\n \"click_location\": \"<string>\",\n \"page_url\": \"<string>\",\n \"recommendation_type\": \"<string>\",\n \"collection_handle\": \"<string>\",\n \"shopify_collection_id\": \"<string>\",\n \"grid_item_id\": 123,\n \"grid_item_link\": \"<string>\",\n \"depict_ab_variant\": \"<string>\"\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.depict.ai/create-events")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "[\n {\n \"tenant\": \"<string>\",\n \"market\": \"<string>\",\n \"deduplication_id\": \"<string>\",\n \"user_id\": \"<string>\",\n \"session_id\": \"<string>\",\n \"dsid\": \"<string>\",\n \"ab_test_group\": \"<string>\",\n \"product_id\": \"<string>\",\n \"variant_ids\": [\n \"<string>\"\n ],\n \"entity_identifiers\": {},\n \"url\": \"<string>\",\n \"entity_price\": \"<string>\",\n \"currency\": \"<string>\",\n \"document_referrer\": \"<string>\",\n \"document_width\": \"<string>\",\n \"attribution_id\": \"<string>\",\n \"recommendation_id\": \"<string>\",\n \"search_result_id\": \"<string>\",\n \"product_listing_result_id\": \"<string>\",\n \"click_location\": \"<string>\",\n \"page_url\": \"<string>\",\n \"recommendation_type\": \"<string>\",\n \"collection_handle\": \"<string>\",\n \"shopify_collection_id\": \"<string>\",\n \"grid_item_id\": 123,\n \"grid_item_link\": \"<string>\",\n \"depict_ab_variant\": \"<string>\"\n }\n]"
response = http.request(request)
puts response.read_body{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Body
application/json
Available options:
page_view, click, add_to_cart, purchase, element_visible, ws_click, recommendations_inserted, native_shopify_collection_click, native_shopify_collection_view, native_shopify_grid_item_click, shopify_search_item_click, shopify_search_add_to_cart, shopify_search_purchase Minimum string length:
1Show child attributes
Show child attributes
Response
Successful Response
Was this page helpful?

