|
1 | 1 | # Linkfire Raw Data Documentation |
2 | 2 |
|
3 | | -1. [Data fields](#data-fields) |
4 | | -2. [How to match the main metrics in Linkfire v1](#how-to-match-the-main-metrics-in-linkfire-v1) |
5 | | -3. [How to match the main metrics in Linkfire app](#how-to-match-the-main-metrics-in-linkfire-app) |
6 | | - |
7 | | -## Data fields |
8 | | -|Field Name|Description|Example| |
9 | | -|---|---|---| |
10 | | -|activity|Activity ID (string) added by the marketer to the link. Max 50 characters.|eveningpromotion, giveaway| |
11 | | -|artists|The name of the artist associated with the link.|Music Band| |
12 | | -|asset|The type of asset where the activity took place.|landingpage, bridgepage, widget| |
13 | | -|boardid|UUID of the board the visited link is in.|a1c50793-2c2a-4809-ae23-3204a4584cad| |
14 | | -|boardname|Name of the board where the link is placed.|music-label| |
15 | | -|browser|Name of visitor's browser as identified through the use of Browscap decoded from the user agent.|Chrome, IE, Facebook App, Safari| |
16 | | -|campaigntype|The type of link used.|Music, Content| |
17 | | -|channelid|UUID of the marketing channel used by the marketer.|d8b8bb4f-4c47-11e6-9fd0-066c3e7a8751| |
18 | | -|channelname|The name of the marketing channel used by the marketer when promoting the link.|Instagram, YouTube Description, Facebook| |
19 | | -|channeltype|The category of the marketing channel used by the marketer when promoting the link.|Owned, Paid, Original| |
20 | | -|city|Name of visitor's city as decoded from IP using Maxmind GeoIP.|Copenhagen| |
21 | | -|convcategory|Category of the conversion.|Music, Movies, Tickets| |
22 | | -|convdescription|Optional additional description about the conversion, for example Ticketmaster show venue.|Royal Arena| |
23 | | -|convid|The product ID as defined by the merchant where the conversion took place.|Defined by merchant| |
24 | | -|convidsecond|Optional additional ID used for identification, such as user ID.|Defined by merchant| |
25 | | -|convname|Name of the product, such as the track, album or ticket in the transaction.|Excellent Musical Music Track| |
26 | | -|convreference|A reference to the specific transaction provided by the merchant.|Defined by merchant| |
27 | | -|convsource|Name of the merchant/service where the transaction took place.|itunes, amazon, applemusic| |
28 | | -|convtoken|The affiliate token (if any) to which the transaction was attributed.|1001l9mr| |
29 | | -|convtype|The type of the product in the transaction.|Song, Video, Playlist| |
30 | | -|convvalue|A value assigned to the transaction, such as purchase value.|Defined by merchant| |
31 | | -|convvaluesecond|Optional additional value such as the commission value of a purchase.|Defined by merchant| |
32 | | -|convvaluetype|Identifies the format of the value.|currency| |
33 | | -|convvalueunit|The unit of the value.|USD, GBP, seconds| |
34 | | -|countrycode|ISO 3166-1 alpha-2 country code of the visitor.|DK| |
35 | | -|created|UTC timestamp for the action in ISO8601 format.|2019-01-07 23:59:45.084| |
36 | | -|device|The type of device used by the visitor.|mobile, desktop, tablet| |
37 | | -|eventaction|The type of action taken by the visitor.|manual, d2s, original, single| |
38 | | -|eventcategory|The context in which the visitor's action happened.|service, widget, player| |
39 | | -|eventcategorytype|The type of the item on which the visitor performed an action.|play, goto, download| |
40 | | -|eventlabel|The name of the item on which the visitor performed an action.|applemusic, spotify, deezer| |
41 | | -|eventvalue|N/A|N/A| |
42 | | -|ip|The visitor's IP address. Deprecated due to IP being PII.|N/A| |
43 | | -|linkid|UUID of the visited link.|13591d85-bd99-469a-812d-4088d6320a91| |
44 | | -|linkisrc|For links associated with a track, the ISRC of the track.|USBSR0930647| |
45 | | -|linkupc|For links associated with an album, the UPC of the album.|884483917087| |
46 | | -|linkurl|The URL of the link.|artist.lnk.to/album| |
47 | | -|newsession|Indicates whether this pageview is the first pageview of the session (matching the actual visitortoken).|true, false| |
48 | | -|os|The visitor's operating system.|iOS, Android, Windows 10, Windows 7| |
49 | | -|params|URL parameters included in the full URL of the visit, as json.|{'fbclid': 'IwAR0S5crLkOb1zCZ6ImMmj8Zs'}| |
50 | | -|referrer|The full URL of the HTTP referrer.|http://m.facebook.com| |
51 | | -|tags|The tags added to the link(s)|1960s, Live, Pop| |
52 | | -|toplevelreferrer|Root domain of the HTTP referrer.|youtube.com, facebook.com| |
53 | | -|type|The action taken by the visitor.|pageview, event, conversion| |
54 | | -|useragent|The visitor's full useragent. Deprecated because it may represent PII and most use cases can be solved with other fields.|N/A| |
55 | | -|visitortoken|Unique visitor token to identify and correlate visitor actions. Has a 10 minute lifetime.|70289507v161c9c3c759e2e534859b73| |
56 | | -|visitoruid|Unique visitor token to identify and correlate visitor actions. Based on a cookie with 6 months lifespan. Note: this is PII.|5b303fgcda39e8.46766248| |
57 | | - |
58 | | -## How to match the main metrics in Linkfire v1 |
59 | | -|Metric|Description|Calculation approach| |
60 | | -|---|---|---| |
61 | | -|Visits|Non-unique pageviews excluding scrapers, bots etc. Repeated hits are counted.|Count of rows where type='pageview'| |
62 | | -|Visitors|Activity in a 10-minute window in which which repeated pageviews are counted as unique.|Count of rows where type='pageview' and newsession='true'| |
63 | | -|Engagements|Total non-unique engagements, including repeated engagements in the same session|Number of distinct values of ‘Visitortoken’ where type='event'| |
64 | | -|Click-throughs|Visitors that clicked-through at least once|Number of distinct values of ‘Visitortoken’ where type='event' and eventcategory='service'| |
65 | | -|Click-through rate|Click-through rate excludes content links. Percentage of click-throughs against the number of visitors.|Click-throughs / visitors (excluding visitors to content links) * 100| |
66 | | - |
67 | | -## How to match the main metrics in Linkfire app |
68 | | -|Metric|Description|Calculation approach| |
69 | | -|---|---|---| |
70 | | -|Visits|Non-unique pageviews excluding scrapers, bots etc. Repeated hits are counted.|Count of rows where type='pageview'| |
71 | | -|Sessions|Activity in a 10-minute window in which repeated pageviews are counted as unique.|Count of rows where type='pageview' and newsession='true'| |
72 | | -|Engagements|Total non-unique engagements, including repeated engagements.|Count of rows where type='event'| |
73 | | -|Click-throughs|Total non-unique click-throughs, including repeated click-throughs.|Count of rows where type='event' and eventcategory='service'| |
74 | | -|Click-through rate|Percentage of click-throughs against the number of visitors. Click-through rate includes content links.|Click-throughs / visits * 100| |
75 | | -|Conversions|Tracked sales and streams from sources that provide attribution data to Linkfire|Count of rows where type='conversion' and convtoken !='1l3vpUI'| |
76 | | -|Streams|Tracked streaming events from streaming services that provide attribution data to Linkfire|Count of rows where type='conversion' and convcategory='stream'| |
| 3 | +1. [Data fields](https://github.com/GetLinkfire/raw-data-documentation/wiki/Data-fields) |
| 4 | +2. [How to match the main metrics in Linkfire v1](https://github.com/GetLinkfire/raw-data-documentation/wiki/How-to-match-the-main-metrics-in-Linkfire-v1) |
| 5 | +3. [How to match the main metrics in Linkfire app](https://github.com/GetLinkfire/raw-data-documentation/wiki/How-to-match-the-main-metrics-in-Linkfire-app) |
0 commit comments