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 8.2

...

Note

Graniitti API versions that only include Frosmo-internal improvements are not documented, so if you spot a jump in the documented version numbers, that's what happened.

Graniitti API 0.55.0 (2020-09-21)

Frosmo Platform main release: Juneau

Improvements

Graniitti API 0.54.0 (2020-09-09)

Frosmo Platform main release: Juneau

Improvements

  • Added the description field to modifications (/sites/<site_id>/messages) for defining a description for a modification.
  • Added the pre_renderer field to templates (/sites/<site_id>/templates) for defining a prerenderer for the template content. For more information about the prerenderer, see the Juneau release notes.

...

Frosmo Platform main release: Iron Creek

Improvements

  • Updated the validation for recommendation configurations (/sites/<site_id>/recommendations) whose type is bundle_converted, bundle_viewed, or bundle_viewed_converted: The API now expects a bundle configuration to contain an options property with a product_attrs child property, which is used for filtering the generated recommendation data by a product attribute.

...

Frosmo Platform main release: Iron Creek

Improvements

  • In company settings (/companies/{company_id}/settings/timezone), added a missing timezone (America/Sao_Paulo, UTC -03:00) and changed the names of other timezones from Poland to Europe/Warsaw (UTC +01:00) and from Turkey to Europe/Istanbul (UTC +03:00) to comply with the Coordinated Universal Time (UTC) standard.

