Config API Version 2 Integrations

Introduction

A trigger represents a tracked event. As triggers are imported into our platform they will be matched against an installation’s Integration configuration and if they meet the criteria specified this event will be passed on, for example sending an email or passing an event into Google Analytics.

Each Integration is assigned a numeric ID that can be used to reference it in the APIs.
Each Integration has criteria that the event needs to match.
Each Integration has a plugin name.
Each named plugin also defines additional specific properties, as described in the Plugins section below.

Integration Properties

igrp (int) - Installation ID.
segment (int) - Segment ID. If this is non-zero then triggers must belong to this segment to match this integration. Only relevant to “triggen” type integrations.
integrationId (int) - An integer with the Integration ID.
integrationName (string) - Name of the Integration, must be unique within the IGRP.
integrationDescription (string) - Friendly description of the Integration.
criteriaConfig (array) - An array of rules for matching triggers to Integrations.
customVarConfig (array) - An array of custom or infinity variables to be passed to the Integration as custom variables.
pluginType (string) - Name of the system that uses this plugin, either “triggen” (real-time) or “reportgen” (batched).
pluginName (string) - Name of the plugin this integration will run.
billingType (string) - Whether this plugin is inclusive with the installation or billed as a bolt-on.
createDatetime (string) - Date and time when the Integration config was created.
updateDatetime (string) - Date and time when the Integration config was last updated.
integrationStatus (int) - Infinity integration status code indicating status of an object (E.g. 200).
includePiiData (flag) - Tells whether the integration should send personally identifiable information (PII). If not included, phone numbers, IP addresses will be anonymised and host/whois data will be hidden.

Integration Criteria Fields

Integration criteria fields may be any of those defined in the trigger reports (see Field Definitions), except for the following fields:

attribution… - None of the attribution fields are suitable for criteria.

and with the additional following fields:

touchPoint (int) - Will be set to 1 if the trigger is classified as a touch point (land, call or goal). This is suitable for use with the bool operand.

Integration Custom Variable Fields

Some of our third party integrations support the use of custom variables to send extra information for each event.

For example you may be able to send the ring time of a call, or the name of the DGRP that the call came from, as a custom field. Any integration that supports custom variables will be detailed in the Plugin Specific Properties section.

Custom Variable Configuration (customVarConfig) consist of three properties:

trigField specifies which trigger field value will be sent for this custom variable (e.g. “ringDuration” or “dgrpName”), see Field Definitions.
type tells the third party system what type of custom variable this is (e.g. “dimension” or “metric”).
ref identifies the custom variable within the third party system (often numeric, e.g. “1” to “20”).

E.g. the following custom variable configuration would tell the integration to send the value of the trigger field bridgeDuration to custom dimension four.

[{"trigField":"bridgeDuration","type":"dimension","ref":"4"}]

Fixed values can be sent by inserting a value prefixed with fixed: in the trigField

[{"trigField":"fixed:1","type":"metric","ref":"3"}]

Integration Status

The following integration status codes may apply to each integration:

200 - active (running as normal)
401 - unauthorised (credentials are no longer valid)
403 - unavailable (credentials are OK but do not give access to the specified account)
410 - deleted
423 - disabled (no longer sending data)

List Integrations

Returns a list of Integrations for an Installation.

Request:

GET /config/v2/igrps/{IGRP SPECIFIER}/integrations

URL Path Params

IGRP SPECIFIER (int) - Installation ID.

GET Params

filter (array) OPTIONAL - One or more filters.
sort (array) OPTIONAL - One or more sorting params.
limit (integer) OPTIONAL - Limit on the result set.
offset (integer) OPTIONAL - Offset of the result set.

Filter Types

The Integrations list may be filtered by any of the returned fields

Sort Types

The Integrations list may be sorted by any of the returned fields

Response:

Returns a list of all Integrations for a given IGRP.

igrp (int) - Installation ID.
segment (int) - Segment ID. If this is non-zero then triggers must belong to this segment to match this integration. Only relevant to “triggen” type integrations.
integrationId (int) - Integration ID.
integrationName (string) - Name of the Integration, must be unique within the IGRP.
integrationDescription (string) - Friendly description of the Integration.
pluginType (string) - Name of the system that uses this plugin, either “triggen” (real-time) or “reportgen” (batched).
pluginName (string) - Name of the plugin this Integration will run.
billingType (string) - Whether this plugin is inclusive with the installation or billed as a bolt-on.
createDatetime (string) - Date and time when the Integration config was created.
updateDatetime (string) - Date and time when the Integration config was last updated.
integrationStatus (int) - Infinity integrationStatus code indicating status of an object (E.g. 200).
criteriaConfig (array) - An array of rules for matching triggers to Integrations.
customVarConfig (array) - An array of custom or infinity variables to be passed to the Integration as custom variables, see Integration Custom Variable Fields.
includePiiData (flag) - If flag is set to 0 personally identifiable information (PII) will be anonymised.

Each plugin has its own additional properties, as described in the per-plugin section at the end.

Response example:

