القائمة

كل مجموعات الواجهة

Events

Clicks and shopper events. Public key.

نقطتا وصول. أسماء نقاط الوصول وأوصافها مأخوذة من ملف OpenAPI، لذلك تظهر بالإنجليزية.

POST /v1/click
POST /v1/event

POST/v1/click

Record a click on a search result

يحتاج إلى مفتاح أو جلسة في لوحة التحكم

جسم الطلب `application/json` `ClickRequest`

الاسم	النوع	إلزامي	الوصف
`search_id`	`string`	نعم	max length 40
`product_id`	`string`	نعم	max length 128
`position`	`integer`	نعم	min 1 · max 1000
`session`	`string \| null`	لا	max length 64

الردود

202Successful ResponseEventAccepted

POST/v1/event

Record one event or a batch (add_to_cart, order, view, fallback...)

يحتاج إلى مفتاح أو جلسة في لوحة التحكم

جسم الطلب `application/json` `EventIn | EventBatch`

الردود

202Successful ResponseEventAccepted

أشكال البيانات في هذه الصفحة

ClickRequest

الاسم	النوع	إلزامي	الوصف
`search_id`	`string`	نعم	max length 40
`product_id`	`string`	نعم	max length 128
`position`	`integer`	نعم	min 1 · max 1000
`session`	`string \| null`	لا	max length 64

EventAccepted

الاسم	النوع	إلزامي	الوصف
`accepted`	`integer`	نعم
`duplicates`	`integer`	لا	default 0

EventIn

الاسم	النوع	إلزامي	الوصف
`type`	`"click" \| "add_to_cart" \| "order" \| "view" \| "fallback" \| "assistant_click" \| "assistant_handover"`	نعم
`product_id`	`string \| null`	لا	max length 128
`search_id`	`string \| null`	لا	max length 40
`position`	`integer \| null`	لا	min 1 · max 1000
`session`	`string \| null`	لا	max length 64
`value`	`number \| string \| null`	لا	Order or cart value.min 0
`currency`	`string \| null`	لا	pattern ^[A-Z]{3}$
`quantity`	`integer \| null`	لا	min 1
`device`	`"desktop" \| "mobile" \| "tablet" \| "unknown"`	لا	default "unknown"
`occurred_at`	`string (date-time) \| null`	لا
`id`	`string \| null`	لا	Client event id; duplicates are dropped.max length 200
`meta`	`map<string, string \| integer \| number \| boolean>`	لا

EventBatch

الاسم	النوع	إلزامي	الوصف
`events`	`EventIn[]`	نعم