Pages

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from this space and version 16.2

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 Frosmo Platformplatform.

Contents

  • APIs for interacting with the Frosmo Platformplatform:

    • 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 Frosmo Platformplatform:

    • 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 conversions allows you to monitor visitors for actions that qualify as conversions and collect data about those actions.Tracking custom actions allows you 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 allows you to extend the basic tracking functionality of the Frosmo Platform by tracking modifications beyond clicks, displays, and true displays.
    • Tracking products allows you to collect product data from a site and count the number of views different products receive from visitors.
    • conversions with the data layer shows you how to monitor visitors for actions that qualify as conversions 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, Tracking transactions allows you to monitor visitors for actions that qualify as transactions 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 are 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 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.
  • Shared code for writing JavaScript that is automatically executed on every page load or when triggered.

Version history

VersionPublication dateDescription
16.22022-09-20

Updated Tracking products with the data layer.

Updated Recommendation configuration reference.

16.12022-09-05Updated the Graniitti API changelog for API version 0.140.0.
16.02022-06-14

Added Visitor API reference (affinity groups).

Updated the following documentation to reflect the addition of affinity groups:

15.122022-06-14Updated the Graniitti API changelog for API version 0.134.1.
15.112022-06-07Updated Creating and editing shared code.
15.102022-05-04

Updated the recommendations guide:

15.92022-04-29Removed all documentation about target groups.
15.82022-04-28Updated Example: Creating personalized content in React.
15.72022-04-21

Updated the following documentation to conform to the API changes introduced by maintenance release 2022-04-21:

15.62022-04-19

Updated the following documentation to conform to the UI changes introduced by maintenance release 2022-04-19:

Updated the Graniitti API changelog for API version 0.120.0.

15.52022-04-07Updated Recommendations API reference (strategies).
15.42022-03-24

Updated Example: Creating personalized content in React.

Updated Recommendation configuration reference.

Updated the Graniitti API changelog for API version 0.116.0.

15.32022-03-18

Updated Enabling and disabling the data layer.

Updated Tracking custom events with advanced tracking.

15.22022-03-16Updated the Graniitti API changelog for API version 0.114.0.
15.12022-03-10Removed Recommendations API reference (affinity profiles).
15.02022-03-07

Added Visitor API.

Updated Recommendations API reference (affinity profiles).

14.152022-03-01Updated the Graniitti API changelog for API version 0.108.0.
14.142022-02-08Updated Recommendations API reference (configurations).
14.132022-02-04

Combined the API requests and responses pages into a single page by API and use case:

14.122022-02-04

Added the following API documentation:

  • Recommendations API: Requests (affinity profiles)
  • Recommendations API: Responses (affinity profiles)
14.112022-01-24

Updated Tracking products with the data layer.

Updated Recommendation configuration reference.

14.102022-01-18

Updated Tracking products with the data layer.

Update the following API documentation:

  • Recommendations API: Requests (strategies)
  • Recommendations API: Responses (strategies)
  • Product API: Requests
  • Product API: Responses
14.92022-01-03Updated Tracking products with the data layer.
14.82021-12-07

Update the following API documentation:

  • Recommendations API: Requests (strategies)
  • Recommendations API: Requests (configurations)
  • Product API: Requests
14.72021-11-30

Updated the data tracking documentation:

14.62021-11-09Updated the Graniitti API changelog for API versions 0.83.0 and 0.83.1.
14.52021-11-04

Updated the recommendations guide:

14.42021-10-11

Updated Graniitti API: Responses.

Updated Recommendation configuration reference.

14.32021-09-20Updated Creating and editing shared code.
14.22021-09-06Updated the Graniitti API changelog for API version 0.75.0.
14.12021-08-27Updated Recommendations API: Requests (strategies).
14.02021-08-17Moved feature introductions to Platform & Features, and restructured the guides to reflect the move.
13.02021-07-12Restructured and updated the data tracking guide to reflect similar updates elsewhere in the documentation portal.
12.12021-07-06