{"igrp":"1","segment":"0","integrationId":"1","integrationName":"Google Analytics","integrationDescription":"Desc for Google Analytics Integration","pluginType":"triggen","pluginName":"gua","billingType":"inclusive","createDatetime":"2013-04-04 14:29:32","updateDatetime":"2014-04-04 14:29:32","integrationStatus":"200","includePiiData":"0","criteriaConfig":[{"field":"act","op":"begins","value":"value"}],"account":"UA-22111111-2","domain":"www.example.com"}
{"igrp":"1","segment":"0","integrationId":"2","integrationName":"Flashtalking","integrationDescription":"Desc for Flashtalking Integration","pluginType":"triggen","pluginName":"flashtalking","billingType":"bolt-on","createDatetime":"2013-04-04 14:29:32","updateDatetime":"2014-04-04 14:29:32","integrationStatus":"200","includePiiData":"0","criteriaConfig":[{"field":"act","op":"begins","value":"value"}],"departmentId":6,"clientId":123456,"spotId":12,"spotGroupId":2}

Read Integration

Read integration details for the specified Integration and IGRP.

Request:

GET /config/v2/igrps/{IGRP SPECIFIER}/integrations/{INTEGRATION SPECIFIER}

URL Path Params

IGRP SPECIFIER (int) - Installation ID.
INTEGRATION SPECIFIER (int) - Integration ID.

Response:

Returns the Integrations requested.

igrp (int) - Installation ID.
segment (int) - Segment ID. If this is non-zero then triggers must belong to this segment to match this integration. Only relevant to “triggen” type integrations.
integrationId (int) - Integration ID.
integrationName (string) - Name of the Integration, must be unique within the IGRP.
integrationDescription (string) - Friendly description of the Integration.
pluginType (string) - Name of the system that uses this plugin, either “triggen” (real-time) or “reportgen” (batched).
pluginName (string) - Name of the plugin this Integration will run.
billingType (string) - Whether this plugin is inclusive with the installation or billed as a bolt-on.
createDatetime (string) - Date and time when the Integration config was created.
updateDatetime (string) - Date and time when the Integration config was last updated.
integrationStatus (int) - Infinity integrationStatus code indicating status of an object (E.g. 200).
criteriaConfig (array) - An array of rules for matching triggers to Integrations.
customVarConfig (array) - An array of custom or infinity variables to be passed to the Integration as custom variables, see Integration Custom Variable Fields.
includePiiData (flag) - If flag is set to 0 personally identifiable information (PII) will be anonymised.

Each plugin has its own additional properties, as described in the per-plugin section at the end.

Response example 1:

{"igrp":"1","segment":"0","integrationId":"1","integrationName":"Google Analytics","integrationDescription":"Desc for Google Analytics Integration","pluginType":"triggen","pluginName":"gua","billingType":"inclusive","createDatetime":"2013-04-04 14:29:32","updateDatetime":"2014-04-04 14:29:32","integrationStatus":"200",,"includePiiData":"0","criteriaConfig":[{"field":"act","op":"begins","value":"value"}],"account":"UA-22111111-2","domain":"www.example.com"}

Response response example 2:

{"igrp":"1","segment":"0","integrationId":"2","integrationName":"Flashtalking","integrationDescription":"Desc for Flashtalking Integration","pluginType":"triggen","pluginName":"flashtalking","billingType":"bolt-on","createDatetime":"2013-04-04 14:29:32","updateDatetime":"2014-04-04 14:29:32","integrationStatus":"200",,"includePiiData":"0","criteriaConfig":[{"field":"act","op":"begins","value":"value"}],"departmentId":6,"clientId":123456,"spotId":12,"spotGroupId":2}

Create Integration

This creates a new Integration for an IGRP.

Request:

POST /config/v2/igrps/{IGRP SPECIFIER}/integrations

URL Path Params

IGRP SPECIFIER (int) - Installation ID.

POST Params

segment (int) - Segment ID. If this is non-zero then triggers must belong to this segment to match this integration. Only relevant to “triggen” type integrations.
integrationName (string) - Name of the Integration, must be unique within the IGRP.
integrationDescription (string) - Friendly description of the Integration.
criteriaConfig (array) - An array of rules for matching triggers to Integrations.
customVarConfig (array) - An array of custom or infinity variables to be passed to the Integration as custom variables, see Integration Custom Variable Fields.
pluginName (string) - Name of the plugin this integration will run.
includePiiData (flag) - PII data can be seen if user has permissions by setting flag to 1. Default value is 0.

Each plugin has its own additional properties, as described in the per-plugin section at the end.

Response:

{"integrationId":"26"}

Update Integration Config

Updates the configuration of an existing Integration.

Request:

POST /config/v2/igrps/{IGRP SPECIFIER}/integrations/{INTEGRATION SPECIFIER}

URL Path Params

IGRP SPECIFIER (int) - Installation ID.
INTEGRATION SPECIFIER (int) - Integration ID.

POST Params

segment (int) - Segment ID. If this is non-zero then triggers must belong to this segment to match this integration. Only relevant to “triggen” type integrations.
integrationName (string) - Name of the Integration, must be unique within the IGRP.
integrationDescription (string) - Friendly description of the Integration.
criteriaConfig (array) - An array of rules for matching triggers to Integrations.
customVarConfig (array) - An array of custom or infinity variables to be passed to the Integration as custom variables, see Integration Custom Variable Fields.
pluginName (string) - Name of the plugin this Integration will run.
integrationStatus (int) - Infinity status code indicating integration status of an object (E.g. 200).
includePiiData (flag) - PII data can be seen if user has permissions by setting flag to 1. Default value is 0.

Each plugin has its own additional properties, as described in the per-plugin section at the end.

Response:

Returns the HTTP 204 (No Content) status code if update successful.

HTTP 204 - NO CONTENT

Delete Integration Config

Deletes the configuration of an existing Integration.

