Adding Client Tags to Reports

Partner Pages and Embeds support adding your unique Client Tags to track performance of specific campaigns or users. All Client Tag data is attributed to the lead level.

How to Structure Client Tags (for Either Hosted Integration Type)

Regardless of the integration type, Client Tags can be added via query parameters at the end of the respective URL in the below format*:

?tag.{key1}={value1}&tag.{key2}={value2}

where the {key} is your general identifier, e.g. "clientId" or "subId," and {value} is the value for that specific individual, e.g. "client1" or "client2."

*The first query parameter appended at the end of a path should be denoted with a question mark (?); all following params should be denoted with an ampersand (&).

Where to Place Client Tags (Different by Hosted Integration Type)

To add a clientId to a Partner Page (with the id as c1), append the param to the end of the URL path as follows:

https://fiona.com/partner/fiona-loans/loans?tag.clientId=c1

To add a clientId to an Embed, append the param to the end of the src string in the <iframe> tag:

<div>
    <script>...</script>
    <iframe class=... src='{provided_url}?tag.clientId=c1'></iframe>
</div>

Supported Client Tag Keys

These are the keys that are currently fully supported. If a different key is needed, please reach out to your partner manager - we may be able to accommodate, but adding nonstandard keys will increase the time it takes Engine to report Client Tag values back to you and is therefore not recommended. Please note that the keys below are case-sensitive.

  • agentId

  • campaignId

  • clientId

  • deviceid

  • medium

  • sourceId

  • subid

  • subid1

  • subid2

  • subid3

  • target

  • trafficsource

  • userid

Last updated