Updated the recommendations guide:

12.02021-07-01

Added the following documentation to the recommendations guide:

  • Recommendations API: Requests (strategies)
  • Recommendations API: Responses (strategies)

Updated the following documentation in the recommendations guide:

VersionPublication dateDescription
11.52021-06-30

Updated Tracking products with the data layer.

Updated Product API: Responses.

11.42021-05-31

Updated Recommendation configuration reference.

Updated the Graniitti API changelog for API version 0.69.3.

11.32021-05-26Site maintenance updates.
11.22021-05-03

Updated Managing Graniitti API results.

Updated the Graniitti API changelog for API version 0.67.0.

11.12021-04-12Updated the Graniitti API changelog for API version 0.66.0.
11.02021-03-18Removed FProxy.
10.02021-03-08

Updated the recommendations guide:

Updated the Graniitti API changelog for API version 0.64.0.

9.42021-03-01Updated the Graniitti API changelog for API version 0.63.0.
9.32021-02-10Updated the Graniitti API changelog for API version 0.61.0.
9.22021-01-13Updated the Graniitti API changelog for API version 0.59.0.
9.12020-12-07

Updated Graniitti API: Resources.

Updated Tracking transactions with the data layer.

Updated the Graniitti API changelog for API version 0.57.0.

9.02020-11-05Consolidated and updated the recommendations documentation into the recommendations developer guide.
8.32020-11-02

Restructured the following API documentation:

8.22020-09-21

Updated Graniitti API and recommendations.

Updated Tracking products with the data layer.

Updated the Graniitti API changelog for API version 0.55.0.

8.12020-09-09Updated the Graniitti API changelog for API version 0.54.0.
8.02020-07-31

Added the following data tracking topicsdocumentation:

Restructured and updated the data layer guide to align with the new data tracking topicsdocumentation:

7.92020-07-06Updated the Graniitti API changelog for API version 0.53.0.
7.82020-06-22Updated the Graniitti API changelog for API version 0.52.4.
7.72020-06-15Updated the Graniitti API changelog for API version 0.52.1.
7.62020-05-25

Updated the Graniitti API guide:

Updated the Graniitti API changelog for API version 0.49.0.

7.52020-05-05

Updated the shared code guide:

7.42020-04-27Updated the Graniitti API changelog for API version 0.48.0.
7.32020-04-21

Updated the FProxy guide:

  • Starting and stopping the FProxy server
  • Developing modification content with FProxy
  • FProxy CLI commands and parameters
7.22020-04-14Updated the Graniitti API changelog for API version 0.46.3.
7.12020-04-01

Removed Frosmo Debugger. The tool continues its life as Frosmo Preview.

Updated the FProxy guide to reference Frosmo Preview:

  • Introduction to modification development
  • Starting and stopping the FProxy server
  • Developing modification content with FProxy
  • Example: Creating a simple site banner with FProxy
  • Troubleshooting FProxy
7.02020-03-31Added Shared code.
6.172020-03-16Updated the Graniitti API changelog for API version 0.46.0.
6.162020-03-02

Updated the Graniitti API changelog for API version 0.45.2.

Removed entries for Frosmo-internal releases from the Graniitti API changelog.

6.152020-02-18Updated the Graniitti API changelog for API version 0.45.1.
6.142020-02-17Updated the Graniitti API changelog for API version 0.45.0.
6.132020-02-07Updated the Graniitti API changelog for API version 0.44.10.
6.122020-01-27Updated the Graniitti API changelog for API version 0.44.8.
6.112019-12-09Updated the Graniitti API changelog for API version 0.44.5.
6.102019-12-03Updated the Graniitti API changelog for API version 0.44.4.
6.92019-11-26Updated the Graniitti API changelog for API version 0.44.3.
6.82019-11-20Updated modification-related documentation to conform to the new modification UI introduced in the Happy Valley release.
6.72019-11-15Updated the Graniitti API changelog for API version 0.44.1.
6.62019-11-08Updated the Graniitti API changelog for API version 0.43.21.
6.52019-11-01Updated the Graniitti API changelog for API version 0.43.20.
6.42019-10-25Updated the Graniitti API changelog for API version 0.43.19.
6.32019-10-11Updated the Graniitti API changelog for API version 0.43.18.
6.22019-10-04Updated the Graniitti API changelog for API version 0.43.17.
6.12019-09-20Updated the Graniitti API changelog for API version 0.43.16.
6.02019-09-16Added the React Connector guide.
5.192019-09-11Updated the Graniitti API changelog for API version 0.43.15.
5.182019-09-06Updated the Graniitti API changelog for API version 0.43.14.
5.172019-09-04