...

  • In recommendations (/sites/<site_id>/recommendations), updated the requirements for recommendation configurations based on the built-in recommendation types:
    • For the most_viewed and most_converted recommendation types:
      • If there are segment IDs defined in the options object, you can only filter recommendation data based on those segment IDs (not by any segment ID, as before).
      • You no longer need to define parameter values in the params property. You can pass an empty string as a value. However, you must define at least one parameter (even if it's value is an empty string). 
      • The number of parameters defined in the params property must match the number of attributes defined in the product_attrs property of the options object. If there are segment IDs defined in the options object, there must be an additional parameter for the segment ID included in the params property.
      • If the category_delimiter property is defined in the options object, the type product attribute must also be defined in the product_attrs property.
    • The bundle_converted, bundle_viewed, and bundle_viewed_converted recommendation types only take a single parameter in the params property.
    • The value property of the data point object has been deprecated.

Improvements

  • Added the /sites/<site_id>/recommendations/<recommendation_id>/model endpoint for retrieving and updating recommendation models.

...

Frosmo Platform main release: Happy Valley

Improvements

  • Recommendations (/sites/<site_id>/recommendations) must now have unique names within a site. When you create or update a recommendation with a name that is already used by an existing recommendation on the site, the API throws a validation error.

...

Frosmo Platform main release: Happy Valley

Improvements

  • Added the status property to the objects returned by the /sites/<site_id>/positions/<position_id>/messages endpoint. The status property indicates the status of the corresponding modification: activeinactiveinvalid, past, or upcoming. The Frosmo Control Panel uses the status property in the Edit placement view to list the modifications that use the placement by modification status.

...

Frosmo Platform main release: Happy Valley

Improvements

  • When you create or update a recommendation (sites/<site_id>/recommendations) whose type is bundle_converted, bundle_viewed, bundle_viewed_converted, most_converted, or most_viewed, the API now checks that the value of the hours field is greater than or equal to 1 and less than or equal to 1440. If the value is outside this range, the API returns an error.

...

  • Updated the /sites/<site_id>/positions/<position_id>/messages endpoint to return an array of objects, where each object contains the id, name, type, and state of a modification that uses the specified placement. Previously, the endpoint returned an array of numbers, where each number was the ID of a modification that used the specified placement.

Improvements

  • Added the /sites/<site_id>/workspaces/<workspace_id>/positions/<position_id>/messages endpoint for retrieving the workspace modifications that use the specified workspace placement. The endpoint returns an array of objects, where each object contains the id, name, type, and state of a workspace modification.

    Tip

    To retrieve the production modifications that use a given production placement, use the /sites/<site_id>/positions/<position_id>/messages endpoint.


...

Frosmo Platform main release: Happy Valley

Improvements

  • For templates whose export_strategy is automatic, the Graniitti API now adds the template content to the custom script only if a template is used in an active variation of an active modification and only if that modification has content preloading enabled. The Graniitti API no longer exports template content for modifications that have content preloading disabled, since the Message API now delivers the template content for these modifications, omitting the need to add the content to the custom script.

...

Frosmo Platform main release: Happy Valley

Improvements

  • If you edit and save a template whose export_strategy is automatic, the API now always checks whether to export the template. If the template is used in at least one active variation of at least one active modification, the API updates the template content to the custom script of the site. Previously, the API only checked whether to export when the export_strategy was changed. For more information about template export, see Creating and editing a template.

...

Frosmo Platform main release: Happy Valley

Improvements

  • In the API reference, updated selected method descriptions for improved clarity and consistency.

...

Frosmo Platform main release: Goodnews Bay

Improvements

  • Added the /sites/<site_id>/js/urls endpoint for getting the absolute URLs for the Frosmo Core script and custom script used by a site. The endpoint returns a JSON object with two string fields: core for the Frosmo Core script URL and custom for the custom script URL.
  • Increased the maximum length of the element_id field of placements (/sites/<site_id>/positions) from 256 to 512 characters. The element_id field stores the target element selector for a placement.

...

Frosmo Platform main release: Goodnews Bay

Improvements

  • Added support for 0m as a possible value for the frequency field of a recommendation (sites/<site_id>/recommendations). Setting the frequency to 0 minutes means that the recommendation data is never automatically regenerated. To refresh the data, you must manually queue the recommendation for processing.
  • Added the /sites/<site_id>/statistics/report/api_call_counts_summary endpoint for getting the summary counts of site events from a specific start time onwards.

...

Frosmo Platform main release: Goodnews Bay

Improvements

  • Removing a workspace (/sites/<site_id>/workspaces/<workspace_id>) now also removes the content of that workspace (modifications, placements, templates, triggers).

Bug fixes

  • Fixed a bug where custom script update failed due to concurrent requests updating the same script at the exact same time. This happened only very rarely.
  • Fixed a bug where, if you used a production trigger (/sites/<site_id>/triggers/<trigger_id>) in a workspace placement (/sites/<site_id>/workspaces/<workspace_id>/positions/<position_id>), and then removed the workspace without first explicitly removing the placement from it, the trigger could no longer be removed.

...

Frosmo Platform main release: Goodnews Bay

Improvements

  • Added the export_strategy field to templates (/sites/<site_id>/templates) for defining the export strategy of a template. You can set the value to automatic or manual.
  • If the export_strategy of a template is automatic, and if the template is used in an active variation of an active modification, the API automatically sets the export field of the template to true.
  • Increased the maximum length of the name field of workspaces (/sites/<site_id>/workspaces) from 32 to 128 characters.

...

Frosmo Platform main release: Goodnews Bay

Improvements

  • Added the following endpoints for getting all modifications that use a given template:
    • /sites/<site_id>/templates/<template_id>/messages for getting all production and workspace modifications that use the given production template
    • /sites/<site_id>/workspaces/<workspace_id>/templates/<template_id>/messages for getting all workspace modifications that use the given template in the same workspace
  • If you update the name field of a template, the API now automatically updates the new name to every modification variation that uses the template.

...

Frosmo Platform main release: Goodnews Bay

Improvements

  • Added the is_all_frosmo_off field to sites (/sites, /sites/<site_id>/companies/<company_id>/sites, /users/<user_id>/monitoring-sites) for getting sites based on whether they have the Frosmo Platform enabled or disabled. If is_all_frosmo_off is set to true for a site, the platform is disabled for that site, while if is_all_frosmo_off is set to false, the platform is enabled. The field only works in GET requests.

    Tip

    To enable or disable the platform for a site, send a PATCH request to /companies/<company_id>/settings/is_all_frosmo_off.


...

Frosmo Platform main release: Goodnews Bay

Improvements

  • Removed the deprecated contexts.segments and contexts.segment_criteria properties from the modification object (/sites/<site_id>/messages). For more information about the change where these properties were deprecated, see the changelog entry for version 0.43.0.

Graniitti API 0.43.12 (2019-08-05)

Frosmo Platform main release: Goodnews Bay

Improvements

  • Added the model_updated_at field to recommendations (/sites/<site_id>/recommendations) for tracking when the recommendation data was last successfully generated. The platform automatically updates this field.

...

Frosmo Platform main release: Goodnews Bay

Improvements

  • Migrated all existing production modifications to use the segment_rules property in place of the contexts.segments and contexts.segment_criteria properties for defining their segment rules. The contexts.segments and contexts.segment_criteria properties are no longer used by any production modification. For more information about this change, see the changelog entry for version 0.43.0.

Graniitti API 0.43.0 (2019-05-06)

Frosmo Platform main release: Goodnews Bay

Improvements

  • Added support for the new segment selection feature for modifications, which combines selecting segments and defining a segment combination into a single workflow in the Frosmo Control Panel:
    • All new modifications must define their segment rules in the segment_rules property of the modification object (/sites/<site_id>/messages). Previously, only cached modifications used the segment_rules property, while other types of modifications used the contexts.segments and contexts.segment_criteria properties.
    • The contexts.segments and contexts.segment_criteria properties, which store segment and segment combination data, respectively, are now effectively deprecated. Existing production modifications that use these properties will be gradually migrated to use the segment_rules property.

...

Frosmo Platform main release: Funny River

Improvements

  • Increased the maximum size of template content (/sites/<site_id>/templates) to 512 KB (524 288 characters). If you try to create or update a template with a template field whose value exceeds the size limit, the API returns an error.

...

Frosmo Platform main release: Elephant Point

Improvements

  • Improved the response time for GET /sites/<site_id>/js?custom_code requests by caching the returned custom script contents.

...

  • Added support for add-ons (/companies/<company_id>/addons)
  • Added support for custom extensions (/companies/<company_id>/custom-addons).
  • Added support for plans:
    • Added the following new company settings (/companies/<company_id>/settings) for enabling and disabling feature access based on a company's plan:
    • Added target groups to activities (/sites/<site_id>/activities). Whenever a target group is added, edited, or removed, the API now logs the action as an activity for the first site of the company. This is required for tracking target group usage against plans.

Improvements

  • Added the custom_code query parameter to GET /sites/<site_id>/js. The parameter allows you to replace the custom code in the returned custom script with the parameter value. Use the parameter when you only want to retrieve the site configuration and module parts of the custom script. For example, GET /sites/1234/js?custom_code=PLACEHOLDER returns the full contents of the custom script but with the custom code replaced by the text "PLACEHOLDER".
  • Added size validation for templates (/sites/<site_id>/templates). Template content cannot exceed 65 535 characters in length.
  • Improved API request performance by caching routes.
  • Improved error reporting by reclassifying selected errors and warnings as critical errors.

...

Feature updates

  • Added support for the new error handling and logging functionality provided by Frosmo Core. Custom scripts exported by the API now use the new error handling and logging features (namely easy.guard() and the easy.log module).

Improvements

  • When you export a custom script to the CDN (/sites/<site_id>/js/export), the API now excludes the profile property from cached modification objects in cases where the site does not have selective profiling enabled. Previously, the API exported the profile property for cached modifications regardless of whether or not the site used selective profiling.

...

  • Added support for the selective profiling feature. If enabled for a site, selective profiling forces you to define for each modification separately whether the modification is for visitors who have opted in to profiling, visitors who have opted out of profiling, or all visitors. This feature is implemented as follows:
    • Added the profile field to modifications (/sites/<site_id>/messages) for defining the profiling setting for a modification. You can set the field to opt-in, opt-out, or all.
    • Added the mod_profile field to site settings (/companies/<company_id>/settings) for enabling and disabling selective profiling for a site. You can set the field to true (1) or false (0).
  • Added support for the temporary password feature. When you create a new Frosmo Control Panel user and define a password for them, or when you change the password of an existing user, the password is set to expire in 30 days. The user is prompted to change the password when they log in to the Control Panel.
  • Improved the error tracking feature:

    • When a Frosmo Control Panel user is removed from a company, the user's error tracking settings for the company are archived.
    • When a Frosmo Control Panel user is added back to a company from which they were previously removed, the user's error tracking settings for the company are restored.

    The error tracking settings consist of:

    • Monitored sites (/users/<user_id>/monitoring-sites)
    • Subscribed error services (/users/<user_id>/error-services)
  • Improved the workspaces feature:
    • Added support for templates (/sites/<site_id>/workspaces/<workspace_id>/templates).
    • Added support for workspace-specific custom code.
    • Added support for deleting the workspace custom script from the CDN (/sites/<site_id>/workspaces/<workspace_id>/js/export).

Improvements

  • Added time zone information to the date and time values in paginated results. Previously, the API returned the date and time values without the time zone, which prevented client applications from adjusting the date and time accordingly.
  • When you export a custom script to the CDN (/sites/<site_id>/js/export), the API now automatically sets the minimum Frosmo Core version supported by the script to two minor versions behind the current Frosmo Core version. For example, if the current Frosmo Core version is 8.29.0, the API sets the minimum supported version to 8.27.0.

...

  • Added support for the workspaces feature. Workspaces allow you to safely develop both new and existing modifications in the Frosmo Control Panel without affecting the live content of the site. This feature is implemented as follows:
    • Added the /sites/<site_id>/workspaces endpoint for managing workspaces. You can get, create, update, and delete workspaces.
    • Added the /sites/<site_id>/workspaces/<workspace_id>/js endpoint for managing the custom script of a workspace. You can trigger an update that builds and deploys the latest custom script to the content delivery network (CDN). You can also get the full contents or just the site configuration part of the custom script.
    • Added the /sites/<site_id>/workspaces/<workspace_id>/messages endpoint for managing the modifications within a workspace. You can get, create, update, and delete workspace modifications.
  • Improved the error tracking feature:
    • Added the /users/<user_id>/error-services endpoint for getting the error tracking services from the sites the user is monitoring. The endpoint only returns services whose status is "Warning" or "Critical".
    • Opened the feature to all users. Any user can now track site errors from the Frosmo Control Panel or through the Graniitti API.

Improvements

  • Removed support for Internet Explorer 9. You can no longer configure a site as supporting IE9.
  • In the API reference, added dedicated endpoint sections for each statistics report (/sites/<site_id>/statistics/report/<report_name>). Instead of selecting the report with the report parameter in the shared endpoint section (/sites/<site_id>/statistics), you can now refer to the report's dedicated section instead (for example, /sites/<site_id>/statistics/report/all_conversions.daily). The dedicated sections have the advantage of providing only the parameters valid for the current report.

...

  • Added support for the advanced tracking feature. This feature extends the basic tracking functionality of the Frosmo Platform (clicks, displays, true displays) by allowing you to send additional tracking data from a site to the Frosmo back end. This feature is implemented as follows:
    • Added the /companies/<company_id>/settings/mod_advanced_tracking endpoint for enabling and disabling advanced tracking for a site.
    • Added the /sites/<site_id>/statistics/report/tracking_events_summary endpoint for getting the tracking_events_summary report for custom events. This report returns the total event counts and unique visitor counts for tracked custom events over the selected time period.
    • Added the /sites/<site_id>/statistics/report/tracking_events_summary.daily endpoint for getting the tracking_events_summary.daily report for custom events. This report returns the daily event counts and unique visitor counts for tracked custom events over the selected time period.
    • Added the tracking_events_summary.daily report as a possible parameter value to GET /sites/<site_id>/statistics. You can also get this report directly with the dedicated endpoint.
  • Removed the /companies/<company_id>/settings/messages_before_context endpoint, since this company setting is no longer needed.
  • Removed the counterId field for segment triggers from the site configuration part of the custom script (/sites/<site_id>/js/config). This field was replaced by the counterIds field already in the Frosmo Tarzana release, and has since been supported only for backward compatibility.
  • Previously, for a modification using the multi-armed bandit, variation distributions were recalculated every time the modification was saved. This meant that the distributions were recalculated even when there was no change to the data (clicks, displays) used for the calculations. This has now been changed so that distributions are recalculated only when:
    • Modification is activated
    • Variation is activated
    • Variation is deactivated
    • Multi-armed bandit reward is changed
    • Multi-armed bandit algorithm is changed

Improvements

  • In the API reference, updated the method descriptions, request parameter descriptions, response descriptions, response status code reasons, and selected endpoint names for improved clarity and usability.

...

  • Improved pagination support:
    • Added pagination based on the page and per_page query parameters to all resources. You must always specify the page parameter if you want to paginate results. Paginated results are embedded inside a paginator object, which provides the necessary metadata about the pagination. For more information, see Managing results.
    • Updated the pagination for activities (/sites/<site_id>/activities) and products (/sites/<site_id>/products) to use the page and per_page query parameters.
    • Limited requests that do not use pagination to 10 000 results. If a request finds more than 10 000 results, the API returns an error. In this case, to get the results, use pagination.
  • If you use an invalid date format in a GET /sites/<site_id>/statistics or GET /sites/<site_id>/statistics/export request, the response now provides instructions for using the correct date format.

...

  • Added the /sites/<site_id>/messages/<message_id>/products endpoint for products relevant to a modification. You can get, attach, and remove relevant products for a modification.
  • Added the /sites/<site_id>/messages/<message_id>/non-relevant-products endpoint for getting the products that are not relevant to a modification.
  • Added pagination support for products (/sites/<site_id>/products). For more information, see Managing results.

Bug fixes

  • Fixed an issue where a service alert (/sites/<site_id>/service-alerts) failed to update the corresponding service (/sites/<site_id>/services) if the alert did not change the service status, description, or data. The API now correctly updates the updated_at field of a service even in cases where an alert changes nothing about the service.
  • Fixed an issue where temporarily disabling a service blocked service alerts to that service even after the disable period had expired. If you tried to POST a new alert after the disable period had expired, the API returned an error, meaning the service was still effectively disabled. This has now been fixed, and new alerts work normally after the disable period.
  • For cached modifications using the multi-armed bandit, fixed an issue where recalculated variation distributions were not updated to the custom script.
  • For cached modifications using the multi-armed bandit, if a variation is assigned a 0% distribution, the data for that variation is no longer included in the custom script. This helps reduce the file size of the custom script.

...

  • Added the target group resource (/companies/<company_id>/target-groups). You can get, create, update, and delete target groups.
  • Added the JavaScript export endpoint for updating the custom script for a site (/sites/<site_id>/js/export).
  • For the custom action resource, added support for POST, PUT, and DELETE methods (/sites/<site_id>/custom-actions).
  • Merged the custom action value resource to the custom action resource. The values are now represented as an array of objects (values) within the custom action object.

...