Craft your hit

 

Base

All hits must be sent to a fixed collection address, composed of several items

Information Description Rules Example Comments
Protocol Type of protocol Must be equal to http or https https
Collection log Collection server to which the site is linked logs A log is specific to a protocol
Collection domain Domain on which information is collected Can be equal to .xiti.com or .ati-host.net .xiti.com A log is linked to a specific domain
Resource Resource to request on the server Must be equal to hit.xiti hit.xiti

Example:

All parameters will then be contained in the querystring of this GET request.

 

Global

Certain parameters must be present in all hits in order to ensure accurate tracking of information.

Parameter Description Rules Example Required? Comments
col Protocol version Must be equal to 1 col=1 Yes
from Method of hit generation Must be equal to p from=p Yes
s Site number Must correspond to the site on which the data should be counted s=123456 Yes
idclient Unique visitor ID Must be unique for each visitor idclient=e5c728db-b510-41a3-9de5-117f0321bae4 No Prevents the placement of a third-party cookie
an Identified visitor numerical ID Must be an integer an=1337 No an and at are exclusives : only one can be in a single hit. an has the priority
at Identified visitor textual ID at=p250 No an and at are exclusives : only one can be in a single hit. an has the priority
ac Identified visitor category ID Must be an integer ac=1 No

Example:

 

Page

For a page hit, three pieces of information are possible: its name, its chaptering (up to 3 levels) and its level 2.

The name and the chapter information are given in a p parameter in the following manner:
– if you want to include from one to three chapters, they should be written at the start of the string, separated by two colons (“::”) and the page name can be added at the end, after using this same separator. (We will therefore have the format ::::::).
– otherwise, we only indicate the name

If the p parameter is empty, the page URL will be shown as the page’s name

The level 2 is an ID that we indicate in the s2 parameter. The level 2 must be configured ahead of time in the interface in order to retrieve the corresponding ID.

Parameters Description Restrictions Required?
p <chap1::chap2::chap3::name> 250 characters max. No special characters. Yes
s2 <level 2> Whole number No

Example:

Page view hit from the page page_baking, which belongs to the tree structure home > appliances > kitchen, and which belongs to the level 2 45:

 

Click

As with a page hit, the click has three pieces of information available: its name, its chaptering and its level 2, given in the same hit parameters p and s2.

However, the click parameter must also be filled out. It has four possible values:
– “N” for a navigational click
– “S” for an exit click
– “T” for a download
– “A” for an action

In this same hit, we can also give information about the page on which the action is taken, via the pclick and s2click parameters.

Parameters Description Restrictions Required?
click “N”, “S”, “T” or “A” Yes
p <chap1::chap2::chap3::name> 250 characters max. No special characters. Yes
s2 <level 2> Whole number No
pclick <page name> 250 characters max. No special characters. Non
s2click <page level 2> Whole number No

Example:

Download hit named notice2, with the tree structure home > appliances > kitchen, belonging to the level 2 45 and having been carried out on the page home > appliances > kitchen > page_baking which also belongs to the level 2 45:

 

Internal search engine

Two types of tagging should be distinguished: tagging of the search results page, and tagging of a click on a specific result.

 

Results page

In the case of tagging a results page, only the searched keyword and the pagination are in addition to the regular page tagging (see above).
The keyword is indicated in the mc variable and the pagination in np.

In the case of a search without results, the np parameter is filled with the value 0

Parameters Description Restrictions Required?
mc <keyword> Character string without spaces Yes
np <presults page> Whole number. 0 if no results Yes

Example:

Results for the word “kitchen” and on the third page of results:

 

Results click

In the case of a click made on a results page, in addition to the two previous parameters, you’ll also need the position of the result in the variable mcrg and the click parameter will mandatorily be set to “IS”.

Parameters Description Restrictions Required?
mc <keyword> Character string without spaces Yes
np <results page> Whole number Yes
mcrg <position> Whole number Yes
click IS Value set to IS Yes

Example:

A click on the 2nd place result, on the results page from the previous example:

 

Custom variables

Custom variables are linked to a page.
A page variable is entered in the f parameter, followed by its row number. A site variable will be entered in the x parameter, followed by its row number.

Parameters Description Restrictions Required?
x<n> <site variable> No
f<n> <page variable> No

Example:

Two site variables: the number 1 with the value dentist and the number 3 with the value women.
Two page variables: the number 5 with the value chair and the number 2 with the value 5.

 

Custom tree structure

Custom tree structures let you declare a category tree structure of up to three levels. These three levels are all in the same parameter, “ptype“, represented by IDs separated by hyphens. This category tree structure must be set up in advance in the interface so that the corresponding IDs may be retrieved.

