{"_id":"569741d024490c3700170a65","createdAt":"2016-01-14T06:36:00.332Z","slug":"introduction","title":"LiftIgniter Overview","updates":["57dae72d2bb38f0e00ef41ee"],"__v":39,"category":"569740f124490c3700170a64","sync_unique":"","version":"5668fab608f90021008e8832","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).","project":"5668fab608f90021008e882f","githubsync":"","isReference":false,"link_external":false,"link_url":"","next":{"description":"","pages":[]},"order":0,"excerpt":"","type":"basic","user":"56839cf74aecbd0d00a4659e","parentDoc":null,"api":{"params":[],"results":{"codes":[]},"settings":"","url":"","auth":"required"},"hidden":false,"childrenPages":[]}

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).