Skip to main content

Sync


Particular Audience Recommendations use first-party client data combined with product metadata to deliver customers' most tailored product discovery journeys. PA ingests anonymized behavior signals like views, clicks, and purchase events to do so.

PA Sync API ingests all signals to power the Recommendations AI. Sync also provides events required for PA Advanced Analytics. It is important these events are configured and triggered correctly and ingested by the PA Recommendations API.

Sync Event API

API Base URL

Method: POST
Endpoint: /2.7/Sync

Event API Common Request Parameters

Each event API request must include essential parameters, and this section provides a summary of those required parameters.

Base Parameters

NameTypeDescriptionRequirements
cGUIDCustomer IdRequired. The value will be returned from the config API call
sGUIDSession IdRequired. The value will be returned from the config API call
wGUIDWebsite IdRequired. Value can be get from web portal or ask concern person for it.
lStringLanguageRequired. Follow IETF language tag
Example: en-AU
pStringPlatformRequired.
Example: Win32
bnStringBrowser NameRequired.
Example: Chrome
bvStringBrowser VersionRequired.
Example: 119

Event Parameters

NameTypeDescriptionRequirements
EventIdNumberEvent Id.Required. Incremental interger number.
For Example: if first event Id is 1 then next will be two and so on for a
EventStringAvailable Event ListRequired.
Example: SlotImpression
EventVersionStringVersion of the event.Required. Current version is 2.3
Available Event Name & Version
NameVersion
ViewProduct2.3
AddProductToCart2.3
WidgetAreaViewed2.3
SlotImpression2.3
Click2.3
CheckoutCart2.3
Purchase2.3
NameTypeDescriptionRequirements
TacticIdGUIDTactic Id. Id of Tactic which is created on web appRequired, if event occured from custom widget. ID of the tactic associated with the event
CampaignIdGUIDCampaing Id. Id of Campaign which is created on web appRequired, if event occured from custom widget. ID of the campaign associated with the event
RecommendationIdGUIDRecommendation Id. Id of Recommendation which is created on web appRequired, if event occured from custom widget. ID of the recommendation associated with the event
WidgetIdGUIDWidget Id. Id of Widget which is created on web appRequired, if event occured from custom widget. ID of the widget associated with the event
RouteIdGUIDRoute Id. Id of Route which is created on web appRequired, if event occured from custom widget. ID of the route associated with the event

ViewProduct

The ViewProduct event tracks a product view for the unique CustomerID and SessionID. This event is triggered on a product page and is used to analyze anonymized customer browsing behavior for real-time personalization.

Request CURL & Parameters

curl --location 'https://RECS_API_BASE_URL/2.7/Sync' \
--header 'authority: RECS_API_BASE_HOST' \
--header 'content-type: application/json' \
--data '{
    "c": "CUSTOMER_ID",
    "s": "SESSION_ID",
    "w": "WEBSITE_ID",
    "l": "en-US",
    "p": "Win32",
    "bn": "Chrome",
    "bv": "119",
    "e": [
        {
            "EventId": 1,
            "Event": "ViewProduct",
            "EventVersion": "2.3",
            
            "CurrentUrl": "PRODUCT_CURRENT_URL",
            "LocalTimestamp": 1701089433692,

            "RefId": "12337",
            "Name": "qndaarydpx",
            "IsViewedFromWidget": true,
            "ReferralUrl": "https://STORE_URL/qndaarydpx",
            "TacticLabel": "1",
            "SlotClickType": 1

            "TacticId": "TACTIC_ID",
            "CampaignId": "CAMPAIGN_ID",
            "RecommendationId": "RECOMMENDATION_ID",
            "WidgetId": "WIDGET_ID",
            "RouteId": "ROUTE_ID"
        }
    ]
}'

Request CURL & Parameters

