The developer guides show you how to use the public APIs, developer tools, and other developer features of the Frosmo Platform. These allow you to go beyond the Frosmo Control Panel when developing your Frosmo-enabled site, and to create your own client applications for interacting with the platform.
Contents
APIs for interacting with the platform:
- Getting your site origin shows you how to find out the origin of a site.
- Graniitti API provides access to the data in the Frosmo back end. You can use the API to retrieve, create, update, and delete data for your company.
- Visitor API allows you to retrieve visitor affinity data from the Frosmo back end.
Connectors for optionally integrating with the platform:
- React Connector allows you to integrate your React application with the Frosmo Platform, after which you can manage the display rules and content for your components from the Frosmo Control Panel.
Data tracking solutions for your site:
- Frosmo data layer is a global JavaScript array that allows you to send data from a web page to the Frosmo back end. Use the data layer to collect product and visitor data from a site.
- Tracking products with the data layer shows you how to collect product data from a site and count the number of views different products receive from visitors.
- Tracking transactions with the data layer shows you how to monitor visitors for actions that qualify as transactions and collect data about those actions.
- Tracking conversions with the data layer shows you how to monitor visitors for actions that qualify as conversions and collect data about those actions.
- Tracking cart actions with the data layer shows you how to monitor visitors for shopping cart actions and collect data about those actions.
- Tracking item list views with the data layer shows you how to monitor visitors for actions that qualify as item list views and collect data about those actions.
- Tracking custom actions with the data layer shows you how to monitor visitors for actions and state changes that qualify as custom actions, and collect data about those actions and state changes.
- Tracking custom events with advanced tracking shows you how to extend the basic tracking functionality of the platform by tracking modifications beyond clicks, displays, and true displays.
Recommendations and related solutions for your site:
- Recommendation strategies allow you to define the logic and settings for generating recommendation data.
- Recommendation configurations allow you to define the logic and settings for generating recommendation data. Configurations are a legacy solution replaced by strategies.
- Recommendations API allows you to retrieve recommendation data and visitor affinity profiles from the Frosmo back end.
- Product API allows you to retrieve product data from the Frosmo back end.
- Recommendation examples show you how to create recommendations from scratch.
Search & Smart Discovery solutions for your site:
- Search API allows you to use Frosmo Search to run search queries and retrieve the search results.
- Smart Discovery API allows you to retrieve Smart Discovery data generated for a site.
- Shared code for writing JavaScript that is automatically executed on every page load or when triggered.
Version history
Version | Publication date | Description |
---|---|---|
20.3 | 2023-06-02 | Removed Graniitti API changelog. |
20.2 | 2023-05-29 | Updated the following Smart Discovery documentation: |
20.1 | 2023-05-15 | Obsoleted Graniitti API changelog. |
20.0 | 2023-05-15 | Added Search & Smart Discovery and Smart Discovery API. Updated Graniitti API: Resources. |
19.3 | 2023-05-09 | Updated the following documentation to conform to changes introduced in maintenance release 2023-05-09:
Updated Graniitti API changelog for API version 0.199.0. |
19.2 | 2023-05-02 | Updated Graniitti API changelog for API version 0.196.0. |
19.1 | 2023-04-17 | Updated Example: Recommending trending products in a category (strategy). |
19.0 | 2023-04-12 | Added the following data tracking documentation: Updated the following data tracking documentation: |
18.0 | 2023-03-06 | Added Search API. Updated Tracking products with the data layer. Updated the recommendations guide: |
17.6 | 2022-12-20 | Updated the following documentation to conform to changes introduced in maintenance release 2022-12-12:
Updated the following documentation to conform to changes introduced in maintenance release 2022-12-15: |
17.5 | 2022-12-12 | Updated Graniitti API changelog for API version 0.168.1. |
17.4 | 2022-12-08 | Updated Recommendation configuration reference. Updated Graniitti API changelog for API version 0.167.0. |
17.3 | 2022-11-29 | Updated the recommendations guide: Updated Graniitti API changelog for API version 0.165.0. |
17.2 | 2022-11-07 | Updated Graniitti API changelog for API version 0.157.0. |
17.1 | 2022-11-02 | Updated Graniitti API changelog for API version 0.156.0. |
17.0 | 2022-10-31 | Updated the documentation for the Frosmo Control Panel navigation redesign. |
16.3 | 2022-10-06 | Updated Graniitti API changelog for API version 0.145.0. |
16.2 | 2022-09-20 | |
16.1 | 2022-09-05 | Updated Graniitti API changelog for API version 0.140.0. |
16.0 | 2022-06-14 | Added Visitor API reference (affinity groups). Updated the following documentation to reflect the addition of affinity groups: |
15.12 | 2022-06-14 | Updated Graniitti API changelog for API version 0.134.1. |
15.11 | 2022-06-07 | Updated Creating and editing shared code. |
15.10 | 2022-05-04 | Updated the recommendations guide: |
15.9 | 2022-04-29 | Removed all documentation about target groups. |
15.8 | 2022-04-28 | Updated Example: Creating personalized content in React. |
15.7 | 2022-04-21 | Updated the following documentation to conform to the API changes introduced by maintenance release 2022-04-21: |
15.6 | 2022-04-19 | Updated the following documentation to conform to the UI changes introduced by maintenance release 2022-04-19: Updated Graniitti API changelog for API version 0.120.0. |
15.5 | 2022-04-07 | Updated Recommendations API reference (strategies). |
15.4 | 2022-03-24 | Updated Example: Creating personalized content in React. Updated Recommendation configuration reference. Updated Graniitti API changelog for API version 0.116.0. |
15.3 | 2022-03-18 | |
15.2 | 2022-03-16 | Updated Graniitti API changelog for API version 0.114.0. |
15.1 | 2022-03-10 | Removed Recommendations API reference (affinity profiles). |
15.0 | 2022-03-07 | Added Visitor API. Updated Recommendations API reference (affinity profiles). |
14.15 | 2022-03-01 | Updated Graniitti API changelog for API version 0.108.0. |
14.14 | 2022-02-08 | Updated Recommendations API reference (configurations). |
14.13 | 2022-02-04 | Combined the API requests and responses pages into a single page by API and use case:
|
14.12 | 2022-02-04 | Added the following API documentation:
|
14.11 | 2022-01-24 | |
14.10 | 2022-01-18 | Updated Tracking products with the data layer. Update the following API documentation:
|
14.9 | 2022-01-03 | Updated Tracking products with the data layer. |
14.8 | 2021-12-07 | Update the following API documentation:
|
14.7 | 2021-11-30 | Updated the data tracking documentation: |
14.6 | 2021-11-09 | Updated Graniitti API changelog for API versions 0.83.0 and 0.83.1. |
14.5 | 2021-11-04 | Updated the recommendations guide:
|
14.4 | 2021-10-11 | Updated Graniitti API: Responses. |
14.3 | 2021-09-20 | Updated Creating and editing shared code. |
14.2 | 2021-09-06 | Updated Graniitti API changelog for API version 0.75.0. |
14.1 | 2021-08-27 | Updated Recommendations API: Requests (strategies). |
14.0 | 2021-08-17 | Moved feature introductions to Platform & Features, and restructured the guides to reflect the move. |
13.0 | 2021-07-12 | Restructured and updated the data tracking guide to reflect similar updates elsewhere in the documentation portal. |
12.1 | 2021-07-06 | Updated the recommendations guide:
|
12.0 | 2021-07-01 | Added the following documentation to the recommendations guide:
Updated the following documentation in the recommendations guide:
|
11.5 | 2021-06-30 | Updated Tracking products with the data layer. Updated Product API: Responses. |
11.4 | 2021-05-31 | Updated Recommendation configuration reference. Updated Graniitti API changelog for API version 0.69.3. |
11.3 | 2021-05-26 | Site maintenance updates. |
11.2 | 2021-05-03 | Updated Managing Graniitti API results. Updated Graniitti API changelog for API version 0.67.0. |
11.1 | 2021-04-12 | Updated Graniitti API changelog for API version 0.66.0. |
11.0 | 2021-03-18 | Removed FProxy. |
10.0 | 2021-03-08 | Updated the recommendations guide:
Updated Graniitti API changelog for API version 0.64.0. |
9.4 | 2021-03-01 | Updated Graniitti API changelog for API version 0.63.0. |
9.3 | 2021-02-10 | Updated Graniitti API changelog for API version 0.61.0. |
9.2 | 2021-01-13 | Updated Graniitti API changelog for API version 0.59.0. |
9.1 | 2020-12-07 | Updated Graniitti API: Resources. Updated Tracking transactions with the data layer. Updated Graniitti API changelog for API version 0.57.0. |
9.0 | 2020-11-05 | Consolidated and updated the recommendations documentation into the recommendations developer guide. |
8.3 | 2020-11-02 | Restructured the following API documentation: |
8.2 | 2020-09-21 | Updated Graniitti API and recommendations. Updated Tracking products with the data layer. Updated Graniitti API changelog for API version 0.55.0. |
8.1 | 2020-09-09 | Updated Graniitti API changelog for API version 0.54.0. |
8.0 | 2020-07-31 | Added the following data tracking documentation:
Restructured and updated the data layer guide to align with the new data tracking documentation: |
7.9 | 2020-07-06 | Updated Graniitti API changelog for API version 0.53.0. |
7.8 | 2020-06-22 | Updated Graniitti API changelog for API version 0.52.4. |
7.7 | 2020-06-15 | Updated Graniitti API changelog for API version 0.52.1. |
7.6 | 2020-05-25 | Updated the Graniitti API guide: Updated Graniitti API changelog for API version 0.49.0. |
7.5 | 2020-05-05 | Updated the shared code guide: |
7.4 | 2020-04-27 | Updated Graniitti API changelog for API version 0.48.0. |
7.3 | 2020-04-21 | Updated the FProxy guide:
|
7.2 | 2020-04-14 | Updated Graniitti API changelog for API version 0.46.3. |
7.1 | 2020-04-01 | Removed Frosmo Debugger. The tool continues its life as Frosmo Preview. Updated the FProxy guide to reference Frosmo Preview:
|
7.0 | 2020-03-31 | Added Shared code. |
6.17 | 2020-03-16 | Updated Graniitti API changelog for API version 0.46.0. |
6.16 | 2020-03-02 | Updated Graniitti API changelog for API version 0.45.2. Removed entries for Frosmo-internal releases from Graniitti API changelog. |
6.15 | 2020-02-18 | Updated Graniitti API changelog for API version 0.45.1. |
6.14 | 2020-02-17 | Updated Graniitti API changelog for API version 0.45.0. |
6.13 | 2020-02-07 | Updated Graniitti API changelog for API version 0.44.10. |
6.12 | 2020-01-27 | Updated Graniitti API changelog for API version 0.44.8. |
6.11 | 2019-12-09 | Updated Graniitti API changelog for API version 0.44.5. |
6.10 | 2019-12-03 | Updated Graniitti API changelog for API version 0.44.4. |
6.9 | 2019-11-26 | Updated Graniitti API changelog for API version 0.44.3. |
6.8 | 2019-11-20 | Updated modification-related documentation to conform to the new modification UI introduced in the Happy Valley release. |
6.7 | 2019-11-15 | Updated Graniitti API changelog for API version 0.44.1. |
6.6 | 2019-11-08 | Updated Graniitti API changelog for API version 0.43.21. |
6.5 | 2019-11-01 | Updated Graniitti API changelog for API version 0.43.20. |
6.4 | 2019-10-25 | Updated Graniitti API changelog for API version 0.43.19. |
6.3 | 2019-10-11 | Updated Graniitti API changelog for API version 0.43.18. |
6.2 | 2019-10-04 | Updated Graniitti API changelog for API version 0.43.17. |
6.1 | 2019-09-20 | Updated Graniitti API changelog for API version 0.43.16. |
6.0 | 2019-09-16 | Added the React Connector guide. |
5.19 | 2019-09-11 | Updated Graniitti API changelog for API version 0.43.15. |
5.18 | 2019-09-06 | Updated Graniitti API changelog for API version 0.43.14. |
5.17 | 2019-09-04 | Updated the FProxy guide:
|
5.16 | 2019-08-29 | Updated the recommendations documentation:
Updated Graniitti API changelog for API version 0.43.13. |
5.15 | 2019-07-31 | Updated Graniitti API changelog for API version 0.43.12. |
5.14 | 2019-06-28 | Updated Graniitti API changelog for API version 0.43.10. |
5.13 | 2019-06-14 | Updated Graniitti API changelog for API version 0.43.8. |
5.12 | 2019-06-03 | Updated Graniitti API changelog for API version 0.43.5. |
5.11 | 2019-05-17 | Updated Graniitti API changelog for API version 0.43.2. |
5.10 | 2019-05-06 | Moved the Recommendations guide to User Guides. |
5.9 | 2019-05-02 | Updated Graniitti API changelog for API version 0.43.0. |
5.8 | 2019-04-05 | Updated the recommendations documentation for Recommendations API v2:
Updated Collecting data with the data layer. Updated Graniitti API changelog for API version 0.42.3. |
5.7 | 2019-03-11 | Updated the FProxy guide:
|
5.6 | 2019-03-08 | Restructured and updated the data layer guide:
Updated Graniitti API changelog for API version 0.42.2. |
5.5 | 2019-01-31 | Updated the recommendations documentation:
Updated the following API documentation:
|
5.4 | 2019-01-18 | Added Example: Recommending products purchased together (configuration). |
5.3 | 2019-01-11 | Updated Graniitti API changelog for API version 0.42.1. |
5.2 | 2019-01-09 | Site maintenance updates. |
5.1 | 2018-12-10 | Updated the Graniitti API guide: |
5.0 | 2018-12-03 | Added the following documentation on the Frosmo Recommendations system:
|
4.0 | 2018-12-02 | Restructured and consolidated the documentation for better usability by grouping the guides under the following new main topics:
|
3.5 | 2018-11-28 | Updated Graniitti API changelog for API versions 0.41.5 and 0.42.0. |
3.4 | 2018-10-15 | Updated Graniitti API changelog for API version 0.41.4. |
3.3 | 2018-10-01 | Updated Frosmo data layer. Updated the Graniitti API guide:
|
3.2 | 2018-09-13 | Updated Tracking custom events with advanced tracking. Removed the Downloads page and the standalone PDFs. |
3.1 | 2018-09-05 | Updated Graniitti API changelog for API versions 0.41.1 and 0.41.2. |
3.0 | 2018-09-03 | Added FProxy. Added Frosmo Debugger. Added Graniitti API. |
2.0 | 2018-03-14 | Added Tracking custom events with advanced tracking. |
1.2 | 2017-11-29 | Updated Frosmo data layer. |
1.1 | 2017-10-23 | Moved the standalone PDFs from the front page to the Downloads page. |
1.0 | 2017-08-17 | First public version of this documentation. |