Request:

DELETE /config/v2/igrps/{IGRP SPECIFIER}/integrations/{INTEGRATION SPECIFIER}

URL Path Params

IGRP SPECIFIER (int) - Installation ID.
INTEGRATION SPECIFIER (int) - Integration ID.

Each plugin has its own additional properties, as described in the per-plugin section at the end.

Response:

Returns the HTTP 204 (No Content) status code if deleting successful.

HTTP 204 - NO CONTENT

Plugin Specific Properties

AB Tasty Integration

Sends conversion events from Infinity to your AB Tasty account for inclusion in their reports.

AB Tasty integration requires 1 parameter:

eventName (string) OPTIONAL ON UPDATE - Event Name.

{"igrp":"1","segment":"0","integrationId":"1","integrationName":"ABTasty","integrationDescription":"Desc for ABTasty Integration","integrationStatus":"200","includePiiData":"0","pluginType":"triggen","pluginName":"abTasty","billingType":"bolt-on","criteriaConfig":[{"field":"act","op":"eq","value":"call"}],"eventName":"Event name"}

Adobe Analytics Integration

Sends Infinity data to your Adobe Analytics Account (via a FTP server), for inclusion in their reports.

Adobe FTP integration requires 3 parameters:

ftpUser (string) OPTIONAL ON UPDATE - The FTP username
ftpPass (string) OPTIONAL ON UPDATE - The FTP password
ftpHost (string) OPTIONAL ON UPDATE - The FTP hostname

You can find more informations on the official documentation of Adobe Analytics: https://marketing.adobe.com/resources/help/en_US/sc/datasources/adobe_analytics_data_sources.pdf

Adobe Analytics supports custom variables with types of “evar” (data dimensions) and “event” (data metrics). See Integration Custom Variable Fields.

{"igrp":"1","segment":"0","integrationId":"2","integrationName":"AdobeFtp","integrationDescription":"Adobe Integration","pluginType":"reportgen","pluginName":"adobeFtp","billingType":"inclusive","updateDatetime":"2014-04-08 15:31:32","status":"200","criteriaConfig":[{"field":"act","op":"in","value":"call"}],"customVarConfig":[{"trigField":"fixed:1","type":"event","ref":"402"},{"trigField":"dgrpName","type":"evar","ref":"8"}]}

Affiliate Window Integration

Allows you to send conversion data to Affiliate Window using their server-to-server request method.

Affiliate Window requires 3 parameters:

merchant (string) - Merchant reference.
commissionGroupCode (string) OPTIONAL - The commission group you want to attribute the transaction to.
valueField (string) OPTIONAL - The value we send to Affiliate Window. This can be “default”, “txv” or “goalValue”, default is “default”, which sends a fixed value of “1” regardless of the trigger properties.
testMode (int) OPTIONAL - The test mode flag, the value can either be 1 or 0, default value is 0.

{"igrp":"1","segment":"0","integrationId":"102","integrationName":"Afilliate Window","integrationDescription":"Affiliate Window","pluginType":"triggen","pluginName":"affiliateWindow","billingType":"bolt-on",
"updateDatetime":"2014-11-28 11:26:23", "integrationStatus":"200","criteriaConfig":[{"field":"act","op":"eq","value":"value"}],
"merchant":"test merchant", "commCode":"test code","valueField":"goalValue","testMode":0}

Bing Ads Integration

Allows you to send conversion data to Bing Ads using their server-to-server request method.

You must first define an “upload” conversion type within your account, then choose which Infinity data to send.

Bing Ads Offline Conversion integration requires 4 parameters:

accountRef (string) OPTIONAL ON UPDATE - Account reference, obtained from List Available Accounts.
conversionTypeRef (string) OPTIONAL ON UPDATE - Conversion type reference, obtained from List Conversion Types.
valueField (string) OPTIONAL ON UPDATE - The value we send to Bing Ads. This can be “txv”, “goalValue” or “”.
authSessionKey (string) OPTIONAL ON UPDATE - Your bingAds oauth2 credential, to authorise Infinity to push data to your bing Ads account.

See Create oAuth2 Session to check how to get an authSessionKey.

These properties are required to create a Bing Ads Integration. The following section represents returned response in read and list routes.

{"igrp":"1","segment":"0","integrationId":"760","integrationName":"Bing Ads Test","integrationDescription":"Bing Ads Test","integrationStatus":"200","pluginType":"triggen","pluginName":"bingAdsConversionUpload","billingType":"inclusive","createDatetime":"2017-11-07 11:03:34","updateDatetime":"2017-12-01 12:06:17","criteriaConfig":[{"field":"act","op":"eq","value":"call"}],"accountRef":"6102453296","accountName":"Dev Team Test","conversionTypeRef":"185301724","conversionTypeName":"Infinity Call Test","valueField":"txv"}

Call Alerts Integration

Allows you to set up email alerts for calls, missed calls, voicemail, etc.

This integration sends an email to the given recipient whenever a matching call ends. You may choose to attach a copy of the call recording, if one is available.

Call Alerts integration requires 3 parameters:

recipient (string) - Recipient email address.
template (string) - Template to use, currently “Call” and “HubCall” are only available options.
attachCallRecording (int) OPTIONAL - Whether to include call recoding. Use value 1 to enable.

These parameters are required to create a Call Alerts Integration and are returned in read and list routes.