NameTypeDescriptionRequirements
Base Parameters Describes here
eObject ArrayEventsRequired. Length >= 1
e[x]
(EventId, Event, EventVersion)
Event Parameters Describes hereRequired.
e[x].CurrentUrlStringURL of the current product.Required. URL of the current page. Valid URL format.
e[x].LocalTimestampNumberTimestampOptional. Local timestamp when the event occured
e[x].RefIdStringProduct ref idRequired.
e[x].NameStringProduct nameOptional.
e[x].IsViewedFromWidgetBooleanTrue/False based on viewed fromRequired. True, if event occured from custom widget
e[x].ReferralUrlStringURL from where the redirection happenOptional. URL of the referring page
e[x].TacticLabelStringTactic Label. Description of tacticOptional. Label associated with the tactic
e[x].SlotClickTypeint(Enum)Type of mouse click.
Supported value.
Widget related Parameter Describes here
Available Slot Click
NameValue
None0
Left1
Middle2
Right3

AddProductToCart

The AddProductToCart event tracks all Add to Cart events on the client's website. The event triggers for each item added to the cart, both for the native ATC button as well as Add To Cart CTAs on Particular Audience Powered widgets, e.g. bundle widgets. AddProcutToCart is used for Advanced Analytics reporting.

Request CURL & Parameters

curl --location 'https://RECS_API_BASE_URL/2.7/Sync' \
--header 'authority: RECS_API_BASE_HOST' \
--header 'content-type: application/json' \
--data '{
    "c": "CUSTOMER_ID",
    "s": "SESSION_ID",
    "w": "WEBSITE_ID",
    "l": "en-US",
    "p": "Win32",
    "bn": "Chrome",
    "bv": "119",
    "e": [
        {
            "EventId": 6,
            "Event": "AddProductToCart",
            "EventVersion": "2.3",
            "CurrentUrl": "PRODUCT_CURRENT_URL",
            "LocalTimestamp": 1701168091653,
            "Product": {
                "RefId": "12337",
                "SKU": "vbgfrt",
                "Name": "qndaarydpx",
                "Url": "PRODUCT_CURRENT_URL",
                "Price": "NZD35.60",
                "Quantity": "1",
                "ReferralUrl": "PRODUCT_REFERRAL_URL",
                "IsAddedFromWidget": true,
                "TacticLabel": "1",
                
                "TacticId": "TACTIC_ID",
                "CampaignId": "CAMPAIGN_ID",
                "RecommendationId": "RECOMMENDATION_ID",
                "WidgetId": "WIDGET_ID",
                "RouteId": "ROUTE_ID"
            }
        }
    ]
}'
NameTypeDescriptionRequirements
Base Parameters Describes here
eObject ArrayEventsRequired. Length >= 1
e[x]
(EventId, Event, EventVersion)
Event Parameters Describes hereRequired.
e[x].CurrentUrlStringURL of the current product.Required. URL of the current page. Valid URL format.
e[x].LocalTimestampNumberTimestampOptional. Local timestamp when the event occured
e[x].Product.RefIdStringProduct ref idRequired.
e[x].Product.SKUStringProduct SKUOptional.
e[x].Product.NameStringProduct nameOptional.
e[x].Product.UrlStringProduct urlRequired.
e[x].Product.PriceNumberProduct priceRequired.
e[x].Product.QuantityNumberAdded quantityRequired.
e[x].ReferralUrlStringURL from where the redirection happensOptional. URL of the referring page
e[x].IsViewedFromWidgetBooleanTrue/False based on viewed from custom widgetRequired. True, if event occured from custom widget
e[x].Product.TacticLabelStringTactic Label. Description of tacticOptional. Label associated with the tactic
Widget related Parameter Describes here

WidgetAreaViewed

WidgetAreaView event tracks a page div where a PA widget is inserted. The purpose of this event is for post-impression AB testing.

Request CURL & Parameters

