Skip to main content

API Fields

Complete reference of all available fields in the Trace API.

Core fields

FieldTypeDescription
app_idstringYour edrone App ID (required)
action_typestringEvent type (required) - see Action Types
sender_typestringserver for backend requests
versionstringIntegration version
platformstringPlatform identifier (e.g., custom)
platform_versionstringYour platform version

User fields

FieldTypeDescription
emailstringUser email address
user_idstringYour platform's user ID
first_namestringUser first name
last_namestringUser last name
phonestringPhone number (with country code)
countrystringCountry code (e.g., US, PL)
citystringCity name
subscriber_statusstring1 = subscribed, 0 = unsubscribed
sms_subscriber_statusstringSMS subscription status
customer_tagsstringCustom tags (| separated)

Product fields

FieldTypeDescription
product_idsstringProduct IDs (| separated for multiple)
product_skusstringProduct SKUs (| separated)
product_titlesstringProduct names (| separated, URL-encoded)
product_imagesstringImage URLs (| separated, URL-encoded)
product_urlsstringProduct URLs (| separated, URL-encoded)
product_availabilitystring1 = in stock, 0 = out of stock
product_countsstringQuantities (| separated)

Category fields

FieldTypeDescription
product_category_idsstringCategory IDs (hierarchy: ~, products: |)
product_category_namesstringCategory names (hierarchy: ~, products: |)

Order fields

FieldTypeDescription
order_idstringUnique order identifier
base_currencystringYour store's currency (e.g., USD)
order_currencystringOrder currency
base_payment_valuestringOrder value in base currency
order_payment_valuestringOrder value in order currency

Timing fields

FieldTypeDescription
event_utc_datestringEvent date (YYYY-MM-DD HH:MM:SS UTC)
utc_timestringCurrent UTC time

Separators

CharacterPurposeExample
|Separate multiple products123|456|789
~Separate category hierarchy1~2~3 (parentchildgrandchild)

Example: Multiple products

product_ids=123|456|789
product_titles=Product%20A|Product%20B|Product%20C
product_counts=1|2|1
product_category_ids=1~2~3|1~2~4|1~5~6
product_category_names=Cat~Sub~Item|Cat~Sub~Other|Cat~Diff~Thing

URL encoding

Fields containing special characters must be URL-encoded:

OriginalEncoded
Nike Air MaxNike%20Air%20Max
Women's ShoesWomen%27s%20Shoes
https://store.com/p?id=1https%3A%2F%2Fstore.com%2Fp%3Fid%3D1
// JavaScript
_edrone.product_titles = encodeURIComponent("Women's Summer Dress");