Graniitti API: Resources
Learn about Graniitti API resources.
Resource types
The Graniitti API uses the following resource types to represent the data in the Frosmo back end. Most of the resources are site-specific. For more information about the resource types and how to work with them, see the Graniitti API reference. For definitions of the basic concepts, see Glossary.
Changing back end data with the API does not update the Frosmo custom script for the related site. If you want to update the custom script, call the JavaScript export endpoint.
| Resource type | Description |
|---|---|
Activity | An activity represents a user action that changed some site-specific data in the Frosmo back end. You can get the activities logged for a site. |
Add-on or custom extension | An add-on is a piece of software that extends the functionality of the Frosmo Control Panel or the Frosmo Platform at large in some way. A custom extension also extends the functionality of the Control Panel, but is custom-created by a developer for a specific company. You can get add-ons and custom extensions enabled for a company. |
Affinity group | An affinity group represents a group of visitors who share the same affinity. You can get affinity groups. |
Annotation | An annotation represents a dated note associated with a site and shown in timeline-based statistics views. You can get, create, update, and delete annotations. |
Audience | You can get the sizes of affinity groups and segments. The size of an affinity group or segment is the number of visitors in the affinity group or segment. |
Company | A company represents a Frosmo customer or partner. You can get, create, and update companies. You can also get users associated with a company, and add users to and remove users from a company. |
Company or site setting | You can get and update the settings for a company and its sites. |
Conversion definition | A conversion definition specifies a visitor action or behavior that is tracked as a conversion. You can get, create, update, and delete conversion definitions. You can also change the trigger for a conversion definition. |
Conversion type | Each conversion has a type. You can get the conversion types used on a site. |
Custom action | A custom action specifies a visitor activity or state that is tracked. You can get, create, update, and delete custom actions. |
Custom code | You can get the custom code of a custom script, and you can add the custom code for a custom script. The custom code is represented as a file, which is stored in the Frosmo back end. The back end is used as an intermediary storage before the full custom script export to the CDN. |
Custom script | A custom script is a JavaScript file that contains the configurations and custom code specific to a single site. 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. tip If you want to get the full contents of a custom script but without the custom code, use the For more information about building and deploying the custom script, see Updating the custom script with the Graniitti API. |
Email campaign | An email campaign (also known as an email recommendation) is a piece of static HTML content that displays two to three dynamically generated product recommendations. The recommendations are based on the recommendation configuration assigned to the email campaign. You can get, create, update, publish, and delete email campaigns. You can also assign a recommendation configuration to an email campaign. |
Error tracking service | An error tracking service tracks a specific type of data about a site's performance. A service alert is a status update for a service. Services and service alerts are features of the error tracking functionality of the Frosmo Platform. You can get, update, and delete services, and you can get and send service alerts. You can also update a user's service settings, and get the error tracking services from the sites the user is monitoring. |
Google Analytics settings | You can get and update the Google Analytics settings for a site. |
Label | A label represents a short text tag that can be attached to a modification (message). You can get, create, update, and delete labels. You can also explicitly attach labels to and remove labels from modifications. |
Modification | A modification specifies the content and settings of a web page modification. You can get, create, update, and delete modifications. You can also explicitly attach labels to and remove labels from modifications. info The endpoint for modifications uses the term |
Placement | A placement specifies where on a web page modifications can be placed. You can get, create, update, and delete placements. You can also get the modifications that use a specific placement, change the trigger for a placement, and remove the trigger from a placement. info The endpoint for placements uses the term |
Product | A product represents a good or service offered to visitors on a site. You can get a specific product or a set of products tracked on a site. You can also get, assign, and remove relevant products for a modification, and get the non-relevant products for a modification. |
Recommendation configuration | A recommendation configuration defines the logic and settings for generating the recommendation data for a single recommendation. You can get, create, update, and delete recommendation configurations. note Recommendation strategies are the default and preferred way of generating recommendation data. If possible, use a recommendation strategy instead of a recommendation configuration when creating a new recommendation. |
Recommendation strategy | A recommendation strategy defines the logic and settings for generating the recommendation data for a single recommendation. You can get, create, update, and delete recommendation strategies. |
Segment | A segment represents a group of visitors who share the same interests, location, website behavior, or other characteristics relevant to content targeting. Segments are site-specific. You can get, create, update, and delete segments. |
Segment group | A segment group is a container for grouping together related segments, much like a folder in a file system. A segment group can also be used to make the segments within it mutually exclusive. This means that a visitor can only belong to one of the grouped segments at a time. Segment groups are site-specific. You can get, create, update, and delete segment groups. You can also add segments to and remove segments from segment groups. info Segment group data does not include any segment data. If you want to get the segments of a segment group, use embedding. |
Shared code | Shared code is JavaScript that is automatically executed on every page load on a site. You can get, create, update, and delete pieces of shared code. You can also change the trigger for a piece of shared code, and remove the trigger from a piece of shared code. |
Site | A site represents a website associated with a company. You can get, create, update, and delete sites. You can also get and update a user's site-related settings, and get the sites a user is monitoring for errors. |
Smart Discovery | A Smart Discovery is selection of recommended searches, or Smart Discovery collections, generated by the Frosmo Platform for a specific page type and optionally category. You can get the Smart Discoveries generated for a site. |
Statistics | You can get and export different types of statistics data (reports) for a site. You can also export your own custom statistics data (in case there's no predefined report that you can use). |
Template | A template represents a modification content template. You can get, create, update, and delete templates. |
Trigger | A trigger allows you to detect a particular event on a web page and take a predefined action based on that event. You can get, create, update, and delete triggers. |
User | A user represents a user account in the Frosmo Control Panel. You can get, create, update, and delete users. You can also add a user to and remove a user from companies. |
Workspace | A workspace allows you to safely develop and test site features in the Frosmo Control Panel without affecting the live content of your site. You can get, create, update, and delete workspaces. |
Workspace custom script | A workspace custom script is a workspace-specific version of the site's production custom script. The workspace custom script includes the in-development changes made to the site in the workspace. You can trigger an update that builds and deploys the workspace custom script to the content delivery network (CDN). You can also get the full contents or just the site configuration part of the workspace custom script, and you can delete the workspace custom script from the CDN. |
Workspace modification | A workspace modification is an in-development modification in a workspace. You can get, create, update, and delete workspace modifications. |
Workspace placement | A workspace placement is an in-development placement in a workspace. You can get, create, update, and delete workspace placements. You can also change the trigger for a placement, and remove the trigger from a placement. The trigger must be either in the same workspace or in production. |
Workspace shared code | Workspace shared code is in-development shared code in a workspace. You can get, create, update, and delete pieces of workspace shared code. You can also change the trigger for a piece of shared code, and remove the trigger from a piece of shared code. The trigger must be in the same workspace. |
Workspace template | A workspace template is an in-development modification content template in a workspace. You can get, create, update, and delete workspace templates. |
Workspace trigger | A workspace trigger is an in-development trigger in a workspace. You can get, create, update, and delete workspace triggers. |
Date and time in resources
For representing date and time, the Graniitti API supports the following ISO 8601 formats:
-
YYYY-MM-DDThh:mm:ss+hh:mm -
YYYY-MM-DDThh:mm:ss.sssZ
You can use either format in date-and-time fields.
The following example shows the same date and time, 08.03.2021 08:30 UTC, in the ISO 8601 formats.
2021-03-08T08:30:00+00:00
2021-03-08T08:30:00.000Z