Config API Version 2 Installation Groups
Introduction
An Installation Group (IGRP) represents one or more web sites that are tracked (and reported) together under a single installation ID.
- Each IGRP is assigned a numeric ID that can be used to reference it in the APIs.
List IGRPs
Returns a list of IGRPs that the current user can access.
Request:
GET Params
- rootOrgId (integer) OPTIONAL - limit the result set within this organisation branch.
- filter (array) OPTIONAL - One or more filters, see Filter Types.
- sort (array) OPTIONAL - One or more sorting params, see Sort Types.
- limit (integer) OPTIONAL - limit on the result set.
- offset (integer) OPTIONAL - offset of the result set.
Filter Types
- igrp (int) - Installation ID.
- igrpName (string) - Installation Name.
- packageType (string) - Type of the package.
- orgId (int) - Organisation this IGRP belongs to.
Sort Types
- igrp (int) - Installation ID.
- igrpName (string) - Installation Name.
- packageType (string) - Type of the package.
- orgId (int) - Organisation this IGRP belongs to.
Response:
Returns list of igrps that the current user can access.
- orgId (int) - Organisation this IGRP belongs to.
- primaryOrgId (int) - Deprecated alias of orgId.
- igrp (int) - Installation ID.
- igrpName (string) - Installation Name.
- packageType (string) - Type of the package.
- targetCostPerConversion (float) - Target cost per conversion setting.
- targetConversionRate (float) - Target conversion rate setting.
- targetReturnOnInvestment (float) - Target ROI setting.
- targetConversionValuePerClick (float) - Target conversion value per click setting.
- maxNonConvSpend (float) - Maximum non-conversion spend.
- useNetworkConversions (int) - A flag (1 or 0) to use network tracked conversions.
- attributionModelId (int) - Default attribution model ID.
- ppcAttributionModelId (int) - Default PPC attribution model ID.
- tz (string) - Timezone.
- currency (string) - Default currency code for the IGRP (three-letter ISO-4217 currency code).
- rec (int) - A flag (1 or 0) to enable Call recording playback.
- geoip (string) - IP lookup setting.
- showOrgAndSegmentFilter (int) - A flag (1 or 0) to show segments in portal.
- dgrpUrls (array) - A map of URLs to DGRP IDs.
- passTags (array) - Pass through tags
- customTags (array) - Custom tags
- detectLandOnPageView (int) - A flag (1 or 0) to detect tagged lands on page view, including matching referrer domain.
- sfOrgRef (string) - The Salesforce organisation ID this installation is associated with.
- igrpType (string) - The type of IGRP. Can be blank (empty) or pbx for phone system installs.
Deprecated Fields
Fields marked as Deprecated will be removed from the response in future iterations!
Read IGRP Config
Returns the properties for a particular IGRP.
Request:
URL Path Params
- IGRP SPECIFIER (int) - Installation ID.
Response:
Returns the requested igrp details as a JSON encoded object.
- orgId (int) - Organisation this IGRP belongs to.
- primaryOrgId (int) - Deprecated alias of orgId.
- igrp (int) - Installation ID.
- igrpName (string) - Installation Name.
- packageType (string) - Type of the package.
- targetCostPerConversion (float) - Target cost per conversion setting.
- targetConversionRate (float) - Target conversion rate setting.
- targetReturnOnInvestment (float) - Target ROI setting.
- targetConversionValuePerClick (float) - Target conversion value per click setting.
- maxNonConvSpend (float) - Maximum non-conversion spend.
- useNetworkConversions (int) - A flag (1 or 0) to use network tracked conversions.
- attributionModelId (int) - Default attribution model ID.
- ppcAttributionModelId (int) - Default PPC attribution model ID.
- tz (string) - Timezone.
- currency (string) - Default currency code for the IGRP (three-letter ISO-4217 currency code).
- rec (int) - A flag (1 or 0) to enable Call recording playback.
- geoip (string) - IP lookup setting.
- showOrgAndSegmentFilter (int) - A flag (1 or 0) to show segments in portal.
- dgrpUrls (array) - A map of URLs to DGRP IDs.
- passTags (array) - Pass through tags
- customTags (array) - Custom tags
- detectLandOnPageView (int) - A flag (1 or 0) to detect tagged lands on page view, including matching referrer domain.
- sfOrgRef (string) - The Salesforce organisation ID this installation is associated with.
- igrpType (string) - The type of IGRP. Can be blank (empty) or pbx for phone system installs.
- badCallQueueSecs (int) - The threshold for bad call queue duration.
- numberReplacement (int) - A flag (1 or 0) to indicate whether or not number replacement is active for this IGRP.
- callFailAlertSensitivity (string) - The call fail alert sensitivity setting
- alertEmail (string) - A comma delimited list of email addresses to send alerts to
- voidUnmatchedCrmTriggers (int) - A flag (1 or 0) to indicate whether or not to void non-matching triggers.
- features (array) - Read-only. A list of features available to the IGRP.
Deprecated Fields
Fields marked as Deprecated will be removed from the response in!
Update IGRP Config
Update the properties for a particular IGRP.
Note that the IGRP’s orgId (and primaryOrgId) property is read only once created. To update it you should update the orgId property of segment 0 (zero) for this IGRP.
Request:
URL Path Params
- IGRP SPECIFIER (int) - Installation ID.
POST Params
- igrpName (string) OPTIONAL - Friendly name of the Installation (e.g. “My Website”).
- targetCostPerConversion (float) OPTIONAL - Target cost per conversion, a positive float value.
- targetConversionRate (float) OPTIONAL - Target conversion rate, a positive float value.
- targetReturnOnInvestment (float) OPTIONAL - Target return on investment, a positive float value.
- targetConversionValuePerClick (float) OPTIONAL - Target conversion per click, a positive float value.
- maxNonConvSpend (float) OPTIONAL - Maximum non conversion spend, positive float value.
- useNetworkConversions (integer) OPTIONAL - A flag (1 or 0) to use network-tracked conversions for CPA and ROAS calculations instead of Infinity converting goals.
- attributionModelId (integer) OPTIONAL - Default attribution model ID to use for reports.
- ppcAttributionModelId (integer) OPTIONAL - Default attribution model ID to use for PPC reports this is an optional override for the main IGRP attribution model.
- tz (string) OPTIONAL - A valid time zone in string format, E.g. Europe/London.
- currency (string) OPTIONAL - Default currency for the IGRP (three-letter ISO-4217 currency code).
- rec (int) OPTIONAL - A flag (1 or 0) to enable call recording playback.
- geoip (string) OPTIONAL - Enabling/Disabling IP lookup. Allowed values are 0, country, region or city.
- showOrgAndSegmentFilter (int) OPTIONAL - A flag (1 or 0) to allow customer to see segments in portal.
- dgrpUrls (array) OPTIONAL - A map of URLs to DGRPs. Must contain a default DGRP if set (e.g. array( ‘default’ => [{DGRP IDs}] )).
- passTags (array) OPTIONAL - An array of pass through tags
- customTags (array) OPTIONAL - An array of custom tags
- dgrpMap (array) OPTIONAL - A DGRP map config. Should contain mapId and keyVar keys. keyVar can be one of ipCountryCode, href or randPerc
- detectLandOnPageView (int) OPTIONAL - Flag (1 or 0). Allows detecting tagged lands, even when the referrer domain matches the current URL.
- sfOrgRef (string) OPTIONAL - The Salesforce organisation ID to associate this installation with.
- badCallQueueSecs (int) OPTIONAL - The threshold for bad call queue duration.
- numberReplacement (int) OPTIONAL - A flag (1 or 0) to indicate whether or not number replacement is active for this IGRP.
- callFailAlertSensitivity (string) OPTIONAL - The call fail alert sensitivity, can be either “off”, “low” or “high”
- alertEmail (string) OPTIONAL - A comma delimited list of email addresses to send alerts to
- voidUnmatchedCrmTriggers (int) OPTIONAL - A flag (1 or 0) to indicate whether or not to void non-matching triggers.
Response:
Returns the HTTP response code to reflect the request outcome.
Deprecated Parameters
Parameters marked as Deprecated will stop being supported in future iterations!
Onboarding Checks
Returns a list of checks for a specific IGRP.
Request
This route accepts the following parameter:
- IGRP SPECIFIER (int) - Installation ID.
This route supports limit, sort and filter parameters with the following filters/sorts able to be applied:
- igrp (int) - This is a unique IGRP ID
- igrpName (string) - This is a unique IGRP Name
- igrpStatus (int) - The status of the IGRP (200: IGRP is active, 423: IGRP is expired)
- checkId (int)
- checkCode (string) - The name of the check
- checkValue (int) - The value which is returned by the check
- checkStatus (int) - 200: check complete, 202: check not complete
- updateDatetime (datetime)
Response:
Returns a 200 OK response on success, with the following properties.
- igrp (int) - This is a unique IGRP ID
- igrpName (string) - This is a unique IGRP Name
- igrpStatus (int) - The status of the IGRP (200: IGRP is active, 423: IGRP is expired)
- checkId (int)
- checkCode (string) - The name of the check
- checkValue (int) - The value which is returned by the check
- checkStatus (int) - 200: check complete, 202: check not complete
- updateDatetime (datetime)