{"igrp":"1","segment":"0","integrationId":"2","integrationName":"Voicemail","integrationDescription":"Sales Voicemail","pluginType":"triggen","pluginName":"callAlert","billingType":"inclusive","updateDatetime":"2014-04-08 15:31:32","integrationStatus":"200","criteriaConfig":[{"field":"voicemail","op":"eq","value":"sales"}],"recipient":"user1@testemail.com","template":"Call"}

Call Out URL Integration

Sends data to the URL specified in the Integration.

Call Out URL integration requires 1 parameter.

url (string) - URL to send the data to.

Call Out URL supports custom variables with types of “map”. See Integration Custom Variable Fields

{"igrp":"1","segment":"0","integrationId":"377","integrationName":"test integration","integrationDescription":"Test Desc","pluginType":"triggen","pluginName":"callOutUrl","billingType":"inclusive","updateDatetime":"2015-03-06 08:52:42","integrationStatus":"200","criteriaConfig":[{"field":"call","op":"eq","value":"call"}],"url":"http:\/\/www.example.com","customVarConfig":[{"trigField":"txr","type":"map","ref":"extTxr"}]}

Criteo Integration

Sends conversion events from Infinity to Criteo for inclusion in their reports.

Criteo integration requires 2 parameters:

accountRef (string) OPTIONAL ON UPDATE - Your Account/Partner ID.
valueField (string) OPTIONAL ON UPDATE - The value we send to Criteo. This can be “txv”, “goalValue” or “”.

{"igrp":"2","segment":"0","integrationId":"1170","integrationName":"Criteo","integrationDescription":"Criteo Integration","integrationStatus":"200","includePiiData":"0","pluginType":"triggen","pluginName":"criteo","billingType":"bolt-on","createDatetime":"2018-09-21 13:29:41","updateDatetime":"2018-09-24 10:39:23","criteriaConfig":[{"field":"act","op":"eq","value":"call"}],"accountRef":"12345","valueField":"txv"}

Google Campaign Manager Offline Conversion Integration

Sends Infinity data into Google Campaign Manager, for reporting on post impression and post click data.

Google Campaign Manager offline conversion integration requires 4 parameters:

profileId (string) - Google Campaign Manager profile ID.
advertiserId (string) - Google Campaign Manager advertiser ID.
floodlightActivityId (string) - Floodlight activity ID.
valueField (string) - The value to send to Google Campaign Manager can be txv, goalValue or an empty string.

These properties are required to create a Google Campaign Manager Integration and these are returned in read and list routes.

Google Campaign Manager offline conversion supports custom variables with types of “map”. See Integration Custom Variable Fields

{"igrp":"1","segment":"0","integrationId":"283","integrationName":"Google Campaign Manager test With Multiple Custom Vars","integrationDescription":"Test","integrationStatus":"200","includePiiData":"0","pluginType":"triggen","pluginName":"dcmConversionUpload","billingType":"bolt-on","criteriaConfig":[{"field":"act","op":"eq","value":"call"}],"customVarConfig":[{"trigField":"bridgeDuration","type":"map","ref":"1"},{"trigField":"dgrpName","type":"map","ref":"2"}],"profileId":"1","profileName":"Test","advertiserId":"1","advertiserName":"test","floodlightConfigurationId":"1","floodlightActivityId":"1","floodlightActivityName":"test","valueField":"txv"}

Search Ads 360 Integration

Sends Infinity data to Search Ads 360 for inclusion in their reports.

Note that no account ID is required as we use Google’s click IDs to send data. The appropriate account ID is extracted by Google from their click ID.

Search Ads 360 integration accepts 3 parameters:

floodlightName (string) OPTIONAL - Floodlight activity name.
floodlightType (string) OPTIONAL - Floodlight activity type, the allowed values are ‘ACTION’ and ‘TRANSACTION’.
authSessionKey (string) - Your Search Ads 360 oauth2 credential, to authorise Infinity to push data to your Search Ads 360 account.

Note that both the floodlightName and floodlightType values should be supplied, or both should be empty. Also, the floodlight name and type combination should match the settings in Search Ads 360 account.

See Create oAuth2 Session to check how to get an authSessionKey.

These parameters are required to create a Search Ads 360 Integration. floodlightName and floodlightType are returned in read and list routes. authSessionKey is write-only and will not be returned in list or read views.

{"igrp":"1","segment":"0","integrationId":"1","integrationName":"Search Ads 360","integrationDescription":"Search Ads 360 Search","integrationStatus":"200","pluginType":"triggen","pluginName":"doubleClickSearch","billingType":"bolt-on","createDatetime":"2017-09-28 07:49:45","updateDatetime":"2017-12-06 15:39:02","criteriaConfig":[{"field":"act","op":"eq","value":"call"}],"floodlightName":"effort","floodlightType":"ACTION"}

Flashtalking Integration

Sends data to Flashtalking for inclusion in their reports.

Flashtalking integration requires 4 parameters. These can be obtained from your Flashtalking account manager.

departmentId (int) - Department ID, used to split Flashtalking customers into different regions or for some larger clients.
clientId (int) - ID given to each customer by Flashtalking..
spotId (int) - Unique ID given to Flashtalking regarding the placement of the ad.
spotGroupId (int) - ID given to a group of ads served by Flashtalking.
valueField (string) OPTIONAL - The value we send to Flashtalking. This can be “txv” or “goalValue”, default is “txv”.

These properties are required to create a Flashtalking Integration and these are returned in read and list routes.

Flashtalking supports custom variables with types of “map”. See Integration Custom Variable Fields

