{"_id":"569741d024490c3700170a65","__v":39,"category":{"_id":"569740f124490c3700170a64","pages":["569741d024490c3700170a65","56a16f7d932d7c0d008bf212"],"__v":2,"project":"5668fab608f90021008e882f","version":"5668fab608f90021008e8832","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-01-14T06:32:17.478Z","from_sync":false,"order":0,"slug":"introduction","title":"Introduction"},"version":{"_id":"5668fab608f90021008e8832","__v":19,"project":"5668fab608f90021008e882f","createdAt":"2015-12-10T04:08:22.769Z","releaseDate":"2015-12-10T04:08:22.769Z","categories":["5668fab708f90021008e8833","569740f124490c3700170a64","569742b58560a60d00e2c25d","569742bd0b09a41900b2446c","569742cd69393517000c82b3","569742f459a6692d003fad8f","569743020b09a41900b2446d","5697430b69393517000c82b5","56a17776470ae00d00c30642","56a2c48a831e2a0d0069b1ad","56b535757bccae0d00e9a1cd","56e1ff6aa49fdc0e005746b5","57e1c88115bf6522002a5e4e","57fa65275ba65a17008b988f","57fbeea34002550e004c032e","58474584889b6c2d00fb86e9","58475dcc64157f0f002f1907","587e7b5158666c2700965d4e","58a349fc30852819007ba083"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.18.0","version":"1.18"},"project":"5668fab608f90021008e882f","githubsync":"","user":"56839cf74aecbd0d00a4659e","parentDoc":null,"updates":["57dae72d2bb38f0e00ef41ee"],"next":{"pages":[],"description":""},"createdAt":"2016-01-14T06:36:00.332Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"How LiftIgniter works in a nutshell (Web)\"\n}\n[/block]\nThere are mainly 2 things associated with your webpage, your `Item` (Article/Video/Product/etc.) and how users interact with those pieces of content (`Activity`). \n\nIntegrating the LiftIgniter `Beacon` to your webpage will allow you to do 3 things as soon as someone opens up your webpage.\n\n* Collect the information about `Item` on your webpage (things such as URL, title, and description along with whatever information you wish to provide us).\n* Detect user `Activities` such as how long the user engaged with your `Item`, what `Item` user viewed, and what kind of recommendations are being shown to the user. \n* Provide recommendations based on user's current `Activity`.\n* \nOverall flow of data can be represented as:\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/081Uy5QtQQmWZxmjEBSs_Screen%20Shot%202016-01-22%20at%205.05.14%20PM.png\",\n        \"Screen Shot 2016-01-22 at 5.05.14 PM.png\",\n        \"1368\",\n        \"694\",\n        \"#7a9ca5\",\n        \"\"\n      ],\n      \"caption\": \"Your website and LiftIgniter\"\n    }\n  ]\n}\n[/block]\nAs you see, information regarding your contents and user activity is sent to `LiftIgniter API Server`, which pipelines the data into LiftIgniter that does realtime Machine Learning and Data Analysis.\n\nWhen you ask our `Beacon` for a recommendation, it will query the `Model (recommendation) server` for a recommendation while providing some general behavior information about the user. Based on these behaviors, the `Model server` will reference `LiftIgniter` for what kind of `Items` are available on your website, and picks the most appropriate `Item` for the specific user viewing your webpage.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"LiftIgniter REST API\"\n}\n[/block]\nIf you are planning to use LiftIgniter in a more sophisticated way (maybe for a `mobile application` or integration to your `backend`), then you might not want to use our JavaScript SDK integration.\n\nIn that case, you can use our `REST API` and the documentations can be [found here](https://liftigniter.readme.io/docs/api-overview).","excerpt":"","slug":"introduction","type":"basic","title":"LiftIgniter Overview"}

LiftIgniter Overview


[block:api-header] { "type": "basic", "title": "How LiftIgniter works in a nutshell (Web)" } [/block] There are mainly 2 things associated with your webpage, your `Item` (Article/Video/Product/etc.) and how users interact with those pieces of content (`Activity`). Integrating the LiftIgniter `Beacon` to your webpage will allow you to do 3 things as soon as someone opens up your webpage. * Collect the information about `Item` on your webpage (things such as URL, title, and description along with whatever information you wish to provide us). * Detect user `Activities` such as how long the user engaged with your `Item`, what `Item` user viewed, and what kind of recommendations are being shown to the user. * Provide recommendations based on user's current `Activity`. * Overall flow of data can be represented as: [block:image] { "images": [ { "image": [ "https://files.readme.io/081Uy5QtQQmWZxmjEBSs_Screen%20Shot%202016-01-22%20at%205.05.14%20PM.png", "Screen Shot 2016-01-22 at 5.05.14 PM.png", "1368", "694", "#7a9ca5", "" ], "caption": "Your website and LiftIgniter" } ] } [/block] As you see, information regarding your contents and user activity is sent to `LiftIgniter API Server`, which pipelines the data into LiftIgniter that does realtime Machine Learning and Data Analysis. When you ask our `Beacon` for a recommendation, it will query the `Model (recommendation) server` for a recommendation while providing some general behavior information about the user. Based on these behaviors, the `Model server` will reference `LiftIgniter` for what kind of `Items` are available on your website, and picks the most appropriate `Item` for the specific user viewing your webpage. [block:api-header] { "type": "basic", "title": "LiftIgniter REST API" } [/block] If you are planning to use LiftIgniter in a more sophisticated way (maybe for a `mobile application` or integration to your `backend`), then you might not want to use our JavaScript SDK integration. In that case, you can use our `REST API` and the documentations can be [found here](https://liftigniter.readme.io/docs/api-overview).