When using our API, you might notice that some data fields have different names compared to what you see in our dashboard or reports.
To make integration and troubleshooting easier, this article lists all current mappings between the frontend dimensions and their corresponding API fields.
Dimensions | API_mapping |
Calendar Date | createdAt |
UTM Source | optionalIdentifiers.utmSource |
UTM Medium | optionalIdentifiers.utmMedium |
UTM Campaign | optionalIdentifiers.utmCampaign |
UTM Term | optionalIdentifiers.utmTerm |
UTM Content | optionalIdentifiers.utmContent |
Product Title | lineItems.productName |
Product Title & Variant | lineItems.productName & lineItems.productVariantName |
Product Title (at Checkout) | lineItems.productName |
Product Variant | lineItems.productVariantName |
Product Type | lineItems.productCollection |
Product SKU | lineItems.sku |
Product Tag | lineItems.productTags |
Shipping Country | shipping.countryCodeIso2Letter |
Shipping Type | shipping.providerDescriptor |
Discount Code | lineItems.discounts.voucherType |
Payment Method | paymentMethodName |
Product ID | lineItems.productId |
Sales Channel Name | optionalIdentifiers.orderChannelName |
Order Tags | tags |
Payment Gateway | paymentGatewayName |
Item Vendor | lineItems.productBrand |
Discount Title | lineItems.discounts.voucherType |
Variant ID | lineItems.productVariantId |
Order ID | id |
Customer Tags | customer.tags |
UTM Source / medium | optionalIdentifiers.utmSource & optionalIdentifiers.utmMedium |
Financial Status | financialStatus |
Order Name | orderName |