Updated the FProxy guide:

  • FProxy
  • Configuring FProxy
5.162019-08-29

Updated the recommendations documentation:

  • Graniitti API and recommendations
  • Recommendations API v2

Updated the Graniitti API changelog for API version 0.43.13.

5.152019-07-31Updated the Graniitti API changelog for API version 0.43.12.
5.142019-06-28Updated the Graniitti API changelog for API version 0.43.10.
5.132019-06-14Updated the Graniitti API changelog for API version 0.43.8.
5.122019-06-03Updated the Graniitti API changelog for API version 0.43.5.
5.112019-05-17Updated the Graniitti API changelog for API version 0.43.2.
5.102019-05-06Moved the Recommendations guide to User Guides.
5.92019-05-02Updated the Graniitti API changelog for API version 0.43.0.
5.82019-04-05

Updated the recommendations documentation for Recommendations API v2:

  • Recommendations API
  • Recommendations API v2
  • Migrating to a new Recommendations API version
  • Creating recommendations
  • Retrieving recommendation data

Updated Collecting data with the data layer.

Updated the Graniitti API changelog for API version 0.42.3.

5.72019-03-11

Updated the FProxy guide:

  • FProxy
  • Introduction to modification development
  • Installing and uninstalling FProxy
  • Configuring FProxy
  • Starting and stopping the FProxy server
  • Developing modification content with FProxy
  • FProxy CLI commands and parameters
5.62019-03-08

Restructured and updated the data layer guide:

  • Frosmo data layer
  • Collecting data with the data layer
  • Tracking conversions and transactions with the data layer
  • Tracking custom actions with the data layer
  • Tracking products with the data layer

Updated the Graniitti API changelog for API version 0.42.2.

5.52019-01-31

Updated the recommendations documentation:

  • Introduction to recommendations
  • Creating recommendations
  • Retrieving recommendation data
  • Example: Recommending products purchased together (including child topics)

Updated the following API documentation:

5.42019-01-18Added Example: Recommending products purchased together (configuration).
5.32019-01-11Updated the Graniitti API changelog for API version 0.42.1.
5.22019-01-09Site maintenance updates.
5.12018-12-10

Updated the Graniitti API guide:

5.02018-12-03

Added the following new topics documentation on the Frosmo Recommendations system:

4.02018-12-02

Restructured and consolidated the documentation for better usability by grouping the guides under the following new main topics:

3.52018-11-28Updated the Graniitti API changelog for API versions 0.41.5 and 0.42.0.
3.42018-10-15Updated the Graniitti API changelog for API version 0.41.4.
3.32018-10-01

Updated Frosmo data layer.

Updated the Graniitti API guide:

3.22018-09-13

Updated Tracking custom events with advanced tracking.

Removed the Downloads page and the standalone PDFs.

3.12018-09-05Updated the Graniitti API changelog for API versions 0.41.1 and 0.41.2.
3.02018-09-03

Added FProxy.

Added Frosmo Debugger.

Added Graniitti API.

2.02018-03-14Added Tracking custom events with advanced tracking.
1.22017-11-29Updated Frosmo data layer.
1.12017-10-23Moved the standalone PDFs from the front page to the Downloads page.
1.02017-08-17First public version of this documentation.

...