curl --location 'https://RECS_API_BASE_URL/2.7/Sync' \
--header 'authority: RECS_API_BASE_HOST' \
--header 'content-type: application/json' \
--data '{
    "c": "CUSTOMER_ID",
    "s": "SESSION_ID",
    "w": "WEBSITE_ID",
    "l": "en-US",
    "p": "Win32",
    "bn": "Chrome",
    "bv": "119",
    "e": [
        {
            "CurrentUrl": "PRODUCT_CURRENT_URL",
            "EventId": 15,
            "Event": "WidgetAreaViewed",
            "EventVersion": "2.3",
            "LocalTimestamp": 1701230588621,
            "WidgetId": "WIDGET_ID",
            "RouteId": "ROUTE_ID"
        }
    ]
}'
NameTypeDescriptionRequirements
Base Parameter Describes hereRequired.
eObject ArrayEventsRequired. Length >= 1
e[x]
(EventId, Event, EventVersion)
Event Parameters Describes hereRequired.
e[x].CurrentUrlStringURL of the current product.Required. URL of the current page. Valid URL format.
e[x].LocalTimestampNumberTimestampOptional. Local timestamp when the event occured
e[x].WidgetIdGUIDdetailsRequired.
Ex.: a5c988d8-2b8d-ee11-abf4-06303169103a
e[x].RouteIdGUIDdetailsRequired.
Ex.:006e8f05-8b74-ed11-aaf7-061f6a8be99c

SlotImpression

SlotImpression event tracks the impressions of each product slot in PA-powered product recommendations. SlotImpression only triggers once a user has viewed the slot on the page. Slot impressions are important to track the engagement and performance of PA-powered recommendation slots on a client website. SlotImession is also required for PA Advanced Analytics.

Request CURL & Parameters

curl --location 'https://RECS_API_BASE_URL/2.7/Sync' \
--header 'authority: RECS_API_BASE_HOST' \
--header 'accept: */*' \
--header 'Content-Type: application/json' \
--data '{
    "c": "CUSTOMER_ID",
    "s": "SESSION_ID",
    "w": "WEBSITE_ID",
    "l": "en-US",
    "p": "Win32",
    "bn": "Chrome",
    "bv": "119",
    "e": [
        {
            "CurrentUrl": "https://STORE_URL/qndaarydpx",
            "EventId": 25,
            "Event": "SlotImpression",
            "EventVersion": "2.3",
            "LocalTimestamp": 1701232060546,
            "WidgetId": "WIDGET_ID",
            "RouteId": "ROUTE_ID",
            "Impressions": [
                {
                    "ProductRefId": "12257",
                    "RecommendationId": "RECOMMENDATION_ID",
                    "CampaignId": "CAMPAIGN_ID",
                    "TacticId": "TACTIC_ID"
                },
                {
                    "ProductRefId": "12256",
                    "RecommendationId": "RECOMMENDATION_ID",
                    "CampaignId": "CAMPAIGN_ID",
                    "TacticId": "TACTIC_ID"
                }
            ]
        }
    ]
}'
NameTypeDescriptionRequirements
Base Parameter Describes hereRequired.
eObject ArrayEventsRequired. Length >= 1
e[x]
(EventId, Event, EventVersion)
Event Parameters Describes hereRequired.
e[x].CurrentUrlStringURL of the current product.Required. URL of the current page. Valid URL format.
e[x].LocalTimestampNumberTimestampOptional. Local timestamp when the event occured
e[x].WidgetIdGUIDdetailsRequired.
Ex.: a5c988d8-2b8d-ee11-abf4-06303169103a
e[x].RouteIdGUIDdetailsRequired.
Ex.:006e8f05-8b74-ed11-aaf7-061f6a8be99c
ImpressionsObject ArrayImpressionsRequired. Length >= 1
e[x].Impressions[y].ProductRefIdGUIDProduct Ref IdRequired.
Ex.:006e8f05-8b74-ed11-aaf7-061f6a8be99c
e[x].Impressions[y].RecommendationIdGUIDdetailsRequired.
Ex.: a5c988d8-2b8d-ee11-abf4-06303169103a
e[x].Impressions[y].CampaignIdGUIDdetailsRequired.
Ex.:006e8f05-8b74-ed11-aaf7-061f6a8be99c
e[x].Impressions[y].TacticIdGUIDdetailsRequired.
Ex.: a5c988d8-2b8d-ee11-abf4-06303169103a

Click

The Click event tracks unique clicks on UI powered by the Particular Audience, e.g. recommendations slots, CTA buttons, and sort/filters in search.

Within the Click event, ActionType determines the event being tracked and ContextType relates to the PA-powered widget or slot being clicked. Click events contain important fields used for tracking Retailer Boost Collections and Supplier Retail Media Campaigns. Click events are vital for PA Advanced Analytics.

Request CURL & Parameters

