`user_survey` Shopper survey

The shopper rated the recommendation (1 to 4) and may have left a short comment.

When to send it

Shopper app, when the survey is sent.

Sent only after the shopper gave analytics consent; dropped, never queued, before it.
Kept 25 months.
Needs a non-null tracking_id: without one the event is rejected.

Required fields

Field	Type	Rules
`client_id`	`integer`	greater than 0
`event`	`"user_survey"`
`tracking_id`	`string`	a UUID
`timestamp_ms`	`integer`
`product_id`	`string`	1–255 characters
`rating`	`integer`	at least 1; at most 4

Optional fields

Field	Type	Rules
`event_id`	`string`	1–255 characters
`schema_version`	`1`
`user_agent`	`string`	at most 2048 characters
`shop_country`	`string \| null`	at most 8 characters; may be null
`channel`	`string \| null`	at most 64 characters; may be null
`instance_id`	`string`	1–255 characters
`brand_id`	`integer \| null`	greater than 0; may be null
`product_associated`	`boolean`
`ab_data`	`object`
`testEvent`	`true`
`extra`	`object`
`reco_id`	`string \| null`	1–255 characters; may be null
`feedback`	`string \| null`	at most 1000 characters; may be null
`size`	`string \| null`	1–64 characters; may be null
`physical_infos`	`object`
`references`	`array of object`	at most 10 items
`references[].brand_id`	`integer \| string`	greater than 0; 1–64 characters
`references[].brand_type_id`	`integer \| string`	greater than 0; 1–64 characters
`references[].size_name`	`string`	1–64 characters
`references[].size_system`	`string \| null`	1–16 characters; may be null

Example

Test values only. This example passes the event's schema.

{
  "event": "user_survey",
  "client_id": 1000,
  "tracking_id": "3f0b8c2e-4d5a-4b6c-8d7e-9f0a1b2c3d4e",
  "timestamp_ms": 1792000000000,
  "product_id": "TEST-JACKET-01",
  "rating": 4,
  "feedback": "Fits well.",
  "size": "M"
}

Checks and messages

What Tracking debug in your back office checks for this event, with its exact message. An error means the event is not counted; a warning means it is counted but something is likely wrong; an info is a hint.

Level	Check	Message
error	`invalid_field`	what is wrong with the field
error	`over_limit`	the field is over the limit of <limit>
error	`product_id_missing`	missing product_id
error	`tracking_id_missing`	missing tracking_id: the event is rejected. Send the visitor id (fmt_device_id) with every event.
warning	`product_unknown`	product not found in your catalogue or has no size chart
warning	`size_not_in_product`	size "<value>" is not one of the product's sizes
warning	`timestamp_missing`	timestamp_ms is missing or not a time in milliseconds: the time the event was received is used
warning	`timestamp_out_of_range`	timestamp_ms is more than 30 days old or more than 3 days ahead: the time the event was received is used
info	`size_lower_case`	size "<value>" was sent in lower case. Use uppercase letters or numbers.

JSON schema

The schema the API checks this event against: user_survey.schema.json.

user_survey Shopper survey