{"igrp":"1","segment":"0","integrationId":"4","integrationName":"Flashtalking","integrationDescription":"Desc for Flashtalking Integration","pluginType":"triggen","pluginName":"flashtalking","billingType":"bolt-on","updateDatetime":"2015-01-20 16:11:26","integrationStatus":"200","criteriaConfig":[{"field":"act","op":"eq","value":"call"}],"customVarConfig":[{"trigField":"dgrpName","type":"map","ref":"1"}],"departmentId":6,"clientId":123456,"spotId":12,"spotGroupId":2,"valueField":"txv"}

Google Ads Offline Conversion Integration

Sends Infinity data directly to your Google Ads account, for inclusion in Google Ads reports.

You must first define an “upload” conversion type within your account, then choose which Infinity data to send.

Google Ads Offline Conversion integration requires 2 parameters:

accountRef (string) - Account reference, obtained from List Available Accounts.
conversionTypeRef (string) - Conversion type reference, obtained from List Conversion Types.

These properties are required to create an Adwords Integration and these are returned in read and list routes.

{"igrp":"1","segment":"0","integrationId":"6","integrationName":"AdWords Calls","integrationDescription":"Send calls to AdWords","pluginType":"triggen","pluginName":"adwordsConversionUpload","billingType":"inclusive","updateDatetime":"2014-04-22 15:44:05","integrationStatus":"200","criteriaConfig":[{"field":"act","op":"eq","value":"call"}],"accountRef":"1234567890","conversionType":{"ref":"12345678","name":"Infinity Call"}}
{"igrp":"1","segment":"0","integrationId":"7","integrationName":"AdWords Sales","integrationDescription":"Send offline sales to AdWords","pluginType":"triggen","pluginName":"adwordsConversionUpload","billingType":"inclusive","updateDatetime":"2014-04-22 15:44:05","integrationStatus":"200","criteriaConfig":[{"field":"act","op":"eq","value":"sale"}],"accountRef":"1234567890","accountName":"Infinity Tracking", "conversionType":{"ref":"11223344","name":"Infinity Sale"},"conversionTypeRef":"11223344","conversionTypeName":"Infinity Sale"}

Google Universal Analytics Integration

Sends Infinity data to your Universal Analytics account, for inclusion in their reports.

GUA integration requires 5 parameters:

account (string) - GUA account number.
eventValue (string) OPTIONAL - Name of trigger field used for the event value, either “callDuration”, “bridgeDuration”. Default “” leaves event value empty.
valueField (string) OPTIONAL - The e-commerce Transaction Revenue value we send to GUA. This can be “txv”, “goalValue” or “”. Default “” leaves this empty, and no transaction or item hits are sent with the event.
enhancedValueField (string) OPTIONAL - The value we send to GUA for the enhanced e-commerce Product Price field. This can be ‘txr’, ‘rowId’, ‘txv’, ‘value’, ‘goalValue’, ‘txc’ and ‘goalCurrency’.
enhanced (string) OPTIONAL - A list of enhanced e-commerce parameters to send, see below for examples. Setting to empty will not stop the value being sent with the event.
geoOverride (flag) OPTIONAL - Indicates whether geoid should be overridden or not. In case if it is overridden, geoid value would be taken as user’s country. If trigger without user or user have no country, value would be 0000000, which means location “not set”.

The enhanced parameter may contain a list of enhanced e-commerce parameters as documented in https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters#enhanced-ecomm.

We support only the following list of parameters:

pr1id (Product SKU);
pr1nm (Product Name);
pr1br (Product Brand);
pr1ca (Product Category);
pr1va (Product Variant);
pr1pr (Product Price);
pr1qt (Product Quantity),
pr1cc (Product Coupon Code);
pr1ps (Product Position);
pa (Product Action);
ta (Affiliation);
tt (Tax);
ts (Shipping);
tcc (Coupon Code);
pal (Product Action List);
cos (Checkout Step);
col (Checkout Step Option).

Note that the enhanced e-commerce parameter for Revenue is determined by the enhancedValueField setting, and Transaction ID is determined by the transaction reference (txr) in Infinity.

You can find more informations on the official documentation of google analytics: https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters#enhanced-ecomm

These parameters are required to create a GUA Integration and these are returned in read and list routes.

GUA supports custom variables with types of “dimension”, “metric”, “productDimension” and “productMetric”. See Integration Custom Variable Fields.

{"igrp":"1","segment":"0","integrationId":"2","integrationName":"GUA","integrationDescription":"GUA Integration","pluginType":"triggen","pluginName":"gua","billingType":"inclusive","updateDatetime":"2014-04-08 15:31:32","integrationStatus":"200","criteriaConfig":[{"field":"act","op":"in","value":"call,sale"}],"customVarConfig":[{"trigField":"bridgeDuration","type":"dimension","ref":"4"},{"trigField":"c_customVarName","type":"dimension","ref":"6"},{"trigField":"c_customMetric","type":"metric","ref":"8"}],"account":"MO-12345678-2","eventValue":"callDuration"}

Kenshoo FTP Integration

Sends Infinity call data daily to Kenshoo via FTP for inclusion in their reports. Note that this integration only supports sending calls, and not e.g. offline CRM events.

Kenshoo FTP integration requires 5 parameters:

nextRunDatetime (datetime) - The next time (UTC) to schedule this report to run.
profileName (string) - The profile name in Kenshoo that the file should be uploaded to.
authUsername (string) - The FTP username to connect with.
authPassword (string) - The FTP password to connect with.