curl --location 'https://RECS_API_BASE_URL/2.7/Sync' \
--header 'authority: RECS_API_BASE_HOST' \
--header 'accept: */*' \
--header 'content-type: application/json' \
--data '{
    "c": "CUSTOMER_ID",
    "s": "SESSION_ID",
    "w": "WEBSITE_ID",
    "l": "en-US",
    "p": "Win32",
    "bn": "Chrome",
    "bv": "119",
    "e": [
        {
            "EventId": 27,
            "Event": "Click",
            "EventVersion": "2.3",

            "CurrentUrl": "PRODUCT_CURRENT_URL",
            "LocalTimestamp": 1701240999463,

            "ClickId": "d3dc4ab1-8ec9-4618-9c27-4844a1f2eab3",
            "ActionType": 1,
            "ContextType": 1,
            
            "ContextId": "5efe6a3c-8a74-ed11-aaf7-061f6a8be99c",
            "ContextData": "RecommendationWidget",
            "ProductRefId": "12257",
            "RedirectUrl": "PRODUCT_CURRENT_URL",
            "ReferralUrl": "PRODUCT_REFERRAL_URL",
            
            "RBCCID": null,
            "SBCID": null,
            "ADSID": null,
            "CPC": null,
            "HMAC": null,
            "HMACSalt": null,
            "TimeStamp": null,
            
            "KeywordId": null,
            "ClickPosition": 1,
            
            "TacticId": "TACTIC_ID",
            "CampaignId": "CAMPAIGN_ID",
            "RecommendationId": "RECOMMENDATION_ID",
            "WidgetId": "WIDGET_ID",
            "RouteId": "ROUTE_ID"
        }
    ]
}'
NameTypeDescriptionRequirements
Base Parameter Describes hereRequired.
eObject ArrayEventsRequired. Length >= 1
e[x]
(EventId, Event, EventVersion)
Event Parameters Describes hereRequired.
e[x].CurrentUrlStringURL of the current product.Required. URL of the current page. Valid URL format.
e[x].LocalTimestampNumberTimestampOptional. Local timestamp when the event occured
e[x].ClickIdGUIDAn id, client side generated GUIDRequired.
Ex.: a5c988d8-2b8d-ee11-abf4-06303169103a
e[x].ActionTypeint (enum)Supported ActionTypeRequired.
Ex.: 1,2 ,etc.
e[x].ContextTypeint (enum)Supported ContextTypeRequired.
Ex.: 1,2 ,etc.
e[x].ContextIdStringClick context IdRequired depending upon the Context Type: Please refer to the table Supported ContextType
e[x].ContextDataStringContext DataRequired depending upon the Context Type: Please refer to the table Supported ContextType
e[x].ProductRefIdStringProduct referent id of the clicked productOptional.
e[x].RedirectUrlStringThe URL that the click will redirect toOptional.
e[x].ReferralUrlStringThe URL that fired clickOptional.
e[x].IsBoostedBoolenIs the click occurred on boosted recommendationOptional. Default is false.
e[x].RBCCIDGUIDRetailer Boost Collection Configuration IDRequired if boosted based on Retailer config.
e[x].SBCIDGUIDSupplier Boost Collection IDRequired if boosted based on Supplier config.
e[x].ADSIDGUIDSupplier Ad Set ID which is created from boosting terminalRequired if boosted based on Supplier Ad Set config.
e[x].ADSVNNumberCorrespond to the current Ad Set Version from boosting terminalRequired if boosted based on Supplier Ad Set config.
e[x].CPCDecimalSlot CPC. Used for calculating and validatiing HMAC fieldRequired if boosted based on Supplier Ad Set config.
Ex.: 0.11
e[x].HMACStringString generated by recommender by combining ADSID, CPC, TimeStamp, HMACSalt and encrypted using secret key that is shared between recommender and ingestion. Guarantees that this click event came from the tracker and prevents attackers from fraud budget decrementingRequired if boosted based on Supplier Ad Set config
Ex.: hBsmdiPnJfZcBwaPlrDSYa5CYkyaNm+2uwVGe2aYpis3CFNCEFcMKEUltKzuMw97xY+r17yml5/FUsDRL9Jfew==
e[x].HMACSaltStringString of 16 random characters generated by recommender. Used for calculating and validating HMAC fieldRequired if boosted based on Supplier Ad Set config
Ex.: sVDvyaLiRaVBWIg2
e[x].TimeStampNumberimestamp generated by recommender. Used for calculating and validatiing HMAC fieldRequired if boosted based on Supplier Ad Set config.
Ex.: 637984945630354000
e[x].KeywordIdGUIDId of Search Keyword EventOptional.
e[x].ClickPositionNumberClick Position’ is the position of the product slot being clicked in a widgetRequired.
e[x].RecommendationIdGUIDdetailsRequired.
Ex.: a5c988d8-2b8d-ee11-abf4-06303169103a
e[x].CampaignIdGUIDdetailsRequired.
Ex.:006e8f05-8b74-ed11-aaf7-061f6a8be99c
e[x].TacticIdGUIDdetailsRequired.
Ex.: a5c988d8-2b8d-ee11-abf4-06303169103a
e[x].WidgetIdGUIDdetailsRequired.
Ex.:006e8f05-8b74-ed11-aaf7-061f6a8be99c
e[x].RouteIdGUIDdetailsRequired.
Ex.: a5c988d8-2b8d-ee11-abf4-06303169103a
Action Types
NameValue
OpenProductPage1
AddProductToCart2
SeeSimilar3
OpenProductListPage4
PopularSearchLink5
QuickLink6
OpenBrandPage7
TextLink8
AddProductToWishlist9
ClickBuyNow10
ClickExternalBuyNow11
ClickPhoneNumber12
ViewInformation13
ClickFilterSort14
ClickDidYouMeanTerm15
CloseModal16
OpenPriceBeatModal17
Context Types
NameValueContextId Required?ContextData Required?
RecommendationWidget1Yes. Value: Id of the WidgetNo.
VisualSearchWidget2Yes. Value: VisualSearchWidget event idNo.
SearchWidget3Yes. Value: TextSearchEventIdYes. Search Term
NativeRecommendationWidget4Yes. Native Widget IdNo.
ExitIntentWidget5No.No.
PersonalizeWidget6No.No.
PersonaliseBrandWidget7No.No.
BundleWidget8No.No.
PriceBeatWidget9No.No.
KeywordTargetingWidget10No.No.
NativeButton11No.No.

