From de5c131e254c27662ad3a400f538f35873b8f218 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marek=20Noco=C5=84?= Date: Thu, 14 May 2026 16:59:06 +0200 Subject: [PATCH 1/2] Added Raptor doc --- .../config/packages/ibexa_connector_raptor.yaml | 4 ++++ .../connector_installation_configuration.md | 5 +++-- .../raptor_integration/raptor_connector_guide.md | 2 ++ .../raptor_integration/recommendation_blocks.md | 2 ++ docs/recommendations/raptor_integration/tracking_php_api.md | 1 + .../recommendations_twig_functions.md | 6 ++++++ 6 files changed, 18 insertions(+), 2 deletions(-) diff --git a/code_samples/recommendations/config/packages/ibexa_connector_raptor.yaml b/code_samples/recommendations/config/packages/ibexa_connector_raptor.yaml index 61c90252b1..18ad640c12 100644 --- a/code_samples/recommendations/config/packages/ibexa_connector_raptor.yaml +++ b/code_samples/recommendations/config/packages/ibexa_connector_raptor.yaml @@ -11,6 +11,10 @@ ibexa: # Raptor Recommendations API URL, optional, set by default recommendations_api_url: '%ibexa.connector.raptor.recommendations.api_url%' + + # Cookie lifetime in days for server-side tracking identifier + # Default: 365 days. Minimum: 1 day. + cookie_id_lifetime_days: 365 ibexa_connector_raptor: # When enabled, tracking exceptions are thrown instead of being silently handled strict_exceptions: true diff --git a/docs/recommendations/raptor_integration/connector_installation_configuration.md b/docs/recommendations/raptor_integration/connector_installation_configuration.md index dfc2645400..dcb0e9c578 100644 --- a/docs/recommendations/raptor_integration/connector_installation_configuration.md +++ b/docs/recommendations/raptor_integration/connector_installation_configuration.md @@ -26,7 +26,7 @@ composer require ibexa/connector-raptor To configure the Raptor connector, use the `ibexa.system..connector_raptor` configuration key in the `config/packages/ibexa_connector_raptor.yaml` file: ``` yaml -[[= include_file('code_samples/recommendations/config/packages/ibexa_connector_raptor.yaml', 0, 13) =]] +[[= include_file('code_samples/recommendations/config/packages/ibexa_connector_raptor.yaml', 0, 17) =]] ``` - `enabled` - enables or disables the connector for a given scope. Default value: `true`. If set to `false`, no tracking or recommendation requests are executed. @@ -36,6 +36,7 @@ To configure the Raptor connector, use the `ibexa.system..connector_rapto - `server` - tracking is handled on the backend, with events sent directly to the tracking API. It's not affected by ad blockers. - `recommendations_api_key` - an API key used to authenticate requests to the Recommendations API. This key allows the connector to retrieve personalized recommendations from the recommendation engine. You can find this value as ["API key"](connector_installation_configuration.md#recommendations-api-key) in Raptor Control Panel. - `recommendations_api_url` (optional) - overrides the default Raptor address, do not set it unless a custom endpoint is required. +- `cookie_id_lifetime_days` (optional) - the lifetime in days of the server-side tracking identifier cookies. Default value: `365` days. Minimum value: `1` day. By default, `tracking_type` is set to `client` as client-side tracking is the standard Raptor mode. To understand the differences between client and server tracking types, including their advantages and disadvantages, refer to the [Raptor documentation](https://content.raptorservices.com/help-center/client-side-vs.-server-side-tracking). @@ -73,6 +74,6 @@ The following settings are global and apply to the entire application (they are This value can be overridden in `config/packages/ibexa_connector_raptor.yaml` file, for example: -``` yaml hl_lines="14-17" +``` yaml hl_lines="18-20" [[= include_file('code_samples/recommendations/config/packages/ibexa_connector_raptor.yaml') =]] ``` diff --git a/docs/recommendations/raptor_integration/raptor_connector_guide.md b/docs/recommendations/raptor_integration/raptor_connector_guide.md index f1c225778b..6a9e1fbb0d 100644 --- a/docs/recommendations/raptor_integration/raptor_connector_guide.md +++ b/docs/recommendations/raptor_integration/raptor_connector_guide.md @@ -68,7 +68,9 @@ Recommendation blocks are organized into dedicated categories, each grouping blo - [Most popular content]([[= user_doc =]]/recommendations/raptor_integration/raptor_recommendation_blocks/#most-popular-content-block) - [Other customers have also seen this content]([[= user_doc =]]/recommendations/raptor_integration/raptor_recommendation_blocks/#other-customers-have-also-seen-this-content-block) - [Personalized content recommendations]([[= user_doc =]]/recommendations/raptor_integration/raptor_recommendation_blocks/#personalized-content-recommendations-block) + - [User’s content history]([[= user_doc =]]/recommendations/raptor_integration/raptor_recommendation_blocks/#users-content-history-block) - **Recommendations: Product** - displays product suggestions based on visitors’ browsing history: + - [Items associated with the given Content]([[= user_doc =]]/recommendations/raptor_integration/raptor_recommendation_blocks/#items-associated-with-the-given-content-block) - [Most popular products]([[= user_doc =]]/recommendations/raptor_integration/raptor_recommendation_blocks/#most-popular-products-block) - [Most popular products in category]([[= user_doc =]]/recommendations/raptor_integration/raptor_recommendation_blocks/#most-popular-products-in-category-block) - [Other customers have also seen]([[= user_doc =]]/recommendations/raptor_integration/raptor_recommendation_blocks/#other-customers-have-also-seen-block) diff --git a/docs/recommendations/raptor_integration/recommendation_blocks.md b/docs/recommendations/raptor_integration/recommendation_blocks.md index 0cefb19b66..f17519b912 100644 --- a/docs/recommendations/raptor_integration/recommendation_blocks.md +++ b/docs/recommendations/raptor_integration/recommendation_blocks.md @@ -23,7 +23,9 @@ In the toolbar, corresponding categories for recommendation blocks are available - [Most popular content]([[= user_doc =]]/recommendations/raptor_integration/raptor_recommendation_blocks/#most-popular-content-block) - [Other customers have also seen this content]([[= user_doc =]]/recommendations/raptor_integration/raptor_recommendation_blocks/#other-customers-have-also-seen-this-content-block) - [Personalized content recommendations]([[= user_doc =]]/recommendations/raptor_integration/raptor_recommendation_blocks/#personalized-content-recommendations-block) + - [User’s content history]([[= user_doc =]]/recommendations/raptor_integration/raptor_recommendation_blocks/#users-content-history-block) - **Recommendations: Product** - displays product suggestions based on visitors’ browsing history: + - [Items associated with the given Content]([[= user_doc =]]/recommendations/raptor_integration/raptor_recommendation_blocks/#items-associated-with-the-given-content-block) - [Most popular products]([[= user_doc =]]/recommendations/raptor_integration/raptor_recommendation_blocks/#most-popular-products-block) - [Most popular products in category]([[= user_doc =]]/recommendations/raptor_integration/raptor_recommendation_blocks/#most-popular-products-in-category-block) - [Other customers have also seen]([[= user_doc =]]/recommendations/raptor_integration/raptor_recommendation_blocks/#other-customers-have-also-seen-block) diff --git a/docs/recommendations/raptor_integration/tracking_php_api.md b/docs/recommendations/raptor_integration/tracking_php_api.md index 6bc71c778a..e845a288a1 100644 --- a/docs/recommendations/raptor_integration/tracking_php_api.md +++ b/docs/recommendations/raptor_integration/tracking_php_api.md @@ -28,6 +28,7 @@ For more information, see the same arguments of the Twig function [`ibexa_tracki | `EventType::BUY` | `ProductInterface` | `EventContext::SUBTOTAL`,
`EventContext::CURRENCY`,
`EventContext::QUANTITY`,
(optional) `EventContext::CATEGORY_IDENTIFIER`,
(optional) `EventContext::WEBSITE_ID` | | `EventType::BASKET` | `ProductInterface` | `EventContext::BASKET_CONTENT`,
`EventContext::BASKET_ID`,
(optional) `EventContext::CATEGORY_IDENTIFIER`,
(optional) `EventContext::QUANTITY`,
(optional) `EventContext::WEBSITE_ID` | | `EventType::ITEM_CLICK` | `string` (product code) | `EventContext::MODULE_NAME`,
`EventContext::REDIRECT_URL` | +| `EventType::PAGEVIEW` | `string` (URL) | `EventContext::URL` (required),
(optional) `EventContext::WEBSITE_ID` | Check the following example: diff --git a/docs/templating/twig_function_reference/recommendations_twig_functions.md b/docs/templating/twig_function_reference/recommendations_twig_functions.md index 9e586b2b3d..2f4fab83bd 100644 --- a/docs/templating/twig_function_reference/recommendations_twig_functions.md +++ b/docs/templating/twig_function_reference/recommendations_twig_functions.md @@ -78,6 +78,12 @@ ibexa_tracking_track_event( The following events are supported and can be triggered from Twig templates: +### `pageview` event + +The `ibexa_tracking_script()` Twig function automatically sends a [`pageview`](https://content.raptorservices.com/help-center/tracking-events-parameters-reference#:~:text=Event%20Specifications%20%28Full%20Reference) event to Raptor for every incoming GET request, in both `client` and `server` tracking types. + +Use it for for basic page metrics and debugging the Live Tracking Stream. + ### Product `visit` event This event tracks product page visits by users. From a389d9e2a4e6433a274727f6f5573f32a30226be Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marek=20Noco=C5=84?= Date: Thu, 14 May 2026 17:23:01 +0200 Subject: [PATCH 2/2] Vale --- .../twig_function_reference/recommendations_twig_functions.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/templating/twig_function_reference/recommendations_twig_functions.md b/docs/templating/twig_function_reference/recommendations_twig_functions.md index 2f4fab83bd..da1a9cb6e5 100644 --- a/docs/templating/twig_function_reference/recommendations_twig_functions.md +++ b/docs/templating/twig_function_reference/recommendations_twig_functions.md @@ -82,7 +82,7 @@ The following events are supported and can be triggered from Twig templates: The `ibexa_tracking_script()` Twig function automatically sends a [`pageview`](https://content.raptorservices.com/help-center/tracking-events-parameters-reference#:~:text=Event%20Specifications%20%28Full%20Reference) event to Raptor for every incoming GET request, in both `client` and `server` tracking types. -Use it for for basic page metrics and debugging the Live Tracking Stream. +Use it for basic page metrics and debugging the Live Tracking Stream. ### Product `visit` event