Pages

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

Table: Graniitti API resource types

Resource typeDescription
ActivityAn 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 extensionAn add-on is a piece of software available for purchase from Frosmo that extends the functionality of the Frosmo Control Panel 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 the add-ons and custom extensions enabled for a company.
AnnotationAn annotation represents a dated note associated with a site and shown in timeline-based statistics views. You can get, create, update, and delete annotations.
CompanyA 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 settingYou can get and update the settings for a company and its sites.
Conversion definitionA 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 typeEach conversion has a type. You can get the conversion types used on a site.
Custom actionA custom action specifies a visitor activity or state that is tracked. You can get, create, update, and delete custom actions.
Custom codeYou 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.

If you want to get the full contents of a custom script but without the custom code, use the custom_code query parameter to replace the custom code with a placeholder text string. For more information, see Requests.

For more information about building and deploying the custom script, see Custom script update.

Error tracking serviceAn 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 settingsYou can get and update the Google Analytics settings for a site.
LabelA 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.

The endpoint for modifications uses the term message, since this is what modifications were previously called in the Frosmo Platform.

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.

The endpoint for placements uses the term position, since this is what placements were previously called in the Frosmo Platform.

ProductA 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

A recommendation combines a recommendation configuration and the recommendation data generated for that configuration. The recommendation data serves as the basis for building the actual recommendation element displayed on a site. You can get, create, update, and delete recommendations.

For more information about creating and managing recommendations, see the Graniitti API guide for recommendations.

For displaying recommendations on a site, you retrieve the recommendation data with the Recommendations API, not the Graniitti API.

Script errorScript errors are errors thrown by the Frosmo Core library and the Frosmo custom script as they are executed on a site. You can get the hourly error counts for the modifications with the most errors.
SegmentA 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.

Segment group data does not include any segment data. If you want to get the segments of a segment group, use embedding.

SiteA 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.
StatisticsYou 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).
Target groupA target group combines multiple segments using Boolean logic to form an aggregate group of visitors for content targeting. Target groups allow for more complex segmentation than individual segments or segment groups. Target groups are company-specific, which means that they are valid across all sites of a given company. You can get, create, update, and delete target groups.
TemplateA template represents a modification content template. You can get, create, update, and delete templates.
TriggerA 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.
UserA 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.
WorkspaceA 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 scriptA 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 modificationA workspace modification is an in-development modification in a workspace. You can get, create, update, and delete workspace modifications.
Workspace placementA 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 templateA workspace template is an in-development modification content template in a workspace. You can get, create, update, and delete workspace templates.
Workspace triggerA workspace trigger is an in-development trigger in a workspace. You can get, create, update, and delete workspace triggers.
  • No labels