If the nextRunDatetime is in the past, the report will be dispatched almost immediately, and as many times as necessary to catch up with the current date, incremented by one day.

The authUsername and authPassword are write-only. They will not be returned in list or read views.

{"igrp":"1","segment":"0","integrationId":"8","integrationName":"Kenshoo","integrationDescription":"Send calls to Kenshoo","pluginType":"reportgen","pluginName":"kenshooFtp","billingType":"bolt-on","updateDatetime":"2014-04-04 14:29:32","integrationStatus":"200","criteriaConfig":[],"nextRunDatetime":"2014-04-05 04:00:00","profileName":"My_Company"}

Marin FTP Integration

Sends Infinity call data daily to Marin via FTP for inclusion in their reports.

Marin FTP integration require 10 parameters:

nextRunDatetime (datetime) - The next time (UTC) to schedule this report to run.
attributionParam (string) - Whether to search for lands containing the Marin tracking parameter ‘mkwid’ or ‘mckv’
goalMap (array) - A map of Infinity goal IDs to Marin conversion type codes
clientRef (string) - Marin’s identifier for the client we’re uploading to
trackerRef (string) - Marin’s tracker ID reference for the client
password (string) - The FTP password for the client’s account on Marin
dateMode (string) OPTIONAL - Whether to report by date of ‘click’ or date of ‘conversion’. Default: click
attributionMode (string) OPTIONAL - Marin’s ‘first’ or ‘last’ click mode. Default: last
lookbackDays (int) OPTIONAL - How many days to look back for attribution. Default: 30

If the nextRunDatetime is in the past, the report will be dispatched almost immediately, and as many times as necessary to catch up with the current date, incremented by one day.

The password field is write-only and will not be returned in list or read views.

{"igrp":"1","segment":"0","integrationId":"9","integrationName":"Marin","integrationDescription":"Send goal data to Marin","pluginType":"reportgen","pluginName":"marinFtp","billingType":"bolt-on","updateDatetime":"2014-07-17 12:32:47","integrationStatus":"200","criteriaConfig":[],"nextRunDatetime":"2014-07-18 05:00:00","profileName":"My_Company","dateMode":"click","attributionMode":"last","lookbackDays":30,"attributionParam":"mkwid","goalMap":{1:"callsale",2:"calllead"},"trackerRef":"xxxxxx"}

Optimizely Integration

Sends conversion events from Infinity to your Optimizely account for inclusion in their reports.

Optimizely integration requires 3 parameters:

projectRef (string) - Your Optimizely project ID.
eventName (string) - The name of the conversion event you wish to send to Optimizely.
valueField (string) OPTIONAL - The value we send to Optimizely. This can be “txv” or “goalValue”, default is “txv”.

{"igrp":"1","segment":"0","integrationId":"876","integrationName":"Optimizely","integrationDescription":"Desc for Optimizely Integration","pluginType":"triggen","pluginName":"optimizely","billingType":"bolt-on","updateDatetime":"2014-11-17 15:52:07","integrationStatus":"200","criteriaConfig":[{"field":"act","op":"eq","value":"call"}],"projectRef":"123456","eventName":"Infinity Call","valueField":"txv"}

OptimizelyX Integration

Sends conversion events from Infinity to your OptimizelyX account for inclusion in their reports.

OptimizelyX integration requires 3 parameters:

projectRef (string) OPTIONAL ON UPDATE - Your OptimizelyX project ID.
eventRef (string) OPTIONAL ON UPDATE - Event ID of the conversion you wish to send to OptimizelyX.
valueField (string) OPTIONAL ON UPDATE - The value we send to OptimizelyX. This can be empty (not sent),“txv” or “goalValue”.

{"igrp":"1","segment":"0","integrationId":"984","integrationName":"OptimizelyX","integrationDescription":"Desc for OptimizelyX Integration","integrationStatus":"200","includePiiData":"0","pluginType":"triggen","pluginName":"optimizelyX","billingType":"bolt-on","createDatetime":"2018-07-26 13:19:05","updateDatetime":"2018-07-31 16:07:31","criteriaConfig":[{"field":"act","op":"eq","value":"call"}],"projectRef":"123456","accountRef":"123456","eventRef":"11100000","valueField":"txv"}

Outbrain Integration

Sends conversion events from Infinity to your Outbrain account for inclusion in their reports.

Outbrain integration requires 2 parameters:

marketerRef (string) OPTIONAL ON UPDATE - Your Outbrain Marketer ID.
eventName (string) OPTIONAL ON UPDATE - Event Name.

{"igrp":"1","segment":"0","integrationId":"1","integrationName":"Outbrain","integrationDescription":"Desc for Outbrain Integration","integrationStatus":"200","includePiiData":"0","pluginType":"triggen","pluginName":"outbrain","billingType":"bolt-on","criteriaConfig":[{"field":"act","op":"eq","value":"call"}],"marketerRef":"Marketer ID","eventName":"Event name"}

Partnerize Integration

Sends conversion events from Infinity to Partnerize for inclusion in their reports.

Partnerize integration requires 3 parameters:

campaign (string) OPTIONAL ON UPDATE - The campaign ID that Infinity events are sent to
category (string) OPTIONAL ON UPDATE - The category / product type to report against in Partnerize
valueField (string) OPTIONAL ON UPDATE - The value that Infinity sends to Partnerize. This can be “txv”, “goalValue” or “”.