CheckoutCart

CheckoutCart event tracks the customer checkout, capturing all items in a basket. This event is used for analyzing customer browsing and buying behavior and is also used for PA Advanced Analytics.

CheckoutCart triggers every time a customer reaches the Cart or Checkout page, depending on the conversion funnel configuration. Each time the event triggers, the cart contents will be reconsidered.

Request CURL & Parameters

curl --location 'https://RECS_API_BASE_URL/2.7/Sync' \
--header 'authority: RECS_API_BASE_HOST' \
--header 'accept: */*' \
--header 'content-type: application/json' \
--data '{
    "c": "CUSTOMER_ID",
    "s": "SESSION_ID",
    "w": "WEBSITE_ID",
    "l": "en-US",
    "p": "Win32",
    "bn": "Chrome",
    "bv": "119",
    "e": [
        {
            "EventId": 29,
            "Event": "CheckoutCart",
            "EventVersion": "2.3",
            "CurrentUrl": "https://STORE_URL/checkout",
            "LocalTimestamp": 1701256954008,

            "SubTotal": "NZD49.90",
            "TotalPrice": "NZD89.20",
            "Discount": "",
            "DeliveryFee": "",
            "PromotionCodes": [],
            "PriceBeatPromotionCodes": [],

            "Products": [
                {
                    "RefId": "12257",
                    "Name": "qndaarydpx",
                    "Quantity": "2",
                    "SKU": "OISD1243",
                    "Price": "NZD39.3",
                    "Url": "https://STORE_URL/qndaarydpx"
                },
                {
                    "RefId": "16394",
                    "Name": "qndaarydpx",
                    "Quantity": "1",
                    "SKU": "HBASB123",
                    "Price": "NZD10.6",
                    "Url": "https://STORE_URL/qndaarydpx"
                }
            ]
        }
    ]
}'
NameTypeDescriptionRequirements
Base Parameter Describes hereRequired.
eObject ArrayEventsRequired. Length >= 1
e[x]
(EventId, Event, EventVersion)
Event Parameters Describes hereRequired.
e[x].CurrentUrlStringURL of the current product.Required. URL of the current page. Valid URL format.
e[x].LocalTimestampNumberTimestampOptional. Local timestamp when the event occured
e[x].SubTotalStringSubtotal calculated from price of productRequired.
Must include number and currency.
e[x].TotalPriceStringTotal price in checkout pageRequired.
Must include number and currency.
e[x].DiscountStringDiscount infoOptional.
e[x].DeliveryFeeStringDelivery feeOptional.
e[x].PromotionCodesArrayApplied promotional codesOptional.
e[x].PriceBeatPromotionCodesArrayArray of Code & ValueRequired, if added from Price Beat
ProductsObject ArrayProductsRequired. Length >= 1
e[x].Products[y].RefIdStringId of productRequired.
e[x].Products[y].NameStringName of productOptional.
e[x].Products[y].SKUStringSKU of productOptional.
e[x].Products[y].PriceStringUnit price of the productRequired. Number and currency symbol
e[x].Products[y].UrlStringURL of the product pageRequired.

