Datamerge

Overview

Datamerge adds Extended Data onto the Response.

Extended Data is additional data that you have added into ixkio related to your Tag Group or individual Tag Code. You need to create the data fields themselves at the Active Folder level and then set the data for those fields at the Tag Group or Tag Code level. You can find out more about Extended Data here.

Datamerge is useful for passing information stored about the Tag Codes through automatically. In addition, the Datamerge data will follow the Tag Code location so that if a Tag Code is moved to another Tag Group - it can then dynamically show Extended Data associated with the new Tag Group.

You can even add Subtags into your Extended Data fields. So you can create an Extended Data field and then add a Subtag into the field data to combine the two dynamic response methods to create more complex response structures.

Using Datamerge

Using Datamerge varies significantly between the Response Modes.

Redirect Mode

When you are using the Redirect Mode, Datamerge will add Extended Data to the end of your Redirect URL as a query string.

For example, assume you had created an Extended Data field 'Colour' and have set the value of this at the Tag Group (or Tag Data) level as 'Blue'.

Then, navigate to the Active Folder level and Folder Function Panel > Response Tab and change the Append setting of the 'Colour' Data Name to 'Add to Redirect'. You are telling ixkio to add this Extended Data field to the end of your Redirect URL.

This will change your redirect URL from :

https://seritag.com

to :

https://seritag.com?colour=Blue

If you already have a query string in your redirect URL, then Datamerge will add it to the end of this. For example :

https://seritag.com?utm_source=nfc

would become :

https://seritag.com?utm_source=nfc&colour=Blue

Datamerged Extended Data field names (and the Tag Name field) will be converted to lower case and spaces replaced with underscore.

Data associated with the fields will not be converted to lower case but will have spaces converted to underscore.

API Response Mode

Flex Pro Flex Alpha

If you are using the API Response Mode, Datamerge allows you to add your Extended Data fields into the JSON response. For example, assume you had created an Extended Data field 'Colour' and have set the value of this at the Tag Group (or Tag Data) level as 'Blue'.

If you make an API request as usual (in this example to Tag Code q8w3sbcz):

GET https://api.ixkio.com/v1/t?x=q8w3sbcz

The API will return a JSON response in the format :

{
	"xuid": "q8w3sbcz",
	"response": "Found",
	"Colour": "Blue"
}

(This example also assumes you have also set up an API Response of 'Found'.)

Datamerge responses are not included in API error responses. If your API request returns an error, it will not include the Extended Data fields.

Extended Data fields with the 'Date' type are not currently included in the API Response

Last updated

Copyright TabDesk Ltd 2024