Subtags

Overview

Subtags dynamically add Enhanced Data into the responses. This is handled by using curly brackets {}.

For example, you could add a CUID (customer unique ID) stored in the ixkio platform dynamically onto a URL by including {CUID} within your redirect response.

So, if your CUID for Tag Code was 12345, a URL entered as :

https://seritag.com?code={CUID}

would become :

https://seritag.com?code=12345

Using Subtags

Subtags can generally be used anywhere you enter data. For example, you can include a Subtag into a URL Redirect, or a Tag Name, or even another Extended Data field !

At the point that ixkio presents that data, it will automatically substitute the content of the Subtag.

You can find which subtags can be used in which locations by reading the documents related to the element you are editing. However, example subtags include :

SubtagData Substituted

{xuid}

The Tag Code XUID

{cuid}

The CUID for that Tag Code

{uid}

The UID for that Tag Code

{scount}

The ixkio scan count

{ccount}

The chip scan count (if enabled)

{folder}

The Folder name

{batch}

The Batch name

{taggroup}

The Tag Group name

{tagname}

The Tag name

{cluster}

Cluster name Flex Alpha

{countrycode}

Two letter country code of the scan location

{dtcreated}

Date and time the Tag Code was created

{dtassigned}

Date and time Tag Code was Assigned

{timezone}

Abbreviated timezone (PST, GMT, WET, etc)

{currency}

Three letter currency code (GBP, USD, EUR, etc)

{tzlocal}

Local date and time (based on IP, not device)

{randnum}

Random number

{browser}

Device browser (mobile devices only)

{method}

Scan method (nfc,qr) (if using QR URL)

{randhex}

Random hexadecimal

{os}

Device OS (ios, android, other)

{nft_status}

NFT authentication (pass,fail) Flex Alpha

{nft_xowner}

NFT owner returned from NFT Flex Alpha

{nft_owner}

NFT owner as set in ixkio Flex Alpha

{nft_contract}

NFT contract address in ikxio Flex Alpha

{nft_token}

NFT token in ikxio Flex Alpha

{nft_chain}

NFT blockchain set in ikxio Flex Alpha

{nft_meta}

NFT metadata returned from NFT Flex Alpha

Subtags For Redirects

Subtags can be added directly to your Redirect URL (both the Default Response and any RuleGroup Responses). For example, if you wanted to add the scan count into your redirect URL, you would enter :

https://seritag.com/somepage?scancount={scount}

would become :

https://seritag.com/somepage?scancount=12345

(Seritag.com is just being used as an example domain)

You can also use it directly into the URL. So, for example you could use a subtag to dynamically add a Custom ID (CUID) into a URL to change the page name. For example, assuming your CUID for a tag was 'beach' :

https://seritag.com/{cuid}-property

would become :

https://seritag.com/beach-property

Subtags for API

Flex Pro Flex Alpha

Subtags in the Response

Subtags can be used with Ruleset API Responses - both the Default Response and with any RuleGroup Responses. For example, if you wanted to add the scan count into the API response, you can set the Ruleset API Response as :

Pass-Count:{scount}

would become :

{
	"xuid": "q8w3sbcz",
	"response": "Pass-Count:5"
}

(Assuming that your request was for Tag Code q8w3sbcz and the scan count was at 5)

All Action Data subtags are not available on the API as ixkio will not know the browser/IP/device of the user actually scanning the tag.

Subtags in Extended Data

If you do not want to put Subtags into the Ruleset Responses or want data to be separated into other fields, it is possible to include Subtags within Extended Data fields.

For a step by step on how to do this, read the Subtags in Extended Data documents.

Subtags for NFT

Flex Alpha

If you have entered complete NFT data for a Tag Code, it's possible to retrieve information regarding the NFT directly in the response using Subtags.

{nft_status}

This will check the NFT owner for the NFT as entered into ixkio against live NFT data on your chosen blockchain. If the owner as recorded in ixkio matches that on the NFT, then the subtag will be replace with either 'pass' or 'fail'.

{nft_xowner}

This will return the NFT owner as given by a live check on the NFT (not the owner as entered into ixkio).

{nft_owner}, {nft_chain},{nft_contract},{nft_token}

This will return the NFT data as set in ikxio.

{nft_meta}

Will return the NFT metadata. This Subtag will only work in API Response mode, in an Extended Data field and where the Extended Data field is of type 'JSON'. Using Subtags in Extended Data fields is detailed in Subtags in Extended Data.

Last updated

Copyright TabDesk Ltd 2023