Purchase

Purchase event tracks the customer transactions, including all items being purchased. This event is used in analyzing customer purchase behavior and is also required for Advanced Analytics.

Purchase event triggers on the confirmation page of a website, upon the successful completion of a transaction.

Request CURL & Parameters

curl --location 'https://RECS_API_BASE_URL/2.7/Sync' \
--header 'authority: RECS_API_BASE_HOST' \
--header 'accept: */*' \
--header 'content-type: application/json' \
--data '{
    "c": "CUSTOMER_ID",
    "s": "SESSION_ID",
    "w": "WEBSITE_ID",
    "bn": "Chrome",
    "bv": "119",
    "l": "en-US",
    "p": "Win32",
    "e": [
        {
            "CurrentUrl": "PURCHASE_SUCCESSFULL_URL",
            "EventId": 30,
            "Event": "Purchase",
            "EventVersion": "2.3",
            "LocalTimestamp": 1701256737141,

            "OrderId": "WEB23031610081598",
            "PaymentMethod": null,
            "CurrencyCode": "",

            "Products": [
                {
                    "RefId": "16394",
                    "Name": "qndaarydpx",
                    "Quantity": "1",
                    "SKU": "HBASB123",
                    "Price": "NZD10.6",
                    "Url": "https://STORE_URL/qndaarydpx"
                    "Subtotal": "NZD10.6",
                    "Quantity": "1"
                }
            ]
            
        }
    ]
}'
NameTypeDescriptionRequirements
Base Parameter Describes hereRequired.
eObject ArrayEventsRequired. Length >= 1
e[x]
(EventId, Event, EventVersion)
Event Parameters Describes hereRequired.
e[x].CurrentUrlStringURL of the current product.Required. URL of the current page. Valid URL format.
e[x].LocalTimestampNumberTimestampOptional. Local timestamp when the event occured
e[x].OrderIdStringId of orderRequired.
e[x].PaymentMethodStringPayment method used in the purchaseOptional.
Ex.: 'Paypal'.
e[x].CurrencyCodeStringCurrency code when a customer made a purchaseRequired.
Ex.: 'USD'.
e[x].PriceBeatPromotionCodesArrayArray of Code & ValueRequired, if added from Price Beat
ProductsObject ArrayProductsRequired. Length >= 1
e[x].Products[y].RefIdStringId of productRequired.
e[x].Products[y].NameStringName of productOptional.
e[x].Products[y].SKUStringSKU of productOptional.
e[x].Products[y].PriceStringUnit price of the productOptional. Number and currency symbol
e[x].Products[y].UrlStringURL of the product pageRequired.
e[x].Products[y].SubtotalStringSubtotal of the orderRequired. Number and currency symbol
e[x].Products[y].QuantityStringUnit purchaseRequired.

SearchTerm

The SearchTerm event which is used for Particular Audience ATS Tracking. When a user apply any search in the store this event will trigger and capture the relevant information.

Request CURL & Parameters

