Documentation
Feedback
Guides
API Reference

Guides
Guides

Exporting ads events

Export raw advertising event data including impressions, clicks, views, and conversions for detailed analysis.

Event data export enables systematic and periodic integration of raw advertising events for detailed analysis and custom reporting.

Integration connection

See more about the connection in Exporting data from VTEX Ads.

Integration format

  • Data sent is always D-1 (previous day).
  • Files are in Parquet format with Snappy compression.
  • Files are always sent in a daily path format: TYPE_REPORT/YYYY/MM/DD/TIMESTAMP_NS/RANDOM_FILE_NAMES.snappy.parquet (one or more files may be sent).

Event deduplication

All events are guaranteed to be sent, but there is no guarantee that an event will be sent only once. Therefore, events must always be deduplicated.

Event data

Impressions

AttributeTypeDescription
event_idStringUnique event identifier (deduplication key)
session_idStringUnique user session identifier
user_idStringUnique user identifier
ad_idStringAdvertisement identifier
campaign_idStringUnique campaign identifier
request_idStringUnique ad query request identifier
ad_typeStringType of advertisement that generated the event
placement_nameStringName of the placement where the ad was displayed
contextStringContext in which the ad was displayed
created_atTimestamp UTCTimestamp of when the event occurred
siteStringSite brand identifier

Views

AttributeTypeDescription
event_idStringUnique event identifier (deduplication key)
session_idStringUnique user session identifier
user_idStringUnique user identifier
ad_idStringAdvertisement identifier
campaign_idStringUnique campaign identifier
request_idStringUnique ad query request identifier
ad_typeStringType of advertisement that generated the event
placement_nameStringName of the placement where the ad was displayed
contextStringContext in which the ad was displayed
created_atTimestamp UTCTimestamp of when the event occurred
siteStringSite brand identifier

Clicks

AttributeTypeDescription
event_idStringUnique event identifier (deduplication key)
session_idStringUnique user session identifier
user_idStringUnique user identifier
ad_idStringAdvertisement identifier
campaign_idStringUnique campaign identifier
request_idStringUnique ad query request identifier
ad_typeStringType of advertisement that generated the event
placement_nameStringName of the placement where the ad was displayed
contextStringContext in which the ad was displayed
created_atTimestamp UTCTimestamp of when the event occurred
siteStringSite brand identifier

Conversions

AttributeTypeDescription
event_idStringUnique conversion event identifier
session_idStringUnique user session identifier
user_idStringUnique user identifier
order_idStringUnique retail order identifier (deduplication key)
channelStringChannel identifier
placed_atTimestamp UTCOrder timestamp
siteStringSite brand identifier

Conversion items

AttributeTypeDescription
event_idStringUnique identifier of the event that generated the conversion (view or click)
session_idStringUnique user session identifier
user_idStringUnique user identifier
order_idStringUnique retail order identifier (deduplication key)
product_skuStringProduct identifier (deduplication key)
ad_idStringUnique advertisement identifier
campaign_idStringUnique campaign identifier
request_idStringUnique ad query request identifier
ad_sizeStringSize of the media used in the advertisement
ad_typeStringType of advertisement that generated the conversion
placement_nameStringName of the placement where the ad was displayed
contextStringContext in which the ad was displayed
event_created_atTimestampTimestamp of when the event occurred
priceFloatProduct price (regular)
promotional_priceFloatProduct promotional price
quantityIntQuantity of items sold
total_valueFloatTotal item value (quantity * min(price, promotional_price))
Contributors
1
Photo of the contributor
Was this helpful?
Yes
No
Suggest Edits (GitHub)
Contributors
1
Photo of the contributor
Was this helpful?
Suggest edits (GitHub)
On this page