Parameters Description Restrictions Required?
ptype <category ID 1>-<category ID 2>-<category ID 3> Yes

Example:

 

Aisles

You may have up to six levels of aisles. Each level has a numeric ID and a name.
Everything is entered in the “aisl” parameter in the following format:
– for an aisle, we enter the ID followed by its name in brackets [])
– to separate aisles, we use two colons (::::…::)

Parameters Description Restrictions Required?
aisl <id1>[<name1>]::<id2>[<name2>]::…<id6>[<name6>] – the ID is a whole number
– the name is a character string
Yes

Example:

 

Rich Media

Rich Media measurement allows you to count playbacks, time spent as well as actions made on video or audio contents.
This measurement requires different actions, which are keys of the processing of metrics.

 

Media types

Here are the different media types available :

  • “video” : video measurement
  • “audio” : audio measurement
  • “vpre” : pre-roll video measurement
  • “vmid” : mid-roll video measurement
  • “vpost” : post-roll video measurement
 

Play

Action play is the most important, since it is mandatory for content measurement.
It must be the first measurement action sent.

Parameters Description Restrictions Required?
action Action “play” Yes
type Media type “video”, “audio”, “vpre”, “vmid” or “vpost” Yes
m6 Broadcast type “clip” for a content a defined length, “live” for a live broadcast Yes
m1 Content duration In seconds Yes if m6=clip, No if m6=live
p Content label Can be composed of 3 tree structure levels (themes), separate by :: Yes
s2 Content level 2 No
m5 Broadcast location “int” if the content is played from your website, “ext” if the content is played from an external website Yes
buf Is the content buffering “1” while buffering, “0” at the end of the buffering No
prich Label of the page where the content is played (with tree structure) No
s2rich Level 2 of the page where the content is played No
plyr Player identifier. Useful in case there are multiple players on the same page No
clnk Label of the linked content (with tree structure) in case of a pre/mid/post-roll content Yes if type=vpre/vmid/vpost
m9 Broadcast domain, in case of an external broadcast Yes if m5=ext
 

Refresh

Action refresh is used in order to indicate that the playback is still in progress.
This action is mandatory for accurate time spent analysis.

The maximum frequency for refresh is 1 hit every 5 seconds

Parameters Description Restrictions Required?
action Action “refresh” Yes
type Media type “video”, “audio”, “vpre”, “vmid” or “vpost” Yes
m6 Broadcast type “clip” for a content a defined length, “live” for a live broadcast Yes
m1 Content duration In seconds Yes if m6=clip, No if m6=live
p Content label Can be composed of 3 tree structure levels (themes), separate by :: Yes
s2 Content level 2 No
m5 Broadcast location “int” if the content is played from your website, “ext” if the content is played from an external website Yes
plyr Player identifier. Useful in case there are multiple players on the same page No
 

Pause

Action pause is used to indicate a pause in the playback.

Parameters Description Restrictions Required?
action Action “pause” Yes
type Media type “video”, “audio”, “vpre”, “vmid” or “vpost” Yes
m6 Broadcast type “clip” for a content a defined length, “live” for a live broadcast Yes
m1 Content duration In seconds Yes if m6=clip, No if m6=live
p Content label Can be composed of 3 tree structure levels (themes), separate by :: Yes
s2 Content level 2 No
m5 Broadcast location “int” if the content is played from your website, “ext” if the content is played from an external website Yes
plyr Player identifier. Useful in case there are multiple players on the same page No
 

Stop

Action stop is used to indicate the end of a playback.

Parameters Description Restrictions Required?
action Action “stop” Yes
type Media type “video”, “audio”, “vpre”, “vmid” or “vpost” Yes
m6 Broadcast type “clip” for a content a defined length, “live” for a live broadcast Yes
m1 Content duration In seconds Yes if m6=clip, No if m6=live
p Content label Can be composed of 3 tree structure levels (themes), separate by :: Yes
s2 Content level 2 No
m5 Broadcast location “int” if the content is played from your website, “ext” if the content is played from an external website Yes
plyr Player identifier. Useful in case there are multiple players on the same page No
 

Move

Action move is used to indicate a move in the playback.

Parameters Description Restrictions Required?
action Action “move” Yes
type Media type “video”, “audio”, “vpre”, “vmid” or “vpost” Yes
m6 Broadcast type “clip” for a content a defined length, “live” for a live broadcast Yes
m1 Content duration In seconds Yes if m6=clip, No if m6=live
p Content label Can be composed of 3 tree structure levels (themes), separate by :: Yes
s2 Content level 2 No
m5 Broadcast location “int” if the content is played from your website, “ext” if the content is played from an external website Yes
plyr Player identifier. Useful in case there are multiple players on the same page No
Was this post helpful?
Yes
No
Last update: 26/11/2018