Plugins
Optional plugins that add site-wide functionality
Last updated
Optional plugins that add site-wide functionality
Last updated
The Plugins resource allows for enabling of functionality site-wide. Normally these plugins also have configurable fields that change the behavior as well has fields that take account IDs or other credentials needed for the plugin to function. It is a sub-resource of "Site".
Each plugin has specific fields. Documentation for the specific fields and example for each plugin can be found below.
A plugin object contains the following common fields
Below is an example of a googletagmanager plugin which has a field unique to this plugin account_id. Documentation for the specific fields for each plugin can be found further below.
POST /api/v2/sites/:site_id/plugins/:plugin_type/
List all plugins for a Site ID including active and inactive
Fetch the Plugin detail using the Site.id and Plugin.plugin_type. This endpoint can also be used to determine if a particular plugin is already added to a Site
PUT /api/v2/sites/:site_id/plugins/:plugin_type/
DELETE /api/v2/sites/:site_id/plugins/:plugin_type/
customtag)Adds custom HTML to the header, footer, or prebody (right after <body>) of all pages within your Site
In addition to the common fields, a customtag plugin object contains the following fields
googleglobalsitetag)Adds the Google Site Tag (i.e. gtag) to your site in the correct locations within the HTML.
This plugin supports the following tracker types/account IDs
UA-XXXXXX - Universal analytics (i.e. Google Analytics)
G-XXXXXX - GA4 (Google Analytics 4)
In addition to the common fields, a googleglobalsitetag plugin object contains the following fields.
googletagmanager)Adds the Google Tag Manager tags to your site in the correct locations within the HTML
In addition to the common fields, a googletagmanager plugin object contains the following fields
| Attribute | Type | Description |
|---|---|---|
plugin_type
customtag
Adds custom HTML to the header, footer, or prebody (right after <body>) of all pages within your Site
googletagmanager
Adds the Google Tag Manager tags to your site in the correct locations within the HTML
Attribute
Type
Description
id
integer
Unique id of the plugin
active
boolean
Inactive plugins maintain configuration but do not output on the Site
plugin_type
string
Type of the plugin (required)
site_id
integer
Reference id to the Site this plugin is under
Attribute
active
plugin_type
Attribute
Type
Description
footer_template
string
HTML to add to the bottom of the page before the closing </body> tag
header_template
string
HTML to add to the end of the <head> tag
prebody_template
string
HTML to add to the start of the page right after the <body> tag
account_id
string
gtag config tracking ID.
account2_id
string
gtag config tracking ID.
account3_id
string
gtag config tracking ID.
Attribute
Type
Description
account_id
string
The Google Tag Manager account ID, excluding the GTM- prefix