curl --location 'https://RECS_API_BASE_URL/2.7/Sync' \
--header 'authority: RECS_API_BASE_HOST' \
--header 'accept: */*' \
--header 'content-type: application/json' \
--data '{
    "c": "CUSTOMER_ID",
    "s": "SESSION_ID",
    "w": "WEBSITE_ID",
    "l": "en-US",
    "p": "Win32",
    "bn": "Chrome",
    "bv": "119",
    "e": [
        {
            "EventId": 13,
            "Event": "SearchTerm",
            "EventVersion": "2.3",

            "CurrentUrl": "https://www.digidirect.com.au/",
            "LocalTimestamp": 1701325753928,

            "SearchTerm": "water",
            "NumberOfResults": 7

            "TacticId": "TACTIC_ID",
            "CampaignId": "CAMPAIGN_ID",
            "RecommendationId": "RECOMMENDATION_ID",
            "WidgetId": "WIDGET_ID",
            "RouteId": "ROUTE_ID"
            
        }
    ]
}'
NameTypeDescriptionRequirements
Base Parameter Describes hereRequired.
eObject ArrayEventsRequired. Length >= 1
e[x]
(EventId, Event, EventVersion)
Event Parameters Describes hereRequired.
e[x].CurrentUrlStringURL of the current product.Required. URL of the current page. Valid URL format.
e[x].LocalTimestampNumberTimestampOptional. Local timestamp when the event occured
e[x].SearchTermStringSearch text a user usedRequired. Is always the user SearchTerm which returned the search results
e[x].NumberOfResultsNumberA count of search resultRequired. Number of results returned from search API for this specific request
e[x].RecommendationIdGUIDdetailsRequired.
Ex.: a5c988d8-2b8d-ee11-abf4-06303169103a
e[x].CampaignIdGUIDdetailsRequired.
Ex.:006e8f05-8b74-ed11-aaf7-061f6a8be99c
e[x].TacticIdGUIDdetailsRequired.
Ex.: a5c988d8-2b8d-ee11-abf4-06303169103a
e[x].WidgetIdGUIDdetailsRequired.
Ex.:006e8f05-8b74-ed11-aaf7-061f6a8be99c
e[x].RouteIdGUIDdetailsRequired.
Ex.: a5c988d8-2b8d-ee11-abf4-06303169103a

SearchKeyword

SearchKeyword event is used for Retail Media Ad Sets. This event is triggered on search query and used to identify relevant Keyword Targeting Ad Sets. This event is different to the SearchTerm event which is used for Particular Audience ATS Tracking.

Request CURL & Parameters

curl --location 'https://RECS_API_BASE_URL/2.7/Sync' \
--header 'authority: RECS_API_BASE_HOST' \
--header 'accept: */*' \
--header 'content-type: application/json' \
--data '{
    "c": "CUSTOMER_ID",
    "s": "SESSION_ID",
    "w": "WEBSITE_ID",
    "l": "en-US",
    "p": "Win32",
    "bn": "Chrome",
    "bv": "119",
    "e": [
        {
            "EventId": 13,
            "Event": "SearchTerm",
            "EventVersion": "2.3",

            "CurrentUrl": "https://www.digidirect.com.au/",
            "LocalTimestamp": 1701325753928,

            "SearchTerm": "water",
            "NumberOfResults": 7

            "id": "c433a936-83cd-4b3d-aec6-7dd90e7230ea",
            "keyword": "water",
            "previousUrl": "https://www.digidirect.com.au/"
            
        }
    ]
}'
NameTypeDescriptionRequirements
Base Parameter Describes hereRequired.
eObject ArrayEventsRequired. Length >= 1
e[x]
(EventId, Event, EventVersion)
Event Parameters Describes hereRequired.
e[x].CurrentUrlStringURL of the current product.Required. URL of the current page. Valid URL format.
e[x].LocalTimestampNumberTimestampOptional. Local timestamp when the event occured

| e[x].Id | GUID | An id to identify the search keyword event, client side generated GUID | Required. | | e[x].Keyword | String | The keyword that a user has typed before an interaction on the widget | Required. | | e[x].PreviousUrl | String | The Url before the redirect | Required. |