# Froomle Guides

> Current Froomle documentation · [Full documentation index](https://docs.froomle.com/llms.txt)

Integration workflow, event tracking, recommendation requests, identity, and manual integrations.

- [A/B Testing and Benchmarking](https://docs.froomle.com/froomle-doc-main/v2/guide/topics/ab-testing-benchmarking.md) ([HTML](https://docs.froomle.com/froomle-doc-main/v2/guide/topics/ab-testing-benchmarking.html)) — Benchmarking compares recommendation strategies while keeping assignment and attribution consistent. Use Froomle-managed assignment when Froomle owns the split, or customer-managed…
- [Account Setup](https://docs.froomle.com/froomle-doc-main/v2/guide/account-setup.md) ([HTML](https://docs.froomle.com/froomle-doc-main/v2/guide/account-setup.html)) — This step establishes environments, request routing, and credentials for APIs that require authentication. It should be completed before any data or recommendation requests are…
- [Audience recommendations](https://docs.froomle.com/froomle-doc-main/v2/guide/topics/audience-recommendations.md) ([HTML](https://docs.froomle.com/froomle-doc-main/v2/guide/topics/audience-recommendations.html)) — Audience selection returns users ranked for a campaign. Use offset and limit to page through results. The same retrieval can be done in batches for large audiences.
- [Authentication Flow](https://docs.froomle.com/froomle-doc-main/v2/guide/topics/authentication-flow.md) ([HTML](https://docs.froomle.com/froomle-doc-main/v2/guide/topics/authentication-flow.html)) — Froomle APIs documented as authenticated use OAuth 2.0 Bearer tokens for machine-to-machine authentication. This page defines the public authentication contract for manual and…
- [Batch/newsletter recommendations](https://docs.froomle.com/froomle-doc-main/v2/guide/topics/batch-requests.md) ([HTML](https://docs.froomle.com/froomle-doc-main/v2/guide/topics/batch-requests.html)) — Batch recommendations allow you to request personalized content for thousands of users at once via a file-based interface. This is ideal for outbound channels like newsletters, or…
- [Concepts](https://docs.froomle.com/froomle-doc-main/v2/guide/topics/index.md) ([HTML](https://docs.froomle.com/froomle-doc-main/v2/guide/topics/index.html)) — This section explains the product models and contracts shared by every Froomle integration method. Use it to understand what the integration means; use Integration to choose how to…
- [Continue Reading](https://docs.froomle.com/froomle-doc-main/v2/guide/topics/modules/continue-reading.md) ([HTML](https://docs.froomle.com/froomle-doc-main/v2/guide/topics/modules/continue-reading.html)) — A module showing the articles that the user is most likely to click on given the current article being read.
- [Custom Domain (CNAME)](https://docs.froomle.com/froomle-doc-main/v2/guide/topics/custom-domain-cname.md) ([HTML](https://docs.froomle.com/froomle-doc-main/v2/guide/topics/custom-domain-cname.html)) — Use this guide when you want Froomle traffic to run on your own subdomain, for example froomle.yourdomain.com, instead of the default europe-west1.froomle.com.
- [Editor’s Pick](https://docs.froomle.com/froomle-doc-main/v2/guide/topics/modules/editor-s-pick.md) ([HTML](https://docs.froomle.com/froomle-doc-main/v2/guide/topics/modules/editor-s-pick.html)) — A module proposing relevant content previously curated by the editorial team. In this case, the module will apply it’s personalisation not to the entire catalogue, but select from…
- [Event Model and Tracking Contract](https://docs.froomle.com/froomle-doc-main/v2/guide/topics/tracking-events.md) ([HTML](https://docs.froomle.com/froomle-doc-main/v2/guide/topics/tracking-events.html)) — Events describe how users interact with your content and recommendations. They train our AI models, power your analytics dashboards, and enable accurate KPI attribution.
- [Filters and Constraints](https://docs.froomle.com/froomle-doc-main/v2/guide/topics/filters-and-constraints.md) ([HTML](https://docs.froomle.com/froomle-doc-main/v2/guide/topics/filters-and-constraints.html)) — Filters and constraints allow you to control exactly which items from your catalog are eligible for a recommendation. In the Froomle platform, filtering is a collaborative process…
- [Getting Recommendations](https://docs.froomle.com/froomle-doc-main/v2/guide/getting-recommendations.md) ([HTML](https://docs.froomle.com/froomle-doc-main/v2/guide/getting-recommendations.html)) — Froomle offers multiple modes for delivering personalization, ranging from real-time website modules to scheduled newsletter exports. Choosing the right delivery mode ensures that…
- [Getting Started](https://docs.froomle.com/froomle-doc-main/v2/guide/index.md) ([HTML](https://docs.froomle.com/froomle-doc-main/v2/guide/index.html)) — This start guide gives you a clean, end-to-end overview of the Froomle integration. Each step links to a dedicated sub-page with the full detail, so you can move in order or jump…
- [Goal Setting](https://docs.froomle.com/froomle-doc-main/v2/guide/goal-setting.md) ([HTML](https://docs.froomle.com/froomle-doc-main/v2/guide/goal-setting.html)) — Goal setting aligns what the integration should achieve and where recommendations will appear. This step is done together with your Froomle account team so the technical work maps…
- [Integration](https://docs.froomle.com/froomle-doc-main/v2/guide/integration/index.md) ([HTML](https://docs.froomle.com/froomle-doc-main/v2/guide/integration/index.html)) — Complete the shared setup first, then choose how your application will track events and request recommendations.
- [Item Catalog](https://docs.froomle.com/froomle-doc-main/v2/guide/item-sync.md) ([HTML](https://docs.froomle.com/froomle-doc-main/v2/guide/item-sync.html)) — A comprehensive and regularly updated item catalog is the foundation of Froomle’s recommendation engine. On top of knowing which items to recommend, Froomle uses item metadata for…
- [Item Synchronization](https://docs.froomle.com/froomle-doc-main/v2/guide/topics/item-sync-options.md) ([HTML](https://docs.froomle.com/froomle-doc-main/v2/guide/topics/item-sync-options.html)) — Item synchronization is shared setup for every Froomle integration and is not provided by the frontend SDK. Complete it before choosing how to implement event tracking and…
- [Manual / Custom Integration](https://docs.froomle.com/froomle-doc-main/v2/guide/manual-integration/index.md) ([HTML](https://docs.froomle.com/froomle-doc-main/v2/guide/manual-integration/index.html)) — Use this method when you send events or request recommendations without relying on the frontend SDK to own the integration flow. It covers direct APIs, backend and mobile…
- [Manual Event Integration](https://docs.froomle.com/froomle-doc-main/v2/guide/manual-integration/events.md) ([HTML](https://docs.froomle.com/froomle-doc-main/v2/guide/manual-integration/events.html)) — Use this guide when your application sends Froomle events without the frontend SDK owning event delivery. The integration may run in a backend, mobile application, custom browser…
- [Manual Recommendation Integration](https://docs.froomle.com/froomle-doc-main/v2/guide/manual-integration/recommendations.md) ([HTML](https://docs.froomle.com/froomle-doc-main/v2/guide/manual-integration/recommendations.html)) — Use this guide when your application requests and renders recommendations without the frontend SDK owning the request and rendering flow. This is the primary method for backend,…
- [Modules and Placements](https://docs.froomle.com/froomle-doc-main/v2/guide/topics/modules-and-placements.md) ([HTML](https://docs.froomle.com/froomle-doc-main/v2/guide/topics/modules-and-placements.html)) — Modules are the core building blocks of a Froomle integration. A module represents one distinct placement in a channel and page type, such as a "Continue Reading" box on an article…
- [Monitoring Performance and Quality Assurance](https://docs.froomle.com/froomle-doc-main/v2/guide/monitoring-qa.md) ([HTML](https://docs.froomle.com/froomle-doc-main/v2/guide/monitoring-qa.html)) — This step confirms that recommendations are accurate, events are flowing, and quality is stable before and after go-live.
- [News Modules](https://docs.froomle.com/froomle-doc-main/v2/guide/topics/modules/index.md) ([HTML](https://docs.froomle.com/froomle-doc-main/v2/guide/topics/modules/index.html)) — This section documents the default news recommendation modules. Each module page lists where it can be used, its KPI focus, and any required request parameters.
- [Operations](https://docs.froomle.com/froomle-doc-main/v2/guide/operations/index.md) ([HTML](https://docs.froomle.com/froomle-doc-main/v2/guide/operations/index.html)) — Use these guides to deploy, validate, monitor, and protect a production Froomle integration.
- [Performance & Metrics](https://docs.froomle.com/froomle-doc-main/v2/guide/topics/performance-metrics.md) ([HTML](https://docs.froomle.com/froomle-doc-main/v2/guide/topics/performance-metrics.html)) — Froomle provides detailed metrics to help you understand the performance of your recommendations and the behavior of your users.
- [QA & Monitoring](https://docs.froomle.com/froomle-doc-main/v2/guide/topics/qa-monitoring.md) ([HTML](https://docs.froomle.com/froomle-doc-main/v2/guide/topics/qa-monitoring.html)) — Monitoring keeps your integration healthy and makes performance visible. Froomle provides dashboards and metrics to validate data quality and measure impact.
- [Recent from (Topic)](https://docs.froomle.com/froomle-doc-main/v2/guide/topics/modules/recent-from-topic.md) ([HTML](https://docs.froomle.com/froomle-doc-main/v2/guide/topics/modules/recent-from-topic.html)) — A module containing recent articles from a given section/tag/category, ordered based on relevance for the user.
- [Recommendation Request Model](https://docs.froomle.com/froomle-doc-main/v2/guide/topics/recommendation-requests.md) ([HTML](https://docs.froomle.com/froomle-doc-main/v2/guide/topics/recommendation-requests.html)) — The Froomle engine generates one or more sets of recommendations for every request you send. By providing context about the user and their current environment, you allow our…
- [Recommended for you](https://docs.froomle.com/froomle-doc-main/v2/guide/topics/modules/recommended-for-you.md) ([HTML](https://docs.froomle.com/froomle-doc-main/v2/guide/topics/modules/recommended-for-you.html)) — A module containing the most relevant articles for a user based on what we know about him/her.
- [Regional Recommendations](https://docs.froomle.com/froomle-doc-main/v2/guide/topics/modules/regional-recommendations.md) ([HTML](https://docs.froomle.com/froomle-doc-main/v2/guide/topics/modules/regional-recommendations.html)) — A module containing the most relevant regional articles for a user based on profile and/or reading history.
- [Resilience and Fallbacks](https://docs.froomle.com/froomle-doc-main/v2/guide/topics/resilience-and-fallbacks.md) ([HTML](https://docs.froomle.com/froomle-doc-main/v2/guide/topics/resilience-and-fallbacks.html)) — Froomle is a managed service hosted on the internet, subject to the same availability constraints as any online system. Your website must remain functional and performant even when…
- [Search API](https://docs.froomle.com/froomle-doc-main/v2/guide/topics/search-api.md) ([HTML](https://docs.froomle.com/froomle-doc-main/v2/guide/topics/search-api.html)) — The Search API supports search results and query completions in channels where search is part of the experience.
- [Similar Articles](https://docs.froomle.com/froomle-doc-main/v2/guide/topics/modules/similar-articles.md) ([HTML](https://docs.froomle.com/froomle-doc-main/v2/guide/topics/modules/similar-articles.html)) — A module containing articles from the same section/category/tag as the article the user is browsing, optimized to show the articles with highest engagement on top.
- [Smart Sorting & Reranking](https://docs.froomle.com/froomle-doc-main/v2/guide/topics/smart-sorting-reranking.md) ([HTML](https://docs.froomle.com/froomle-doc-main/v2/guide/topics/smart-sorting-reranking.html)) — Instead of relying solely on Froomle’s algorithms to generate recommendations from scratch, you can supply your own candidate items and let Froomle rank them using its…
- [Trending](https://docs.froomle.com/froomle-doc-main/v2/guide/topics/modules/trending.md) ([HTML](https://docs.froomle.com/froomle-doc-main/v2/guide/topics/modules/trending.html)) — A module highlighting items that are currently gaining momentum. It surfaces content with a sudden rise in engagement over a short time window.
- [Use Froomle documentation with AI](https://docs.froomle.com/froomle-doc-main/v2/guide/use-docs-with-ai.md) ([HTML](https://docs.froomle.com/froomle-doc-main/v2/guide/use-docs-with-ai.html)) — Each page of the current Froomle documentation is also available as Markdown, so you can read or share it with an AI assistant. The documentation home and every other supported…
- [User Identity and Consent](https://docs.froomle.com/froomle-doc-main/v2/guide/topics/user-identity-consent.md) ([HTML](https://docs.froomle.com/froomle-doc-main/v2/guide/topics/user-identity-consent.html)) — User identity is the "red thread" that connects individual interactions into a cohesive journey. By consistently identifying users across sessions and devices, Froomle can discover…
- [User interactions](https://docs.froomle.com/froomle-doc-main/v2/guide/user-interactions.md) ([HTML](https://docs.froomle.com/froomle-doc-main/v2/guide/user-interactions.html)) — This step connects Froomle with user interaction data, letting the recommendation engine learn from behavioral and engagement data. Examples of user interactions that lead to an…
- [Users API](https://docs.froomle.com/froomle-doc-main/v2/guide/topics/users-api.md) ([HTML](https://docs.froomle.com/froomle-doc-main/v2/guide/topics/users-api.html)) — The Users API exposes user‑level records used for personalization and analytics.
- [You May Have Missed](https://docs.froomle.com/froomle-doc-main/v2/guide/topics/modules/you-may-have-missed.md) ([HTML](https://docs.froomle.com/froomle-doc-main/v2/guide/topics/modules/you-may-have-missed.html)) — A module containing selected relevant & unread articles for a user from a selected timeframe.