Appending Client Tags for Reporting & Attribution

This page has instructions for appending your own Client Tags to leads coming through Engine's marketplace.

Hosted Integrations

How to Structure Client Tags

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

Partner Page Format

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

Embed Format (Credit Cards)

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

Embed Format (All Other Categories)

data-tags=tag.{key1}={value1}&tag.{key2}={value2}

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

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

In the below examples, tag.clientId=c1 means the lead will be stored with a clientId of "c1", and a source of "email", which can now be provided in reporting.

Partner Page

To add Client Tags in a Partner Page, append the parameters to the end of the {provided_moneylion_url} as follows:

{provided_moneylion_url}?tag.clientId=c1&tag.source=email

*The first Client Tag (or any query parameter) appended at the end of a URL/path should start with a question mark ?; all subsequent parameters should be separated with an ampersand &

Embed (Credit Cards)

<script
        async src="https://www.moneylion.dev/network/{channel}/{zone}/web-component/credit-cards-search/index.js\" 
 ></script>
<moneylion-credit-cards-search 
        tags="tag.clientId=c1&tag.source=email&tag.providedCreditRating=good">
</moneylion-credit-cards-search>

Embed (All Other Categories)

To add Client Tags in an Embed, use the following syntax in the tags attribute on the opening custom moneylion-{some-product} tag as follows (with each key preceded by tag.):

<script 
      async src=\"https://www.moneylion.dev/network/{channel}/{zone}/web-component/generic-offers/index.js\" 
      data-tags=\"tag.clientId=c1&tag.source=email&app.providedCreditRating=good\"
      data-embed-type=\"auto-mount\" 
></script>

*The first Client Tag for Embeds should not include a question mark ?, but every key/value pair of tags must be separated by an ampersand &

Native API Integrations

Client Tags for Native API Integrations can be added by including a clientTags attribute at the top level of the request body, where the value is an array of strings. We strongly recommend only including one element per array for ease of reporting/attribution - if you want two separate tags, include the second tag under a different key. There is no limit to the number of keys in the clientTags object. See the following for an example:

{   
    "personalInformation": {...},
    "financialInformation": {...},
    "clientTags": {
        "clientId": ["client1"],
        "trafficsource": ["email"],
        "campaignId": ["campaign1"]
    }
}

More Information

See the sample request in our API Reference for more info on the request body when posting leads to Engine's API.

See our GET Lead Client Tags endpoint for information on attributing lead analytics to your own client tags

Mobile SDK Integrations

React Native

The Engine Mobile SDK supports adding your unique Client Tags to track performance of specific campaigns or users. All Client Tag data is attributed to the lead level.

Client Tags can be added by including a clientTags attribute at the top level of the request body, where the value is an array of strings. We strongly recommend only including one element per array for ease of reporting/attribution - if you want two separate tags, include the second tag under a different key. There is no limit to the number of keys in the clientTags object.

Example

Here is a sample code snippet of how you might implement the Mobile SDK into your app, with sample clientTags appended:

<EngineSdk
    bearer="{your_token}"
    primaryColor=”#11aa34”
    secondaryColor=”#444444”
    prefilledData={ any data you don't want to ask for again }
    "clientTags": {
        "clientId": ["client1"],
        "trafficsource": ["email"],
        "campaignId": ["campaign1"]
    }
    { ...optional Event Handlers, please see Event Handler section }
/>

See our GET Lead Client Tags endpoint for information on attributing lead analytics to your own client tags, if you decide to hit our Analytics API for reporting.

Flutter

The Engine Flutter SDK supports adding your unique Client Tags to track performance of specific campaigns or users. All Client Tag data is attributed to the lead level.

Client Tags can be added by including a clientTags attribute at the top level of the EngineSDK widget, where the value is a Map<String, List<String>>.

We strongly recommend including only one element per list for ease of reporting and attribution—if you want two separate tags, include the second tag under a different key. There is no limit to the number of keys in the clientTags map

Example:

EngineSDK( 
bearerToken: '{your_token}', 
channel: '{your_channel}', 
zone: '{your_zone}', 
experience: '{your_experience}', 
prefilledData: // ...any data you don't want to ask for again 
clientTags: const { 
'clientId': ['client1'], 
'trafficsource': ['email'], 
'campaignId': ['campaign1'], 
}, 
// ...optional Event Handlers, please see Event Handler section 
)

Note: Client Tags are only sent when both prefilledData and bearerToken are provided.

Supported Client Tag Keys (for any integration type)

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