{"igrp":"2","segment":"0","integrationId":"1170","integrationName":"Partnerize","integrationDescription":"Partnerize Integration","integrationStatus":"200","includePiiData":"0","pluginType":"triggen","pluginName":"partnerize","billingType":"bolt-on","createDatetime":"2018-09-21 13:29:41","updateDatetime":"2018-09-24 10:39:23","criteriaConfig":[{"field":"act","op":"eq","value":"call"}],"campaign":"10|1234","category":"My product type","valueField":"txv"}

Qubit Integration

Sends Infinity data to your Qubit account, for inclusion in their reports.

Qubit integration requires 1 parameter:

qubitTrackingId (string) - Your Qubit account ID.
eventAction (string) - The event action you wish to send to Qubit.

{"igrp":"1","segment":"0","integrationId":"876","integrationName":"Qubit","integrationDescription":"Desc
for Qubit Integration","pluginType":"triggen","pluginName":"qubit","billingType":"bolt-on","updateDatetime":"2014-11-1715:52:07","integrationStatus":"200","criteriaConfig":[{"field":"act","op":"eq","value":"call"}],"qubitTrackingId":"some_tracking_id","eventAction":"InfinityCall"}

Qubit 2016 Integration

Sends Infinity data to your Qubit account, for inclusion in their reports.

Qubit 2016 integration requires 3 parameters in addition to the standard ones like: name, description, criteria, etc.

trackingId (string) - Your Qubit account ID.
eventType (string) - The type of event to send to Qubit, based on your account’s assigned vertical. Please contact your Qubit account manager if you are unsure what this is. Possible values are: “ecommerce”, “egaming”, “publishing”, “logistics”, “travel” or “finance”.
valueField (string) - This can be empty (not sent), “txv” or “goalValue”, default is empty (not sent).

{"igrp":"1","segment":"0","integrationId":"1","integrationName":"Qubit2016","integrationDescription":"Qubit2016","pluginType":"triggen","pluginName":"qubit2016","billingType":"bolt-on","createDatetime":"2016-10-26 10:10:16","updateDatetime":"2016-10-26 10:10:16","integrationStatus":"200","criteriaConfig":[{"field":"act","op":"eq","value":"call"}],"trackingId":"Qubit2016Test","eventType":"egaming","valueField":"txv"}

Salesforce Caller Insight Integration

Sends Touch point data (lands, calls and goals) to the touch point object and calls to the activity object in your Salesforce Org.

Salesforce Caller Insight integration requires 1 parameter:

authSessionKey (string) - Your Salesforce oauth2 credential, to authorise the Salesforce Caller Insight app to access your Org.

authSessionKey property is required to create a Salesforce Caller Insight integration. It is write-only and will not be returned in list or read views. See Create oAuth2 Session to check how to get an authSessionKey.

Below are the additional fields that are extracted from the auth session key.

sfOrgRef (string) - Salesforce Organisation ID.
sfUserRef (string) - Salesforce User ID.
loginUrl (string) - Salesforce Login URL.

These fields are not updatable.

{"igrp":"1","segment":"0","integrationId":"3721","integrationName":"SF","integrationDescription":"Desc for SF Integration","pluginType":"triggen","pluginName":"salesforceCallerInsight","billingType":"bolt-on","updateDatetime":"2014-07-30 09:48:08","integrationStatus":"200","criteriaConfig":[{'field' => 'touchPoint', 'op' => 'bool', 'value' => 'true'}],"sfOrgRef":"00Dxxxxxxxxxxxxxxx","sfUserRef":"005xxxxxxxxxxxxxxx","loginUrl":"https:\/\/login.salesforce.com"}

Quantcast Integration

Sends Infinity data to your Quantcast account for inclusion in their reports.

Quantcast integration requires 2 parameters:

accountRef (string) - Your Quantcast account ID or “p code”, must begin with “p-“, e.g. “p-ABC123”.
valueField (string) OPTIONAL - The value we send to Quantcast. This can be empty (not sent), “txv” or “goalValue”, default is empty (not sent).

{"igrp":"1","segment":"0","integrationId":"876","integrationName":"Quantcast","integrationDescription":"Desc for Quantcast Integration","pluginType":"triggen","pluginName":"quantcast","billingType":"bolt-on","updateDatetime":"2014-11-17 15:52:07","integrationStatus":"200","criteriaConfig":[{"field":"act","op":"eq","value":"call"}],"accountRef":"p-ABC123"}

Visual Website Optimizer Integration

Sends Infinity data to your Visual Website Optimizer account for inclusion in their data.

Visual Website Optimizer Integration integration requires 2 parameters:

accountRef (int) - Your VWO account ID.
goalRef (int) - The VWO goal you wish to trigger.

These properties are required to create a Visual Website Optimizer Integration and are returned in read and list routes.

{"igrp":"1","segment":"0","integrationId":"3916","integrationName":"vwo","integrationDescription":"Desc for VWO Integration","pluginType":"triggen","pluginName":"visualWebsiteOptimizer","billingType":"bolt-on","updateDatetime":"2014-10-03 09:30:01","integrationStatus":"200","criteriaConfig":[{"field":"act","op":"eq","value":"call"}],"accountRef":123456,"goalRef":1}

Webgains Integration

Sends Infinity data to your Webgains account for inclusion in their reports.

Webgains integration requires 4 parameters:

programId (string) - ID given to each customer by Webgains.
eventId (int) - ID that determines the type of the Webgains transaction.
valueField (string) OPTIONAL - The value we send to Webgains. This can be “txv” or “goalValue”, default is “txv”.
apiKey (string) OPTIONAL ON UPDATE - API key generated in the Webgains account, Infinity IP range should be white-listed for the key. This field is write-only (the API key is encrypted in storage), optional on update but required when creating a new integration.

{"igrp":"1","segment":"0","integrationId":"3825","integrationName":"Webgains","integrationDescription":"Webgains Bronze","pluginType":"triggen","pluginName":"webgains","billingType":"bolt-on","updateDatetime":"2014-09-18 10:22:14","integrationStatus":"200","criteriaConfig":[{"field":"callDuration","op":"gt","value":"3"},{"field":"callDuration","op":"le","value":"5"}],"eventId":11111,"programId":"1111","valueField":"txv"}

Webtrends Integration

Sends Infinity data to your Webtrends account for inclusion in their reports.

Webtrends integration requires 1 parameter:

dataSourceRef (string) - Your Webtrends data source ID (DCSID).

This property is required to create a Webtrends Integration and it is returned in read and list routes.

{"igrp":"1","segment":"0","integrationId":"18","integrationName":"Webtrends","integrationDescription":"Desc for Webtrends Integration","pluginType":"triggen","pluginName":"webtrends","billingType":"bolt-on","updateDatetime":"2014-04-04 14:29:32","integrationStatus":"200","criteriaConfig":[{"field":"act","op":"eq","value":"call"}],"dataSourceRef":"dcsxxxxxxxxxxxxxxxxxxxxx_xxxx"}

Integration Helpers

Google Campaign Manager Offline Conversion API calls

Google Campaign Manager service allows advertisers to provide information about the offline portion of conversions to Campaign Manager.

List Profiles

Retrieves a list of user profiles for a user. https://developers.google.com/doubleclick-advertisers/v2.8/userProfiles/list

Request:

GET /config/v2/igrps/{IGRP SPECIFIER}/integrations/dcm/profiles

URL Path Params

IGRP SPECIFIER (int) - Installation ID.

GET Params

authSessionKey (string) - The Google Campaign Manager Offline Conversion API authorise session key.

Response:

Returns a list of profiles with their associated account name.

profileId (integer) - The unique identifier for the Profile.
accountName (string) - The name of the Account.

{"profileId":1,"accountName":"Account First"}
{"profileId":2,"accountName":"Account Second"}

List Advertisers

Retrieves a list of advertisers. https://developers.google.com/doubleclick-advertisers/v2.8/advertisers/list

Request:

GET /config/v2/igrps/{IGRP SPECIFIER}/integrations/dcm/profiles/{profileId}/advertisers

URL Path Params

IGRP SPECIFIER (int) - Installation ID.
profileId (integer) - Google Campaign Manager Offline Conversion Profile ID (int).

GET Params

authSessionKey (string) - The Google Campaign Manager Offline Conversion API authorise session key.

Response:

Returns a list of advertisers.

id (integer) - The unique identifier for the Advertiser.
name (string) - The name of the Advertiser.

{"id":1,"name":"Advertiser First"}
{"id":2,"name":"Advertiser Second"}

List Floodlight Activities

Retrieves a list of floodlight activities. https://developers.google.com/doubleclick-advertisers/v2.8/floodlightActivities/list

Request:

GET /config/v2/igrps/{IGRP SPECIFIER}/integrations/dcm/profiles/{profileId}/advertisers/{advertiserId}/floodlightActivities

URL Path Params

IGRP SPECIFIER (int) - Installation ID.
profileId (integer) - Google Campaign Manager Offline Conversion Profile ID (int).
advertiserId (integer) - Google Campaign Manager Offline Conversion Advertiser ID (int).

GET Params

authSessionKey (string) - The Google Campaign Manager Offline Conversion API authorise session key.

Response:

Returns a list of profiles with their associated account name.

id (integer) - The unique identifier for the Floodlight Activities.
name (string) - The name of the the Floodlight Activities.
hidden (int) - The flag to indicate if the Floodlight Activities is hidden.

{"id":1,"name":"Activity First","hidden":1}
{"id":2,"name":"Activity Second","hidden":0}

OptimizelyX API calls

OptimizelyX is the experimentation platform of Optimizely service.

List Projects

Returns a list of projects with their associated account from the OptimizelyX REST API. https://developers.optimizely.com/x/rest/v2/#projects

Request:

GET /v2/integrations/optimizelyX/projects

GET Params

authSessionKey (string) - The OptimizelyX API authorise session key.

Response:

Returns a list of projects with their associated account.

projectId (integer) - The unique identifier for the Project.
projectName (string) - The name of the Project.
accountId (integer) - The account the Project is associated with.

{"projectId":1,"projectName":"Project first","accountId":1}
{"projectId":2,"projectName":"Project second","accountId":1}

List Events

Returns a list of events for a specific project ID from the OptimizelyX REST API. https://developers.optimizely.com/x/rest/v2/#events

Request:

GET /v2/integrations/optimizelyX/projects/{projectId}/listEvents

URL Path Params

projectId (integer) - The ID of the Project all Events will be listed for.

GET Params

authSessionKey (string) - The OptimizelyX API authorise session key.

Response:

Returns a list of events for a specific project.

eventId (integer) - The unique identifier of the Event.
eventName (string) - A human readable name for this Event.

{"eventId":1,"eventName":"Homepage"}
{"eventId":2,"eventName":"Contacts"}