The changes to these two endpoints will allow us to more efficiently route requests and traffic within our model servers. We strongly recommend updating to the new version as soon as possible so that your requests can leverage our more efficient performance. The existing v2 versions are currently slated to be deprecated on June 1st 2018.
\nOur API integration has three key components, plus an optional fourth for sending user-specific data.
\nIt is very common to use a hybrid integration, where our Javascript SDK's track function can do the heavy lifting for activity tracking. This can save considerable development time.
\nYou may find it helpful to see LiftIgniter in action via our Javascript integration, both in a 100% LiftIgniter integration, and in an A|B test, where our recommendations overwrite the control slice (\"base\") of the test before being tracked.
\nImport Collection
\nYou can import this collection into your own Postman client using this link.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"2166502","collectionId":"4dc6f269-93ca-5b5f-67c2-53b61a5b0385","publishedId":"7TFGvSV","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"1676dd","highlight":"f7931d"},"publishDate":"2018-05-21T19:30:55.000Z"},"item":[{"name":"Inventory","item":[{"name":"Send inventory","id":"55898089-0f58-f180-100a-59ad3759e397","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"apiKey\" : \"034cc68b-7242-487f-8a60-577bd31e6421\",\r\n \"version\": 1,\r\n \"ttl\": 0,\r\n \"items\" : [\r\n {\r\n \"url\": \"https://liftigniter.readme.io/docs/inventory\",\r\n \"title\": \"LiftIgniter Add Inventory Endpoint\",\r\n \"thumbnail\": \"https://www.liftigniter.com/wp-content/uploads/artificial-intelligence-2228610_1920.jpg\",\r\n \"tags\": [\"liftigniter\", \"inventory\", \"API\"],\r\n \"category\": \"documentation\",\r\n \"noShow\": \"false\"\r\n },\r\n {\r\n \"url\": \"https://liftigniter.readme.io/docs/inventory-1\",\r\n \"title\": \"LiftIgniter Delete Inventory Endpoint\",\r\n \"thumbnail\": \"https://www.liftigniter.com/wp-content/uploads/artificial-intelligence-2228610_1920.jpg\",\r\n \"tags\": [\"liftigniter\", \"inventory\", \"API\"],\r\n \"category\": \"documentation\",\r\n \"noShow\": \"true\"\r\n }\r\n ]\r\n}"},"url":"https://api.petametrics.com/v1/inventory","description":"Inventory is a collection of your items that you would like LiftIgniter to track. Any items submitted will be considered for recommendation (unless they are marked as \"noShow\": \"true\").
\nFor integrations that serve websites, we generally use the field called url as the inventory id field. You can think of this as the primary key for your inventory items. If you think the URL is not the correct unique field for your use case, get in touch with us and we’ll change the name of your primary key field. Please do this before you start sending us inventory.
\nAny request to add or delete items will be done using the primary key field. In particular, if the item you insert does not have this field, it will be rejected. If the item has the primary key field, it will replace any other items that already exist with the same primary key value.
\nLiftIgniter supports the following kinds of values for an inventory item:
\nWe do not currently accept nested JSON structures for inventory items. Any such nested structures will be ignored by us when scraping your inventory.
\nIf inserting multiple inventory items together, aim for batch sizes of about 1,000. We have a hard limit of 10,000 on batch sizes but recommend smaller batch sizes.\nIn general, we recommend keeping the total number of items inserted per minute at less than 10,000, though we can handle loads up to 20,000 per minute for short durations.
\nTiming of Inventory Operations
\nThe inventory update and delete operations you do may not occur immediately.
\nYou can expect a delay of at least one minute and at most five minutes between successful insertion of an item and being able to successfully query it.
\nIn order to query the item, you can use our inventory GET endpoint.
\nPlease expect a delay of up to ten more minutes for the item to start circulating in recommendations.
\nWe also don’t guarantee consistency in the order of execution of operations, so if an insert and delete operation happen very close together in time (within an interval of under a minute), the result is unpredictable.
\nSetting Automatic Expiration of Items
\nYou can set a Time To Live (TTL) for items in the inventory using the ttl parameter. The value should be a non-negative 32-bit integer that represents how long the inserted items should last in seconds. If this field isn't declared, then the TTL of inserted item becomes indefinite (i.e. an item will never be deleted from the inventory except via the DELETE method). Setting this parameter to 0 will result in 30 days TTL instead of 0 seconds.
The ID of the item is the URL by default. This must be URL encoded. If you are using \"id\" as the primary key for your inventory, use that value instead of the URL of the item.
\n","urlObject":{"protocol":"https","path":["v1","inventory",":itemId"],"host":["api","petametrics","com"],"query":[],"variable":[{"description":{"content":"The URL of the item. Must be URL encoded
\n","type":"text/plain"},"type":"any","value":"","key":"itemId"}]}},"response":[{"id":"31d4510c-2df1-4503-b9f7-e21e420deca1","name":"Get Item by ID","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"your_api_key"}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"https://api.petametrics.com/v1/inventory/:itemId","protocol":"https","host":["api","petametrics","com"],"path":["v1","inventory",":itemId"],"variable":[{"key":"itemId","value":"https%3A%2F%2Fwww.liftigniter.com%2Fblog%2Fdo-you-believe-these-5-personalization-myths","description":"The URL of the item. Must be URL encoded"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"ef8dcb45-5b99-c0c3-f385-e83b6d3b55ca"},{"name":"Delete Item","id":"e0e13d5e-6f9f-3cd7-c7ce-60acb1a93f2b","request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"apiKey\": \"api-key\",\r\n\"items\" : [\r\n {\r\n \"url\": \"https://documenter.getpostman.com/view/2166502/liftigniter/7TFGvSV#55898089-0f58-f180-100a-59ad3759e397\"\r\n },\r\n {\r\n \"url\": \"https://documenter.getpostman.com/view/2166502/liftigniter/7TFGvSV#e0e13d5e-6f9f-3cd7-c7ce-60acb1a93f2b\"\r\n }\r\n ]\r\n}"},"url":"https://api.petametrics.com/v1/inventory","description":"In general, \"url\" is the default primary key for identifying inventory items. If you are using \"id\" as the unique identifier for your items, use \"id\" as the field name instead of \"url\".
\nWhen the deletion request is sent, our API does not check for whether or not the item exists. Rather, it simply marks the item for deletion. If the item does not exist, this has no effect. If the item does exist, then the deletion is carried out. This endpoint will return a 200 OK response whether items were deleted or not. The \"status\" field in the response object will show how many items were deleted out of the total number sent for deletion.
\nThe main advantage of this is that you can send a deletion command for a large number of items, and we can immediately accept this rather than checking for the existence of each of the items in the list you sent.
\n","urlObject":{"protocol":"https","path":["v1","inventory"],"host":["api","petametrics","com"],"query":[],"variable":[]}},"response":[{"id":"ac4e80f2-794c-4e91-ba96-cec69ab3130d","name":"Delete Item - Deletion Successful","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","disabled":false}],"body":{"mode":"raw","raw":"{\r\n \"apiKey\": \"api-key\",\r\n\"items\" : [\r\n {\r\n \"url\": \"https://documenter.getpostman.com/view/2166502/liftigniter/7TFGvSV#55898089-0f58-f180-100a-59ad3759e397\"\r\n },\r\n {\r\n \"url\": \"https://documenter.getpostman.com/view/2166502/liftigniter/7TFGvSV#e0e13d5e-6f9f-3cd7-c7ce-60acb1a93f2b\"\r\n }\r\n ]\r\n}"},"url":"https://api.petametrics.com/v1/inventory"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Alt-Svc","value":"clear","name":"Alt-Svc","description":"Custom header"},{"key":"Content-Length","value":"279","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Mon, 21 May 2018 20:06:53 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"akka-http/10.0.10","name":"Server","description":"A name for the server"},{"key":"Via","value":"1.1 google","name":"Via","description":"Informs the client of proxies through which the response was sent."}],"cookie":[],"responseTime":null,"body":"{\"statusCode\":200,\"organization\":\"imdb\",\"diagnosticMsg\":\"Items marked for deletion have been deleted.\",\"numItemsRequestedForDeletion\":2,\"apiServer\":\"api-fe-west-mkmx\",\"status\":\"2/2 items deleted.\",\"inventoryIdField\":\"url\",\"numItemsDeleted\":2,\"inventoryIdRegex\":\"(.+?)(?:[?#]|$)\"}"},{"id":"e3576439-68d8-415c-8e97-2d8c52d3fdb6","name":"Delete Item - No items deleted.","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","disabled":false}],"body":{"mode":"raw","raw":"{\r\n \"apiKey\": \"api-key\",\r\n\"items\" : [\r\n {\r\n \"url\": \"https://documenter.getpostman.com/view/2166502/liftigniter/7TFGvSV#55898089-0f58-f180-100a-59ad3759e397\"\r\n },\r\n {\r\n \"url\": \"https://documenter.getpostman.com/view/2166502/liftigniter/7TFGvSV#e0e13d5e-6f9f-3cd7-c7ce-60acb1a93f2b\"\r\n }\r\n ]\r\n}"},"url":"https://api.petametrics.com/v1/inventory"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Alt-Svc","value":"clear","name":"Alt-Svc","description":"Custom header"},{"key":"Content-Length","value":"306","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Mon, 21 May 2018 20:00:19 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"akka-http/10.0.10","name":"Server","description":"A name for the server"},{"key":"Via","value":"1.1 google","name":"Via","description":"Informs the client of proxies through which the response was sent."}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 200,\n \"organization\": \"account-name\",\n \"diagnosticMsg\": \"Items marked for deletion have been deleted.\",\n \"numItemsRequestedForDeletion\": 2,\n \"apiServer\": \"api-fe-west-1234\",\n \"status\": \"0/2 items deleted.\",\n \"inventoryIdField\": \"url\",\n \"numItemsDeleted\": 0,\n \"inventoryIdRegex\": \"(.*www.telegraph.co.uk/.+?)(?:[?#]|$)\"\n}"}],"_postman_id":"e0e13d5e-6f9f-3cd7-c7ce-60acb1a93f2b"}],"id":"3798ad85-acdb-ed40-3add-10f67c05c357","description":"Inventory management is a key part of generating quality recommendations. Make sure to POST new items as they become available, and DELETE items if their unique identifier (usually URL) is updated or the item is removed from your site completely.
\nLiftIgniter inventory can be identified by either the URL (default) or by an ID. If your items have both an ID and a URL, you can continue to use URL as the unique identifier and send the ID as part of the item's metadata. To have your account configured to support an ID as the only unique identifier, please contact LiftIgniter Support.
\nFor more information, see Inventory Management
\n","event":[{"listen":"prerequest","script":{"id":"31aee648-5622-4a9f-ae5c-63292cc82785","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"4d5e7fa1-16fd-4313-abe7-bfae50b03e10","type":"text/javascript","exec":[""]}}],"_postman_id":"3798ad85-acdb-ed40-3add-10f67c05c357"},{"name":"v3 Model (Request Recommendations)","item":[{"name":"Model Query - URL-based Inventory","id":"340404f6-68fd-4844-90d9-7b93994440b9","request":{"method":"POST","header":[{"key":"Accept-Encoding","value":"","description":"If you set this to gzip, we will gzip the response, so you will need to gunzip it. Note that the final response is not affected.
\n"},{"key":"Content-Type","value":"application/json"},{"key":"x-api-key","value":"api-key","description":"Your API Key
\n"}],"body":{"mode":"raw","raw":"{\r\n \"widgetName\":\"your_widget_name\",\r\n \"maxCount\": 10,\r\n \"showCount\": \"10 - must be a string, indicates the number of items you anticipate displaying out of the total requested\",\r\n \"url\" : \"http://domain.com/the-current-content-or-page-url\",\r\n \"pageviewId\": \"Identifier for the current pageview or impression. This is optional; if you send multiple queries with the same userId and pageviewId we understand that all those correspond to the same impression so we should deduplicate recommendations across them.\",\r\n \"timestamp\": \"UNIX epoch timestamp in milliseconds\",\r\n \"referrer\": \"For web or web-like user flows, this is the URL of the page that the user came from\",\r\n \"sessionId\": \"Identifier for the current session of the user. Optional\",\r\n \"requestFields\": [\"list\", \"of\", \"STRING\", \"fields\", \"that should be returned for each item recommended\"],\r\n \"arrayRequestFields\": [\"list\", \"of\", \"ARRAY\", \"fields\", \"that should be returned with their full array of values. Useful for fields like lists of tags, categories, subtitle languages, actors, etc.\"],\r\n \"requestFieldsAON\": false,\r\n \"maxAgeInSeconds\": \"maximum age in seconds of the items you want recommended. Usable only if your items include a 'published_time' field\",\r\n \"excludeItems\":[\"http://www.url-1.com\", \"http://www.url-2.com\", \"https://liftigniter.freshdesk.com/support/solutions/articles/30000027122-how-do-i-block-specific-items-from-being-shown-in-a-widget-\"]\r\n}"},"url":"https://query.petametrics.com/v3/:jsk/:userId/model","description":"Posting to the model endpoint triggers a set of recommendations to be calculated and returned in the JSON response. Use \"url\" as the unique identifier for the current item the user is viewing if the URL is also the unique identifier for your inventory items (this is the default LiftIgniter setting).
\nTo deduplicate between multiple widgets on the same page, the \"userId\" and \"pageviewId\" parameters must be included. If these are the same between two requests, our system will exclude items already returned for the first request.
\nPlease ensure that the values for jsk and userId are replaced in the URL path.
\nYour jsk (Javascript Key) is available in your LiftIgniter Account under Settings.
\nIf a request is successful but a particular combination of filters results in no items meeting the criteria for valid recommendations, LiftIgniter will return an empty \"items\" array. In cases where there is insufficient time to calculate a response based on the timestamp of the request (typically due to transit delays or other connection issues) LiftIgniter will return a fallback set of recommendations. In both cases, the status code will be 200.
\n","urlObject":{"protocol":"https","path":["v3",":jsk",":userId","model"],"host":["query","petametrics","com"],"query":[],"variable":[{"type":"any","value":"","key":"jsk"},{"type":"any","value":"","key":"userId"}]}},"response":[{"id":"22fdc837-9a75-483a-9e98-7e3268594149","name":"Model Query - Successful Request","originalRequest":{"method":"POST","header":[{"key":"Accept-Encoding","value":"","description":"If you set this to gzip, we will gzip the response, so you will need to gunzip it. Note that the final response is not affected."},{"key":"Content-Type","value":"application/json"},{"key":"x-api-key","value":"","description":"Your API Key"}],"body":{"mode":"raw","raw":"{\r\n \"widgetName\":\"your_widget_name\",\r\n \"maxCount\": 10,\r\n \"showCount\": \"10 - must be a string, indicates the number of items you anticipate displaying out of the total requested\",\r\n \"url\" : \"http://domain.com/the-current-content-or-page-url\",\r\n \"pageviewId\": \"Identifier for the current pageview or impression. This is optional; if you send multiple queries with the same userId and pageviewId we understand that all those correspond to the same impression so we should deduplicate recommendations across them.\",\r\n \"timestamp\": \"UNIX epoch timestamp in milliseconds\",\r\n \"referrer\": \"For web or web-like user flows, this is the URL of the page that the user came from\",\r\n \"sessionId\": \"Identifier for the current session of the user. Optional\",\r\n \"maxAgeInSeconds\": \"maximum age in seconds of the items you want recommended. Usable only if your items include a 'published_time' field\",\r\n \"excludeItems\":[\"http://www.url-1.com\", \"http://www.url-2.com\", \"https://liftigniter.freshdesk.com/support/solutions/articles/30000027122-how-do-i-block-specific-items-from-being-shown-in-a-widget-\"]\r\n}"},"url":{"raw":"https://query.petametrics.com/v3/:jsk/:userId/model","protocol":"https","host":["query","petametrics","com"],"path":["v3",":jsk",":userId","model"],"variable":[{"key":"jsk","value":""},{"key":"userId","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*","name":"Access-Control-Allow-Origin","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Alt-Svc","value":"clear","name":"Alt-Svc","description":"Custom header"},{"key":"Content-Length","value":"1582","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Tue, 22 May 2018 01:59:37 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"nginx/1.12.2","name":"Server","description":"A name for the server"},{"key":"Via","value":"1.1 google","name":"Via","description":"Informs the client of proxies through which the response was sent."}],"cookie":[],"responseTime":null,"body":"{\"items\":[{\"url\":\"http://www.imdb.com/title/tt0113277/\",\"rank\":\"1\",\"thumbnail\":\"https://storage.googleapis.com/pm-demo/images/tt0113277.jpg\",\"title\":\"Heat\"},{\"url\":\"http://www.imdb.com/title/tt0033467/\",\"rank\":\"2\",\"thumbnail\":\"https://storage.googleapis.com/pm-demo/images/tt0033467.jpg\",\"title\":\"Citizen Kane\"},{\"url\":\"http://www.imdb.com/title/tt0149460/\",\"rank\":\"3\",\"thumbnail\":\"https://storage.googleapis.com/pm-demo/images/tt0149460.jpg\",\"title\":\"Futurama\"},{\"url\":\"http://www.imdb.com/title/tt0071562/\",\"rank\":\"4\",\"thumbnail\":\"https://storage.googleapis.com/pm-demo/images/tt0071562.jpg\",\"title\":\"The Godfather: Part II\"},{\"url\":\"http://www.imdb.com/title/tt0802999/\",\"rank\":\"5\",\"thumbnail\":\"https://storage.googleapis.com/pm-demo/images/tt0802999.jpg\",\"title\":\"Grand Theft Auto IV\"},{\"url\":\"http://www.imdb.com/title/tt0314331/\",\"rank\":\"6\",\"thumbnail\":\"https://storage.googleapis.com/pm-demo/images/tt0314331.jpg\",\"title\":\"Love Actually\"},{\"url\":\"http://www.imdb.com/title/tt0898266/\",\"rank\":\"7\",\"thumbnail\":\"https://storage.googleapis.com/pm-demo/images/tt0898266.jpg\",\"title\":\"The Big Bang Theory\"},{\"url\":\"http://www.imdb.com/title/tt0105236/\",\"rank\":\"8\",\"thumbnail\":\"https://storage.googleapis.com/pm-demo/images/tt0105236.jpg\",\"title\":\"Reservoir Dogs\"},{\"url\":\"http://www.imdb.com/title/tt0477348/\",\"rank\":\"9\",\"thumbnail\":\"https://storage.googleapis.com/pm-demo/images/tt0477348.jpg\",\"title\":\"No Country for Old Men\"},{\"url\":\"http://www.imdb.com/title/tt0091763/\",\"rank\":\"10\",\"thumbnail\":\"https://storage.googleapis.com/pm-demo/images/tt0091763.jpg\",\"title\":\"Platoon\"}]}"},{"id":"2cd20107-c5d2-4f92-9d67-69a0eefa0181","name":"Model Query - No valid recommendations","originalRequest":{"method":"POST","header":[{"key":"Accept-Encoding","value":"","description":"If you set this to gzip, we will gzip the response, so you will need to gunzip it. Note that the final response is not affected."},{"key":"Content-Type","value":"application/json"},{"key":"x-api-key","value":"api-key","description":"Your API Key"}],"body":{"mode":"raw","raw":"{\r\n \"widgetName\":\"your_widget_name\",\r\n \"maxCount\": 10,\r\n \"showCount\": \"10 - must be a string, indicates the number of items you anticipate displaying out of the total requested\",\r\n \"url\" : \"http://domain.com/the-current-content-or-page-url\",\r\n \"pageviewId\": \"Identifier for the current pageview or impression. This is optional; if you send multiple queries with the same userId and pageviewId we understand that all those correspond to the same impression so we should deduplicate recommendations across them.\",\r\n \"timestamp\": \"UNIX epoch timestamp in milliseconds\",\r\n \"referrer\": \"For web or web-like user flows, this is the URL of the page that the user came from\",\r\n \"sessionId\": \"Identifier for the current session of the user. Optional\",\r\n \"requestFields\": [\"list\", \"of\", \"STRING\", \"fields\", \"that should be returned for each item recommended\"],\r\n \"arrayRequestFields\": [\"list\", \"of\", \"ARRAY\", \"fields\", \"that should be returned with their full array of values. Useful for fields like lists of tags, categories, subtitle languages, actors, etc.\"],\r\n \"requestFieldsAON\": false,\r\n \"maxAgeInSeconds\": \"maximum age in seconds of the items you want recommended. Usable only if your items include a 'published_time' field\",\r\n \"excludeItems\":[\"http://www.url-1.com\", \"http://www.url-2.com\", \"https://liftigniter.freshdesk.com/support/solutions/articles/30000027122-how-do-i-block-specific-items-from-being-shown-in-a-widget-\"]\r\n}"},"url":"https://query.petametrics.com/v3/validkey/model"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*","name":"Access-Control-Allow-Origin","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Alt-Svc","value":"clear","name":"Alt-Svc","description":"Custom header"},{"key":"Content-Length","value":"16","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Mon, 21 May 2018 20:22:52 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"nginx/1.12.2","name":"Server","description":"A name for the server"},{"key":"Via","value":"1.1 google","name":"Via","description":"Informs the client of proxies through which the response was sent."}],"cookie":[],"responseTime":null,"body":"{\n \"items\": []\n}"},{"id":"5bfe5bfe-da7a-4f2e-83f9-2b71a553b782","name":"Model Query - Invalid API Key","originalRequest":{"method":"POST","header":[{"key":"Accept-Encoding","value":"","description":"If you set this to gzip, we will gzip the response, so you will need to gunzip it. Note that the final response is not affected.","disabled":false},{"key":"Content-Type","value":"application/json","disabled":false},{"key":"x-api-key","value":"invalid","description":"Your API Key","disabled":false}],"body":{"mode":"raw","raw":"{\r\n \"widgetName\":\"your_widget_name\",\r\n \"maxCount\": 10,\r\n \"showCount\": \"10 - must be a string, indicates the number of items you anticipate displaying out of the total requested\",\r\n \"url\" : \"http://domain.com/the-current-content-or-page-url\",\r\n \"pageviewId\": \"Identifier for the current pageview or impression. This is optional; if you send multiple queries with the same userId and pageviewId we understand that all those correspond to the same impression so we should deduplicate recommendations across them.\",\r\n \"timestamp\": \"UNIX epoch timestamp in milliseconds\",\r\n \"referrer\": \"For web or web-like user flows, this is the URL of the page that the user came from\",\r\n \"sessionId\": \"Identifier for the current session of the user. Optional\",\r\n \"requestFields\": [\"list\", \"of\", \"STRING\", \"fields\", \"that should be returned for each item recommended\"],\r\n \"arrayRequestFields\": [\"list\", \"of\", \"ARRAY\", \"fields\", \"that should be returned with their full array of values. Useful for fields like lists of tags, categories, subtitle languages, actors, etc.\"],\r\n \"requestFieldsAON\": false,\r\n \"maxAgeInSeconds\": \"maximum age in seconds of the items you want recommended. Usable only if your items include a 'published_time' field\",\r\n \"excludeItems\":[\"http://www.url-1.com\", \"http://www.url-2.com\", \"https://liftigniter.freshdesk.com/support/solutions/articles/30000027122-how-do-i-block-specific-items-from-being-shown-in-a-widget-\"]\r\n}"},"url":"https://query.petametrics.com/v3/1234345/model"},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*","name":"Access-Control-Allow-Origin","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Alt-Svc","value":"clear","name":"Alt-Svc","description":"Custom header"},{"key":"Content-Length","value":"16","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Mon, 21 May 2018 20:20:45 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"nginx/1.12.2","name":"Server","description":"A name for the server"},{"key":"Via","value":"1.1 google","name":"Via","description":"Informs the client of proxies through which the response was sent."}],"cookie":[],"responseTime":null,"body":"Invalid API key."},{"id":"ddd360d9-0759-4d99-88a7-5bb15a36dddc","name":"Model Query - Successful Request","originalRequest":{"method":"POST","header":[{"key":"Accept-Encoding","value":"","description":"If you set this to gzip, we will gzip the response, so you will need to gunzip it. Note that the final response is not affected."},{"key":"Content-Type","value":"application/json"},{"key":"x-api-key","value":"api-key","description":"Your API Key"}],"body":{"mode":"raw","raw":"{\r\n \"widgetName\":\"your_widget_name\",\r\n \"maxCount\": 1,\r\n \"url\" : \"http://domain.com/the-current-content-or-page-url\",\r\n \"pageviewId\": \"2dcf346a-e1fb-40a9-fc1e-c193085bbb50\",\r\n \"timestamp\": \"1526933645384\",\r\n \"referrer\": \"https://www.domain.com/reviewed/zte-axon-m-review/article/2134051\",\r\n \"sessionId\": \"22603578-0703-4631-d2a4-901418351013\",\r\n \"requestFields\": [\"url\",\"displayDate\",\"keywords\",\"title\"]\r\n}"},"url":"https://query.petametrics.com/v3/jsk/userId/model"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"url\": \"https://www.domain.com/football/2018/05/18/my-article-title/\",\n \"displayDate\": \"2018-05-26 12:51\",\n \"keywords\": [\n \"France Football Team\",\"Brazil Football Team\",\"Sport\",\"World Cup\",\"Football\"\n ],\n \"title\": \"My article title\"\n }\n ]\n}"},{"id":"f9b99c58-fe52-4c6c-bd52-202c74ed7bb0","name":"Model Query - Invalid JS Key","originalRequest":{"method":"POST","header":[{"key":"Accept-Encoding","value":"","description":"If you set this to gzip, we will gzip the response, so you will need to gunzip it. Note that the final response is not affected."},{"key":"Content-Type","value":"application/json"},{"key":"x-api-key","value":"1234564werw","description":"Your API Key"}],"body":{"mode":"raw","raw":"{\r\n \"widgetName\":\"your_widget_name\",\r\n \"maxCount\": 10,\r\n \"showCount\": \"10 - must be a string, indicates the number of items you anticipate displaying out of the total requested\",\r\n \"url\" : \"http://domain.com/the-current-content-or-page-url\",\r\n \"pageviewId\": \"Identifier for the current pageview or impression. This is optional; if you send multiple queries with the same userId and pageviewId we understand that all those correspond to the same impression so we should deduplicate recommendations across them.\",\r\n \"timestamp\": \"UNIX epoch timestamp in milliseconds\",\r\n \"referrer\": \"For web or web-like user flows, this is the URL of the page that the user came from\",\r\n \"sessionId\": \"Identifier for the current session of the user. Optional\",\r\n \"requestFields\": [\"list\", \"of\", \"STRING\", \"fields\", \"that should be returned for each item recommended\"],\r\n \"arrayRequestFields\": [\"list\", \"of\", \"ARRAY\", \"fields\", \"that should be returned with their full array of values. Useful for fields like lists of tags, categories, subtitle languages, actors, etc.\"],\r\n \"requestFieldsAON\": false,\r\n \"maxAgeInSeconds\": \"maximum age in seconds of the items you want recommended. Usable only if your items include a 'published_time' field\",\r\n \"excludeItems\":[\"http://www.url-1.com\", \"http://www.url-2.com\", \"https://liftigniter.freshdesk.com/support/solutions/articles/30000027122-how-do-i-block-specific-items-from-being-shown-in-a-widget-\"]\r\n}"},"url":"https://query.petametrics.com/v3/invalid/model"},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*","name":"Access-Control-Allow-Origin","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Alt-Svc","value":"clear","name":"Alt-Svc","description":"Custom header"},{"key":"Content-Length","value":"15","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Mon, 21 May 2018 20:19:31 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"nginx/1.12.2","name":"Server","description":"A name for the server"},{"key":"Via","value":"1.1 google","name":"Via","description":"Informs the client of proxies through which the response was sent."}],"cookie":[],"responseTime":null,"body":"Invalid JS key."}],"_postman_id":"340404f6-68fd-4844-90d9-7b93994440b9"},{"name":"Model Query - ID-based Inventory","id":"6dfc2da1-072f-4859-9657-500de7f39fda","request":{"method":"POST","header":[{"key":"Accept-Encoding","value":"","description":"If you set this to gzip, we will gzip the response, so you will need to gunzip it. Note that the final response is not affected.
\n"},{"key":"Content-Type","value":"application/json"},{"key":"x-api-key","value":"","description":"Your API Key
\n"}],"body":{"mode":"raw","raw":"{\r\n \"widgetName\":\"your_widget_name\",\r\n \"maxCount\": 10,\r\n \"showCount\": \"10 - must be a string\",\r\n \"id\" : \"current_item_ID\",\r\n \"pageviewId\": \"Identifier for the current pageview or impression. This is optional; if you send multiple queries with the same userId and pageviewId we understand that all those correspond to the same impression so we should deduplicate recommendations across them.\",\r\n \"timestamp\": \"UNIX epoch timestamp in milliseconds\",\r\n \"referrer\": \"For web or web-like user flows, this is the URL of the page that the user came from\",\r\n \"sessionId\": \"Identifier for the current session of the user. Optional\",\r\n \"requestFields\": [\"list\", \"of\", \"STRING\", \"fields\", \"that should be returned for each item recommended\"],\r\n \"arrayRequestFields\": [\"list\", \"of\", \"ARRAY\", \"fields\", \"that should be returned with their full array of values. Useful for fields like lists of tags, categories, subtitle languages, actors, etc.\"],\r\n \"requestFieldsAON\": false,\r\n \"maxAgeInSeconds\": \"maximum age in seconds of the items you want recommended. Usable only if your items include a 'published_time' field\",\r\n \"excludeItems\":[\"http://www.url-1.com\", \"http://www.url-2.com\", \"https://liftigniter.freshdesk.com/support/solutions/articles/30000027122-how-do-i-block-specific-items-from-being-shown-in-a-widget-\"]\r\n}"},"url":"https://query.petametrics.com/v3/jsk/userId/model","description":"Posting to the model endpoint triggers a set of recommendations to be calculated and returned in the JSON response. Use \"id\" as the unique identifier for the current item the user is viewing if \"id\" is also the unique identifier for your inventory items (this requires the LiftIgniter team to configure during account setup).
\nPlease ensure that the values for jsk and userId are replaced in the URL path.
\nYour jsk (Javascript Key) is available in your LiftIgniter Account under Settings.
\n","urlObject":{"protocol":"https","path":["v3","jsk","userId","model"],"host":["query","petametrics","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"6dfc2da1-072f-4859-9657-500de7f39fda"},{"name":"Model Query - generic recommendations for a specific user","id":"9fe538d5-acb9-43ae-9cde-dd76e08e201a","request":{"method":"POST","header":[{"key":"Accept-Encoding","value":"","description":"If you set this to gzip, we will gzip the response, so you will need to gunzip it. Note that the final response is not affected.
\n"},{"key":"Content-Type","value":"application/json"},{"key":"x-api-key","value":"","description":"Your API Key
\n"}],"body":{"mode":"raw","raw":"{\r\n \"widgetName\":\"your_widget_name\",\r\n \"maxCount\": 10,\r\n \"showCount\": \"10 - must be a string\",\r\n \"pageviewId\": \"Identifier for the current pageview or impression. This is optional; if you send multiple queries with the same userId and pageviewId we understand that all those correspond to the same impression so we should deduplicate recommendations across them.\",\r\n \"timestamp\": \"UNIX epoch timestamp in milliseconds\",\r\n \"referrer\": \"For web or web-like user flows, this is the URL of the page that the user came from\",\r\n \"sessionId\": \"Identifier for the current session of the user. Optional\",\r\n \"requestFields\": [\"list\", \"of\", \"STRING\", \"fields\", \"that should be returned for each item recommended\"],\r\n \"arrayRequestFields\": [\"list\", \"of\", \"ARRAY\", \"fields\", \"that should be returned with their full array of values. Useful for fields like lists of tags, categories, subtitle languages, actors, etc.\"],\r\n \"requestFieldsAON\": false,\r\n \"maxAgeInSeconds\": \"maximum age in seconds of the items you want recommended. Usable only if your items include a 'published_time' field\",\r\n \"excludeItems\":[\"http://www.url-1.com\", \"http://www.url-2.com\", \"https://liftigniter.freshdesk.com/support/solutions/articles/30000027122-how-do-i-block-specific-items-from-being-shown-in-a-widget-\"]\r\n}"},"url":"https://query.petametrics.com/v3/jsk/userId/model","description":"Posting to the model endpoint triggers a set of recommendations to be calculated and returned in the JSON response. Sending a request without a \"url\" or \"id\" parameter will generate a list of items a user is likely to be interested in based solely on their browsing history. The more active a user, the more personalized the recommendations will be. This can be useful for generating likely candidates for app notifications and other 'outside' events.
\nPlease ensure that the values for jsk and userId are replaced in the URL path.
\nYour jsk (Javascript Key) is available in your LiftIgniter Account under Settings.
\n","urlObject":{"protocol":"https","path":["v3","jsk","userId","model"],"host":["query","petametrics","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"9fe538d5-acb9-43ae-9cde-dd76e08e201a"},{"name":"Model Query - generic recommendations","id":"c1657f81-4549-4864-8af3-148a2cb1def3","request":{"method":"POST","header":[{"key":"Accept-Encoding","value":"","description":"If you set this to gzip, we will gzip the response, so you will need to gunzip it. Note that the final response is not affected.
\n"},{"key":"Content-Type","value":"application/json"},{"key":"x-api-key","value":"","description":"Your API Key
\n"}],"body":{"mode":"raw","raw":"{\r\n \"widgetName\":\"your_widget_name\",\r\n \"maxCount\": 10,\r\n \"showCount\": \"10 - must be a string\",\r\n \"pageviewId\": \"Identifier for the current pageview or impression. This is optional; if you send multiple queries with the same userId and pageviewId we understand that all those correspond to the same impression so we should deduplicate recommendations across them.\",\r\n \"timestamp\": \"UNIX epoch timestamp in milliseconds\",\r\n \"referrer\": \"For web or web-like user flows, this is the URL of the page that the user came from\",\r\n \"sessionId\": \"Identifier for the current session of the user. Optional\",\r\n \"requestFields\": [\"list\", \"of\", \"STRING\", \"fields\", \"that should be returned for each item recommended\"],\r\n \"arrayRequestFields\": [\"list\", \"of\", \"ARRAY\", \"fields\", \"that should be returned with their full array of values. Useful for fields like lists of tags, categories, subtitle languages, actors, etc.\"],\r\n \"requestFieldsAON\": false,\r\n \"maxAgeInSeconds\": \"maximum age in seconds of the items you want recommended. Usable only if your items include a 'published_time' field\",\r\n \"excludeItems\":[\"http://www.url-1.com\", \"http://www.url-2.com\", \"https://liftigniter.freshdesk.com/support/solutions/articles/30000027122-how-do-i-block-specific-items-from-being-shown-in-a-widget-\"]\r\n}"},"url":"https://query.petametrics.com/v3/jsk/model","description":"Posting to the model endpoint triggers a set of recommendations to be calculated and returned in the JSON response. Sending a request without a \"url\" or \"id\" parameter, or a \"userId\" in the path will generate a generic list of items, primarily chosen for recent popularity in clicks and views. This can be useful for generating items for Trending Content widgets, or obtaining a set of fallback recommendations.
\nPlease ensure that the values for jsk and userId are replaced in the URL path.
\nYour jsk (Javascript Key) is available in your LiftIgniter Account under Settings.
\n","urlObject":{"protocol":"https","path":["v3","jsk","model"],"host":["query","petametrics","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"c1657f81-4549-4864-8af3-148a2cb1def3"},{"name":"Trending Items Query","id":"c6f44f77-c2a9-459f-adce-61b7d0077e43","request":{"method":"POST","header":[{"key":"Accept-Encoding","value":"","description":"If you set this to gzip, we will gzip the response, so you will need to gunzip it. Note that the final response is not affected.
\n"},{"key":"Content-Type","value":"application/json"},{"key":"x-api-key","value":"","description":"Your API Key
\n"}],"body":{"mode":"raw","raw":"{\r\n\"maxCount\": 50,\r\n\"requestFields\": [\"rank\", \"title\", \"url\", \"published_time\", \"modified_time\", \"postId\", \"category\", \"sfw_nsfw\", \"labelVariant\", \"section\"],\r\n\"rankingKey\":\"click\",\r\n\"lookupKey\":\"popular\",\r\n\"hoursBehind\": 24\r\n}"},"url":"http://query.petametrics.com/v3/jsk/model","description":"These parameters request the top performing items according to the lookupkey (popular = lots of pageviews, clicks= lots of clicks) and ranked according to either raw counts (e.g. # of clicks) or ratios (e.g. CTR).
\nPlease ensure that the values for jsk and userId are replaced in the URL path.
\nYour jsk (Javascript Key) is available in your LiftIgniter Account under Settings.
\n","urlObject":{"protocol":"http","path":["v3","jsk","model"],"host":["query","petametrics","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"c6f44f77-c2a9-459f-adce-61b7d0077e43"}],"id":"9bdf75da-edd6-45ec-9c28-a0edefad1389","description":"V2 of our model and activity endpoints are being deprecated in favor of a new v3 version. The major changes between v2 and v3 are:
\nThis allows our infrastructure to more efficiently route traffic and utilize resources for faster response times.
\nFor more details, please see our Support article at https://support.liftigniter.com/support/solutions/articles/30000028475-changes-required-in-api-v3\n
\n","event":[{"listen":"prerequest","script":{"id":"8f4e18a7-f113-42ba-937b-63662278025b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"bd054778-b71c-4679-967c-8dccfc8dc22a","type":"text/javascript","exec":[""]}}],"_postman_id":"9bdf75da-edd6-45ec-9c28-a0edefad1389"},{"name":"v3 Activity","item":[{"name":"pageview","id":"c31e9ba8-e452-4aa2-bd46-ba401d395969","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-api-key","value":"","description":"Your API Key
\n"}],"body":{"mode":"raw","raw":"{\"activities\" : [\n {\"timestamp\" : \"The epoch timestamp of the event in millisecond format.\",\n \"type\": \"pageview\",\n \"url\": \"current page URL - use 'id' if that is the unique identifier for your account's inventory\",\n \"referrer\": \"referring page URL (or 'id' if using IDs)\",\n \"pageviewId\": \"34219bae-e05d-4c6d-b964-d7d051be7661 - A unique identifier for the pageview. This is helpful if you are sending many different events per pageview. Optional but recommended.\",\n \"host\": \"The user's IP address. We extract geolocation information from this. Optional but recommended.\",\n \"userAgent\": \"Mozilla/5.0 (Windows NT 6.3; Win64; x64; rv:56.0) Gecko/20100101 Firefox/56.0. The browser's userAgent string. Optional but recommended.\",\n \"sourceWidgetName\": \"The name of the widget the user clicked on to arrive at the current pageview. Discard if not applicable.\",\n \"deviceType\": \"desktop, mobile, or tablet. Optional.\",\n \"os\": \"The user's device operating system, if detectable. Optional.\",\n \"sessionId\": \"a95eeafe-d5bf-4064-85c1-eaf5710d67e3 - A unique identifier you can send in to identify a single user session. Optional.\"\n} ] }"},"url":"https://query.petametrics.com/v3/jsk/userId/activity","description":"A pageview is a fundamental building block that our models use to understand how items in your inventory are related to each other. We track which items/pages users visit in what sequence, and within the same session. This data then becomes a statistical map of relationships between items, and how strongly related two items may be. Behavior-based relationships are far more reliable than simple tag-relatedness for identifying optimal recommendations.
\nPlease ensure that the values for jsk and userId are replaced in the URL path.
\nYour jsk (Javascript Key) is available in your LiftIgniter Account under Settings.
\n","urlObject":{"protocol":"https","path":["v3","jsk","userId","activity"],"host":["query","petametrics","com"],"query":[],"variable":[]}},"response":[{"id":"0c28a182-7e73-4498-a810-ffa7cd04c71d","name":"pageview - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","disabled":false},{"key":"x-api-key","value":"","description":"Your API Key","disabled":false}],"body":{"mode":"raw","raw":"{\"activities\" : [\n {\"timestamp\" : \"The epoch timestamp of the event in millisecond format.\",\n \"type\": \"pageview\",\n \"url\": \"current page URL - use 'id' if that is the unique identifier for your account's inventory\",\n \"referrer\": \"referring page URL (or 'id' if using IDs)\",\n \"pageviewId\": \"34219bae-e05d-4c6d-b964-d7d051be7661 - A unique identifier for the pageview. This is helpful if you are sending many different events per pageview. Optional but recommended.\",\n \"host\": \"The user's IP address. We extract geolocation information from this. Optional but recommended.\",\n \"userAgent\": \"Mozilla/5.0 (Windows NT 6.3; Win64; x64; rv:56.0) Gecko/20100101 Firefox/56.0. The browser's userAgent string. Optional but recommended.\",\n \"sourceWidgetName\": \"The name of the widget the user clicked on to arrive at the current pageview. Discard if not applicable.\",\n \"deviceType\": \"desktop, mobile, or tablet. Optional.\",\n \"os\": \"The user's device operating system, if detectable. Optional.\",\n \"sessionId\": \"a95eeafe-d5bf-4064-85c1-eaf5710d67e3 - A unique identifier you can send in to identify a single user session. Optional.\"\n} ] }"},"url":"https://query.petametrics.com/v3/jsk/userId/activity"},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Alt-Svc","value":"clear","name":"Alt-Svc","description":"Custom header"},{"key":"Content-Length","value":"63","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"text/plain; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Mon, 21 May 2018 20:29:50 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"nginx/1.12.2","name":"Server","description":"A name for the server"},{"key":"Via","value":"1.1 google","name":"Via","description":"Informs the client of proxies through which the response was sent."}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 200,\n \"status\": \"OK: 1 activity successfully recorded.\"\n}"},{"id":"8aacf00d-fe5e-4c27-ab3a-de287d4ee6f2","name":"pageview - timestamp not in epoch format","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-api-key","value":"","description":"Your API Key"}],"body":{"mode":"raw","raw":"{\"activities\" : [\n {\"timestamp\" : \"\",\n \"type\": \"pageview\",\n \"url\": \"current page URL - use 'id' if that is the unique identifier for your account's inventory\",\n \"referrer\": \"referring page URL (or 'id' if using IDs)\",\n \"pageviewId\": \"34219bae-e05d-4c6d-b964-d7d051be7661 - A unique identifier for the pageview. This is helpful if you are sending many different events per pageview. Optional but recommended.\",\n \"host\": \"The user's IP address. We extract geolocation information from this. Optional but recommended.\",\n \"userAgent\": \"Mozilla/5.0 (Windows NT 6.3; Win64; x64; rv:56.0) Gecko/20100101 Firefox/56.0. The browser's userAgent string. Optional but recommended.\",\n \"sourceWidgetName\": \"The name of the widget the user clicked on to arrive at the current pageview. Discard if not applicable.\",\n \"deviceType\": \"desktop, mobile, or tablet. Optional.\",\n \"os\": \"The user's device operating system, if detectable. Optional.\",\n \"sessionId\": \"a95eeafe-d5bf-4064-85c1-eaf5710d67e3 - A unique identifier you can send in to identify a single user session. Optional.\"\n} ] }"},"url":{"raw":"https://query.petametrics.com/v3/:jsk/activity","protocol":"https","host":["query","petametrics","com"],"path":["v3",":jsk","activity"],"variable":[{"key":"jsk","value":""}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"plain","header":[{"key":"Alt-Svc","value":"clear","name":"Alt-Svc","description":"Custom header"},{"key":"Content-Length","value":"35","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"text/plain; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Tue, 22 May 2018 02:32:28 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"nginx/1.12.2","name":"Server","description":"A name for the server"},{"key":"Via","value":"1.1 google","name":"Via","description":"Informs the client of proxies through which the response was sent."}],"cookie":[],"responseTime":null,"body":"There was an internal server error."}],"_postman_id":"c31e9ba8-e452-4aa2-bd46-ba401d395969"},{"name":"widget_shown","id":"582f2f33-342e-4449-ad67-4aa9de38bc87","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-api-key","value":"","description":"Your API Key
\n"}],"body":{"mode":"raw","raw":"{\"activities\" : [\n {\n \"timestamp\": \"The epoch timestamp of the event in millisecond format.\",\n \"type\": \"widget_shown\",\n \"widgetName\": \"your-widget-name\",\n \"visibleItems\": [\"list of all recommended items in widget as a JSON array\"],\n \"url\": \"current page URL - use 'id' if that is the unique identifier for your account's inventory\",\n \"source\": \"LI\" if recommended items generated by LiftIgniter or \"base\" if in control slice,\n \"referrer\": \"referring page URL or ID)\",\n \"pageviewId\": \"34219bae-e05d-4c6d-b964-d7d051be7661 - A unique identifier for the pageview. This is helpful if you are sending many different events per pageview. Optional but recommended.\",\n \"host\": \"The user's IP address. We extract geolocation information from this. Optional but recommended.\",\n \"userAgent\": \"Mozilla/5.0 (Windows NT 6.3; Win64; x64; rv:56.0) Gecko/20100101 Firefox/56.0. The browser's userAgent string. Optional but recommended.\",\n \"deviceType\": \"desktop, mobile, or tablet. Optional.\",\n \"os\": \"The user's device operating system, if detectable. Optional.\",\n \"sessionId\": \"a95eeafe-d5bf-4064-85c1-eaf5710d67e3 - A unique identifier you can send in to identify a single user session. Optional.\"\n}]}"},"url":"https://query.petametrics.com/v3/jsk/userId/activity","description":"Widget_shown events indicate that a set of recommendations were loaded somewhere on the page. They may not necessarily be visible to the user on page load (that is tracked via widget_visible events). This is an important indicator for our algorithms, and also allows us to calculate the Click-Through Rate for each widget and the items within them.
\nPlease ensure that the values for jsk and userId are replaced in the URL path.
\nYour jsk (Javascript Key) is available in your LiftIgniter Account under Settings.
\n","urlObject":{"protocol":"https","path":["v3","jsk","userId","activity"],"host":["query","petametrics","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"582f2f33-342e-4449-ad67-4aa9de38bc87"},{"name":"widget_visible","id":"ba0b9198-c209-4dad-af20-62c897f93659","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-api-key","value":"","description":"Your API Key
\n"}],"body":{"mode":"raw","raw":"{\"activities\" : [\n {\n \"timestamp\": \"The epoch timestamp of the event in millisecond format.\",\n \"type\": \"widget_visible\",\n \"widgetName\": \"your-widget-name\",\n \"visibleItems\": [\"list of all recommended items in widget as a JSON array\"],\n \"url\": \"current page URL - use 'id' if that is the unique identifier for your account's inventory\",\n \"source\": \"LI\" if recommended items generated by LiftIgniter or \"base\" if in control slice,\n \"referrer\": \"referring page URL or ID)\",\n \"pageviewId\": \"34219bae-e05d-4c6d-b964-d7d051be7661 - A unique identifier for the pageview. This is helpful if you are sending many different events per pageview. Optional but recommended.\",\n \"host\": \"The user's IP address. We extract geolocation information from this. Optional but recommended.\",\n \"userAgent\": \"Mozilla/5.0 (Windows NT 6.3; Win64; x64; rv:56.0) Gecko/20100101 Firefox/56.0. The browser's userAgent string. Optional but recommended.\",\n \"deviceType\": \"desktop, mobile, or tablet. Optional.\",\n \"os\": \"The user's device operating system, if detectable. Optional.\",\n \"sessionId\": \"a95eeafe-d5bf-4064-85c1-eaf5710d67e3 - A unique identifier you can send in to identify a single user session. Optional.\"\n}]}"},"url":"https://query.petametrics.com/v3/jsk/userId/activity","description":"Widget_visible events indicate that a set of recommended items has been scrolled into the user's viewport. Widget visibility is a very strong indicator for our models, because if a user doesn't click on an item, we know that it was because the recommendations were not interesting to that user, rather than because they did not see them at all.\nThe visible_items parameter in widget_visible events should contain only those items that are actually visible to the user. For example, if you have requested 9 items, but only 3 are visible to the user at any one time (e.g. a carousel of items), you would want to send a widget_visible event with only the 3 items listed in visibleItems.
\nPlease ensure that the values for jsk and userId are replaced in the URL path.
\nYour jsk (Javascript Key) is available in your LiftIgniter Account under Settings.
\n","urlObject":{"protocol":"https","path":["v3","jsk","userId","activity"],"host":["query","petametrics","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"ba0b9198-c209-4dad-af20-62c897f93659"},{"name":"widget_click","id":"6c142e32-f409-4aa0-b78b-b9c8bf57262d","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-api-key","value":"","description":"Your API Key
\n"}],"body":{"mode":"raw","raw":"{\"activities\" : [\n {\n \"timestamp\": \"The epoch timestamp of the event in millisecond format.\",\n \"type\": \"widget_click\",\n \"widgetName\": \"your-widget-name\",\n \"visibleItems\": [\"list of all recommended items in widget as a JSON array\"],\n \"clickUrl\": \"The URL of the item that was clicked on\",\n \"url\": \"current page URL - use 'id' if that is the unique identifier for your account's inventory\",\n \"source\": \"LI\" if recommended items generated by LiftIgniter or \"base\" if in control slice,\n \"referrer\": \"referring page URL or ID)\",\n \"pageviewId\": \"34219bae-e05d-4c6d-b964-d7d051be7661 - A unique identifier for the pageview. This is helpful if you are sending many different events per pageview. Optional but recommended.\",\n \"host\": \"The user's IP address. We extract geolocation information from this. Optional but recommended.\",\n \"userAgent\": \"Mozilla/5.0 (Windows NT 6.3; Win64; x64; rv:56.0) Gecko/20100101 Firefox/56.0. The browser's userAgent string. Optional but recommended.\",\n \"deviceType\": \"desktop, mobile, or tablet. Optional.\",\n \"os\": \"The user's device operating system, if detectable. Optional.\",\n \"sessionId\": \"a95eeafe-d5bf-4064-85c1-eaf5710d67e3 - A unique identifier you can send in to identify a single user session. Optional.\"\n}]}"},"url":"https://query.petametrics.com/v3/jsk/userId/activity","description":"A widget_click is best thought of as a navigational click - the user is simply going from page A to page B. It indicates an interest in the content of page B, and is one of the most powerful signals used by our models. Widget_click events are required for our integration.
\nPlease ensure that the values for jsk and userId are replaced in the URL path.
\nYour jsk (Javascript Key) is available in your LiftIgniter Account under Settings.
\n","urlObject":{"protocol":"https","path":["v3","jsk","userId","activity"],"host":["query","petametrics","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"6c142e32-f409-4aa0-b78b-b9c8bf57262d"},{"name":"engaged","id":"b0c95281-0c4c-448c-a486-0f06a162660f","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-api-key","value":"","description":"Your API Key
\n"}],"body":{"mode":"raw","raw":"{\"activities\" : [{\n \"timestamp\": \"The epoch timestamp of the event in millisecond format.\",\n \"type\": \"engaged\",\n \"engaged_t\": \"like\",\n \"url\": \"current page URL OR use 'id' if that is the unique identifier for your account's inventory\",\n \"source\": \"LI\" if recommended items generated by LiftIgniter or \"base\" if in control slice,\n \"referrer\": \"referring page URL (or ID # if using IDs as the unique identifier for your account's inventory)\",\n \"pageviewId\": \"34219bae-e05d-4c6d-b964-d7d051be7661 - A unique identifier for the pageview. This is helpful if you are sending many different events per pageview. Optional but recommended.\",\n \"host\": \"The user's IP address. We extract geolocation information from this. Optional but recommended.\",\n \"userAgent\": \"Mozilla/5.0 (Windows NT 6.3; Win64; x64; rv:56.0) Gecko/20100101 Firefox/56.0. The browser's userAgent string. Optional but recommended.\",\n \"deviceType\": \"desktop, mobile, or tablet. Optional.\",\n \"os\": \"The user's device operating system, if detectable. Optional.\",\n \"sessionId\": \"a95eeafe-d5bf-4064-85c1-eaf5710d67e3 - A unique identifier you can send in to identify a single user session. Optional.\"\n}]}"},"url":"https://query.petametrics.com/v3/jsk/userId/activity","description":"Engaged events introduce a new parameter: \"engaged_t\". This field accepts any string value, and can be used to identify the type of positive engagement event that occurred. Engaged events can include:
\nNegative engagement (e.g. downvoting or disliking a page or item) is not currently tracked by default. If this is an important component of your app or site experience, please contact Support!
\nPlease ensure that the values for jsk and userId are replaced in the URL path.
\nYour jsk (Javascript Key) is available in your LiftIgniter Account under Settings.
\n","urlObject":{"protocol":"https","path":["v3","jsk","userId","activity"],"host":["query","petametrics","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"b0c95281-0c4c-448c-a486-0f06a162660f"},{"name":"conversion","id":"6dcf42b2-c1dc-4e8f-a7cd-c0e879b76655","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-api-key","value":"","description":"Your API Key
\n"}],"body":{"mode":"raw","raw":"{\"activities\" : [{\n \"timestamp\": \"The epoch timestamp of the event in millisecond format.\",\n \"type\": \"conversion\",\n \"conversion_t\": \"purchased\",\n \"widgetName\": \"your-widget-name\",\n \"url\": \"current page URL - use 'id' if that is the unique identifier for your account's inventory\",\n \"source\": \"LI\" if recommended items generated by LiftIgniter or \"base\" if in control slice,\n \"referrer\": \"referring page URL (or 'id' if using IDs)\",\n \"pageviewId\": \"34219bae-e05d-4c6d-b964-d7d051be7661 - A unique identifier for the pageview. This is helpful if you are sending many different events per pageview. Optional but recommended.\",\n \"host\": \"The user's IP address. We extract geolocation information from this. Optional but recommended.\",\n \"userAgent\": \"Mozilla/5.0 (Windows NT 6.3; Win64; x64; rv:56.0) Gecko/20100101 Firefox/56.0. The browser's userAgent string. Optional but recommended.\",\n \"deviceType\": \"desktop, mobile, or tablet. Optional.\",\n \"os\": \"The user's device operating system, if detectable. Optional.\",\n \"sessionId\": \"a95eeafe-d5bf-4064-85c1-eaf5710d67e3 - A unique identifier you can send in to identify a single user session. Optional.\"\n}]}"},"url":"https://query.petametrics.com/v3/jsk/userId/activity","description":"Conversion events use a new parameter: \"conversion_t\". This field accepts any string value, and can be used to identify the type of conversion event that occurred. Conversion events can include:
\nA note on attribution:
\nConversion events should be tied back to the widget that contributed to the conversion. In some scenarios (a user clicked on a widget at the beginning of their session, then went through several more pages before converting) the link between widget_click and conversion may be very weak. In others (a user clicked on a product recommendation, added it to cart, and proceeded to purchase) it may be very clear.
\nIn general, if a widget_click immediately preceded a conversion, we recommend attributing the conversion to that widget. Attribution in other scenarios is a matter of preference - be aware that conversion is a very strong signal, and does affect model optimization!
\nPlease ensure that the values for jsk and userId are replaced in the URL path.
\nYour jsk (Javascript Key) is available in your LiftIgniter Account under Settings.
\n","urlObject":{"protocol":"https","path":["v3","jsk","userId","activity"],"host":["query","petametrics","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"6dcf42b2-c1dc-4e8f-a7cd-c0e879b76655"},{"name":"Sending Multiple Activities","id":"5de5e059-de7e-409e-88eb-964ac338d364","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-api-key","value":"your_api_key"}],"body":{"mode":"raw","raw":"{\"activities\" : [\n {\n \"timestamp\": \"The epoch timestamp of the event in millisecond format.\",\n \"type\": \"pageview\",\n \"url\": \"current page URL - use 'id' if that is the unique identifier for your account's inventory\",\n \"referrer\": \"referring page URL (or 'id' if using IDs)\",\n \"pageviewId\": \"34219bae-e05d-4c6d-b964-d7d051be7661 - A unique identifier for the pageview. This is helpful if you are sending many different events per pageview. Optional but recommended.\",\n \"host\": \"The user's IP address. We extract geolocation information from this. Optional but recommended.\",\n \"userAgent\": \"Mozilla/5.0 (Windows NT 6.3; Win64; x64; rv:56.0) Gecko/20100101 Firefox/56.0. The browser's userAgent string. Optional but recommended.\",\n \"sourceWidgetName\": \"The name of the widget the user clicked on to arrive at the current pageview. Discard if not applicable.\",\n \"deviceType\": \"desktop, mobile, or tablet. Optional.\",\n \"os\": \"The user's device operating system, if detectable. Optional.\",\n \"sessionId\": \"a95eeafe-d5bf-4064-85c1-eaf5710d67e3 - A unique identifier you can send in to identify a single user session. Optional.\"\n},\n {\n \"timestamp\": \"The epoch timestamp of the event in millisecond format.\",\n \"type\": \"widget_shown\",\n \"widgetName\": \"your-widget-name\",\n \"visibleItems\": [\"list of all recommended items in widget as a JSON array\"],\n \"url\": \"current page URL - use 'id' if that is the unique identifier for your account's inventory\",\n \"source\": \"LI\" if recommended items generated by LiftIgniter or \"base\" if in control slice,\n \"referrer\": \"referring page URL or ID)\",\n \"pageviewId\": \"34219bae-e05d-4c6d-b964-d7d051be7661 - A unique identifier for the pageview. This is helpful if you are sending many different events per pageview. Optional but recommended.\",\n \"host\": \"The user's IP address. We extract geolocation information from this. Optional but recommended.\",\n \"userAgent\": \"Mozilla/5.0 (Windows NT 6.3; Win64; x64; rv:56.0) Gecko/20100101 Firefox/56.0. The browser's userAgent string. Optional but recommended.\",\n \"deviceType\": \"desktop, mobile, or tablet. Optional.\",\n \"os\": \"The user's device operating system, if detectable. Optional.\",\n \"sessionId\": \"a95eeafe-d5bf-4064-85c1-eaf5710d67e3 - A unique identifier you can send in to identify a single user session. Optional.\"\n}\n]}"},"url":"https://query.petametrics.com/v3/jsk/userId/activity","description":"You can send multiple activities in a single call by bundling them together as an array in the \"activities\" JSON object. Please note that you cannot send activities for multiple userIds in one batch, as the userId is part of the URL path.
\nPlease ensure that the values for jsk and userId are replaced in the URL path.
\nYour jsk (Javascript Key) is available in your LiftIgniter Account under Settings.
\n","urlObject":{"protocol":"https","path":["v3","jsk","userId","activity"],"host":["query","petametrics","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"5de5e059-de7e-409e-88eb-964ac338d364"}],"id":"6b9059f8-ec56-46c3-a39b-517763fa110c","description":"V2 of our model and activity endpoints are being deprecated in favor of a new v3 version. The major changes between v2 and v3 are:
\nThis allows our infrastructure to more efficiently route traffic and utilize resources for faster response times.
\nFor more details, please see our Support article at https://support.liftigniter.com/support/solutions/articles/30000028475-changes-required-in-api-v3
\nThe calls in this section detail the JSON body needed for each type of event.
\nThe key difference between each event is the \"type\" parameter within the JSON. Some activity types require additional information.
\n","event":[{"listen":"prerequest","script":{"id":"5f733b72-40a6-4462-8c7b-23c68b9bcc51","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"4ae61717-c41e-4853-8172-c29e178c5ead","type":"text/javascript","exec":[""]}}],"_postman_id":"6b9059f8-ec56-46c3-a39b-517763fa110c"},{"name":"Users","item":[{"name":"Add User Data","id":"f1086038-210b-a501-1de9-9d0617f6c055","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"apiKey\": \"your_api_key\",\r\n \"users\" : [\r\n {\r\n \"userId\" : \"alfred01\",\r\n \"prefernces\": [\"apples\", \"bananas\", \"oranges\"]\r\n },\r\n {\r\n \"userId\" : \"charlie84\",\r\n \"prefernces\": [\"apples\", \"cantaloupes\", \"pineapple\"]\r\n }\r\n ]\r\n}"},"url":"https://api.petametrics.com/v1/user","description":"It is not necessary to register a userId prior to sending activity or model requests. We will automatically start a new user activity history whenever we receive a new userId from either the /activity, /model, or /user endpoints.
\nIn order for us to correlate user activity and model queries, you need to include the same userId value in the activity and in the model queries. If you do so, we will match the userId against the user data store and personalize our recommendations based on their browsing and recommendation interaction history.
\n","urlObject":{"protocol":"https","path":["v1","user"],"host":["api","petametrics","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"f1086038-210b-a501-1de9-9d0617f6c055"},{"name":"Get User Info","id":"804755d6-2115-511e-b718-3b1d184dd053","request":{"method":"GET","header":[{"key":"x-api-key","value":"your_api_key"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.petametrics.com/v1/user/:userId","description":"See the additional metadata information currently associated with a particular user ID.
\n","urlObject":{"protocol":"https","path":["v1","user",":userId"],"host":["api","petametrics","com"],"query":[],"variable":[{"description":{"content":"ID of the user to reference
\n","type":"text/plain"},"type":"any","value":"","key":"userId"}]}},"response":[],"_postman_id":"804755d6-2115-511e-b718-3b1d184dd053"},{"name":"Delete user by ID","id":"b9de3e1a-3ae5-f2c9-a76f-bc2b9c7f990c","request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"apiKey\": \"your_api_key\",\r\n \"users\" : [\r\n {\r\n \"userId\" : \"alfred01\"\r\n },\r\n {\r\n \"userId\" : \"charlie84\"\r\n }\r\n ]\r\n}"},"url":"https://api.petametrics.com/v1/user","description":"When the deletion request is sent, our API does not check for whether or not the user exists. Rather, it simply marks the user for deletion. If theuser does not exist, this has no effect. If the item does exist, then the deletion is carried out.
\nThe main advantage of this is that you can send a deletion command for a large number of users, and we can immediately accept this rather than checking for the existence of each of the users in the list you sent.
\n","urlObject":{"protocol":"https","path":["v1","user"],"host":["api","petametrics","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"b9de3e1a-3ae5-f2c9-a76f-bc2b9c7f990c"}],"id":"4d1fa7ce-bcbb-121e-1d49-1a4a2c7b09db","description":"It is not necessary to send additional user data, other than tracking them with a specific, unique and persistent userId. However, we do allow sending non-personally identifying information (PII) in order to provide more context for our models.
\n","event":[{"listen":"prerequest","script":{"id":"c3154113-f3b1-44b0-b6ae-181a2e89b46e","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f52a27aa-c54b-4b1d-8921-7ea60dcc6095","type":"text/javascript","exec":[""]}}],"_postman_id":"4d1fa7ce-bcbb-121e-1d49-1a4a2c7b09db"},{"name":"Analytics","item":[{"name":"Activity Summary (Traffic Chart)","id":"eba9758a-a00a-49bd-a524-5879ee069141","request":{"method":"POST","header":[{"key":"x-api-key","value":"","description":"Your API Key
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"query\": \"activitySummary\", \n \"startTime\": \"2018-03-05 00:00:00\", \n \"endTime\": \"2018-03-08 00:00:00\",\n \"timeZone\": \"America/Los_Angeles\",\n \"activityTypes\": [\"pageview\", \"widget_visible\", \"widget_click\"],\n \"granularity\": \"day\"\n}"},"url":"https://labapi.liftigniter.com/v1/query","description":"Returns activity type counts as a time-series with a specified granularity.
\nRequired parameters:
\nOptional parameters:
\nThis will create a queued job to run the query. The response will contain a jobId to be used in the retrieval query (https://labapi.liftigniter.com/v1/query?jobId=)
\nThe response for the retrieval query will contain a JSON array with the widget_click counts for each variant, then the widget_visible counts. These counts can then be used to calculate the VCTR for each variant.
\n","urlObject":{"protocol":"https","path":["v1","query"],"host":["labapi","liftigniter","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"eba9758a-a00a-49bd-a524-5879ee069141"},{"name":"E-commerce Revenue Metrics (E-commerce Chart)","id":"ad3bfbe4-3b7f-4df2-a783-df241d55103b","request":{"method":"POST","header":[{"key":"x-api-key","value":"","description":"Your API Key
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"query\": \"ecommerce\", \n \"startTime\": \"2018-03-05 00:00:00\", \n \"endTime\": \"2018-03-08 00:00:00\"\n}"},"url":"https://labapi.liftigniter.com/v1/query","description":"Returns Ecommerce revenue and cart count metrics.
\nRequired parameters:
\nThe results for this query will be returned immediately.
\n","urlObject":{"protocol":"https","path":["v1","query"],"host":["labapi","liftigniter","com"],"query":[],"variable":[]}},"response":[{"id":"a80a0cf0-93e1-4431-9fea-f5dcf4b4bc59","name":"E-commerce Revenue Metrics (E-commerce Chart)","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"0241a412-0d46-4875-bf78-d5c0fc2a137a","description":"Your API Key","disabled":false},{"key":"Content-Type","value":"application/json","disabled":false}],"body":{"mode":"raw","raw":"{\n \"query\": \"ecommerce\", \n \"startTime\": \"2018-03-05 00:00:00\", \n \"endTime\": \"2018-03-08 00:00:00\"\n}"},"url":"https://labapi.liftigniter.com/v1/query"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Alt-Svc","value":"clear","name":"Alt-Svc","description":"Custom header"},{"key":"Content-Length","value":"3910","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Security-Policy","value":"default-src 'self'","name":"Content-Security-Policy","description":"Custom header"},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Thu, 26 Apr 2018 03:32:56 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Referrer-Policy","value":"origin-when-cross-origin, strict-origin-when-cross-origin","name":"Referrer-Policy","description":"Custom header"},{"key":"Strict-Transport-Security","value":"max-age=31536000","name":"Strict-Transport-Security","description":"A HSTS Policy informing the HTTP client how long to cache the HTTPS only policy and whether this applies to subdomains."},{"key":"Via","value":"1.1 google","name":"Via","description":"Informs the client of proxies through which the response was sent."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"DENY","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-Permitted-Cross-Domain-Policies","value":"master-only","name":"X-Permitted-Cross-Domain-Policies","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"format\": \"immediate\",\n \"cacheHit\": false,\n \"bytesProcessed\": 0,\n \"totalRows\": 72,\n \"nextPageToken\": null,\n \"columnNames\": [\n {\n \"name\": \"date\",\n \"type\": \"STRING\"\n },\n {\n \"name\": \"source\",\n \"type\": \"STRING\"\n },\n {\n \"name\": \"attributionLevel\",\n \"type\": \"STRING\"\n },\n {\n \"name\": \"metric\",\n \"type\": \"STRING\"\n },\n {\n \"name\": \"count\",\n \"type\": \"FLOAT\"\n }\n ],\n \"columnValues\": [\n [\n \"2018-03-05\",\n \"base\",\n \"cart\",\n \"revenue\",\n 0\n ],\n [\n \"2018-03-05\",\n \"base\",\n \"cart\",\n \"quantity\",\n 0\n ],\n [\n \"2018-03-05\",\n \"base\",\n \"cart\",\n \"item_count\",\n 0\n ],\n [\n \"2018-03-05\",\n \"base\",\n \"confirmed\",\n \"revenue\",\n 0\n ],\n [\n \"2018-03-05\",\n \"base\",\n \"confirmed\",\n \"quantity\",\n 0\n ],\n [\n \"2018-03-05\",\n \"base\",\n \"confirmed\",\n \"item_count\",\n 0\n ],\n [\n \"2018-03-05\",\n \"LI\",\n \"cart\",\n \"revenue\",\n 3151.25\n ],\n [\n \"2018-03-05\",\n \"LI\",\n \"cart\",\n \"quantity\",\n 100\n ],\n [\n \"2018-03-05\",\n \"LI\",\n \"cart\",\n \"item_count\",\n 100\n ],\n [\n \"2018-03-05\",\n \"LI\",\n \"confirmed\",\n \"revenue\",\n 131.8\n ],\n [\n \"2018-03-05\",\n \"LI\",\n \"confirmed\",\n \"quantity\",\n 10\n ],\n [\n \"2018-03-05\",\n \"LI\",\n \"confirmed\",\n \"item_count\",\n 2\n ]\n ]\n}"}],"_postman_id":"ad3bfbe4-3b7f-4df2-a783-df241d55103b"},{"name":"Widget Performance (Performance Chart)","id":"326f461d-14e1-4cd5-9d32-3963a9325f9f","request":{"method":"POST","header":[{"key":"x-api-key","value":"","description":"Your API Key
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"query\": \"performance\", \n \"startTime\": \"2018-03-05 00:00:00\", \n \"endTime\": \"2018-03-08 00:00:00\",\n \"validTypes\": [\"widget_shown\", \"widget_visible\", \"widget_click\", \"pageview\", \"stuck_10s\", \"stuck_3m\", \"engaged\", \"conversion\"]\n}"},"url":"https://labapi.liftigniter.com/v1/query","description":"Returns widget performance metrics
\nRequired parameters:
\nOptional parameters:
\nThe results for this query will be returned immediately.
\n","urlObject":{"protocol":"https","path":["v1","query"],"host":["labapi","liftigniter","com"],"query":[],"variable":[]}},"response":[{"id":"9aeca049-a439-4d93-acba-db9d2436e76a","name":"Widget Performance","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"demo-key","description":"Your API Key"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"query\": \"performance\", \n \"startTime\": \"2018-03-05 00:00:00\", \n \"endTime\": \"2018-03-08 00:00:00\",\n \"timeZone\": \"America/Los_Angeles\",\n \"activityTypes\": [\"pageview\", \"widget_visible\", \"widget_click\"],\n \"granularity\": \"day\"\n}"},"url":"https://labapi.liftigniter.com/v1/query"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Alt-Svc","value":"clear","name":"Alt-Svc","description":"Custom header"},{"key":"Content-Length","value":"5584","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Security-Policy","value":"default-src 'self'","name":"Content-Security-Policy","description":"Custom header"},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 13 Apr 2018 22:15:13 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Referrer-Policy","value":"origin-when-cross-origin, strict-origin-when-cross-origin","name":"Referrer-Policy","description":"Custom header"},{"key":"Strict-Transport-Security","value":"max-age=31536000","name":"Strict-Transport-Security","description":"A HSTS Policy informing the HTTP client how long to cache the HTTPS only policy and whether this applies to subdomains."},{"key":"Via","value":"1.1 google","name":"Via","description":"Informs the client of proxies through which the response was sent."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"DENY","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-Permitted-Cross-Domain-Policies","value":"master-only","name":"X-Permitted-Cross-Domain-Policies","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[],"responseTime":null,"body":"{\"status\":\"success\",\"format\":\"immediate\",\"cacheHit\":false,\"bytesProcessed\":0,\"totalRows\":96,\"nextPageToken\":null,\"columnNames\":[{\"name\":\"date\",\"type\":\"STRING\"},{\"name\":\"widgetName\",\"type\":\"STRING\"},{\"name\":\"source\",\"type\":\"STRING\"},{\"name\":\"type\",\"type\":\"STRING\"},{\"name\":\"counts\",\"type\":\"INTEGER\"}],\"columnValues\":[[\"2018-03-05\",\"overall\",\"LI\",\"widget_shown\",3247],[\"2018-03-05\",\"overall\",\"LI\",\"widget_visible\",1646],[\"2018-03-05\",\"overall\",\"LI\",\"widget_click\",72],[\"2018-03-05\",\"overall\",\"LI\",\"pageview\",123],[\"2018-03-05\",\"overall\",\"LI\",\"stuck_10s\",109],[\"2018-03-05\",\"overall\",\"LI\",\"stuck_3m\",56],[\"2018-03-05\",\"article-end-widget1\",\"LI\",\"widget_shown\",925],[\"2018-03-05\",\"article-end-widget1\",\"LI\",\"widget_visible\",260],[\"2018-03-05\",\"article-end-widget1\",\"LI\",\"widget_click\",21],[\"2018-03-05\",\"article-end-widget1\",\"LI\",\"pageview\",24],[\"2018-03-05\",\"article-end-widget1\",\"LI\",\"stuck_10s\",23],[\"2018-03-05\",\"article-end-widget1\",\"LI\",\"stuck_3m\",12],[\"2018-03-05\",\"article-end-widget2\",\"LI\",\"widget_shown\",924],[\"2018-03-05\",\"article-end-widget2\",\"LI\",\"widget_visible\",249],[\"2018-03-05\",\"article-end-widget2\",\"LI\",\"widget_click\",9],[\"2018-03-05\",\"article-end-widget2\",\"LI\",\"pageview\",15],[\"2018-03-05\",\"article-end-widget2\",\"LI\",\"stuck_10s\",13],[\"2018-03-05\",\"article-end-widget2\",\"LI\",\"stuck_3m\",8],[\"2018-03-05\",\"sidebar-widget\",\"LI\",\"widget_shown\",1398],[\"2018-03-05\",\"sidebar-widget\",\"LI\",\"widget_visible\",1137],[\"2018-03-05\",\"sidebar-widget\",\"LI\",\"widget_click\",42],[\"2018-03-05\",\"sidebar-widget\",\"LI\",\"pageview\",44],[\"2018-03-05\",\"sidebar-widget\",\"LI\",\"stuck_10s\",38],[\"2018-03-05\",\"sidebar-widget\",\"LI\",\"stuck_3m\",17],[\"2018-03-06\",\"overall\",\"LI\",\"widget_shown\",3538],[\"2018-03-06\",\"overall\",\"LI\",\"widget_visible\",1865],[\"2018-03-06\",\"overall\",\"LI\",\"widget_click\",91],[\"2018-03-06\",\"overall\",\"LI\",\"pageview\",144],[\"2018-03-06\",\"overall\",\"LI\",\"stuck_10s\",125],[\"2018-03-06\",\"overall\",\"LI\",\"stuck_3m\",70],[\"2018-03-06\",\"article-end-widget1\",\"LI\",\"widget_shown\",998],[\"2018-03-06\",\"article-end-widget1\",\"LI\",\"widget_visible\",295],[\"2018-03-06\",\"article-end-widget1\",\"LI\",\"widget_click\",36],[\"2018-03-06\",\"article-end-widget1\",\"LI\",\"pageview\",34],[\"2018-03-06\",\"article-end-widget1\",\"LI\",\"stuck_10s\",32],[\"2018-03-06\",\"article-end-widget1\",\"LI\",\"stuck_3m\",15],[\"2018-03-06\",\"article-end-widget2\",\"LI\",\"widget_shown\",999],[\"2018-03-06\",\"article-end-widget2\",\"LI\",\"widget_visible\",286],[\"2018-03-06\",\"article-end-widget2\",\"LI\",\"widget_click\",18],[\"2018-03-06\",\"article-end-widget2\",\"LI\",\"pageview\",21],[\"2018-03-06\",\"article-end-widget2\",\"LI\",\"stuck_10s\",20],[\"2018-03-06\",\"article-end-widget2\",\"LI\",\"stuck_3m\",9],[\"2018-03-06\",\"sidebar-widget\",\"LI\",\"widget_shown\",1541],[\"2018-03-06\",\"sidebar-widget\",\"LI\",\"widget_visible\",1284],[\"2018-03-06\",\"sidebar-widget\",\"LI\",\"widget_click\",37],[\"2018-03-06\",\"sidebar-widget\",\"LI\",\"pageview\",47],[\"2018-03-06\",\"sidebar-widget\",\"LI\",\"stuck_10s\",40],[\"2018-03-06\",\"sidebar-widget\",\"LI\",\"stuck_3m\",24],[\"2018-03-07\",\"overall\",\"LI\",\"widget_shown\",3731],[\"2018-03-07\",\"overall\",\"LI\",\"widget_visible\",1863],[\"2018-03-07\",\"overall\",\"LI\",\"widget_click\",113],[\"2018-03-07\",\"overall\",\"LI\",\"pageview\",183],[\"2018-03-07\",\"overall\",\"LI\",\"stuck_10s\",166],[\"2018-03-07\",\"overall\",\"LI\",\"stuck_3m\",73],[\"2018-03-07\",\"article-end-widget1\",\"LI\",\"widget_shown\",1048],[\"2018-03-07\",\"article-end-widget1\",\"LI\",\"widget_visible\",275],[\"2018-03-07\",\"article-end-widget1\",\"LI\",\"widget_click\",34],[\"2018-03-07\",\"article-end-widget1\",\"LI\",\"pageview\",39],[\"2018-03-07\",\"article-end-widget1\",\"LI\",\"stuck_10s\",36],[\"2018-03-07\",\"article-end-widget1\",\"LI\",\"stuck_3m\",11],[\"2018-03-07\",\"article-end-widget2\",\"LI\",\"widget_shown\",1043],[\"2018-03-07\",\"article-end-widget2\",\"LI\",\"widget_visible\",270],[\"2018-03-07\",\"article-end-widget2\",\"LI\",\"widget_click\",29],[\"2018-03-07\",\"article-end-widget2\",\"LI\",\"pageview\",27],[\"2018-03-07\",\"article-end-widget2\",\"LI\",\"stuck_10s\",24],[\"2018-03-07\",\"article-end-widget2\",\"LI\",\"stuck_3m\",16],[\"2018-03-07\",\"sidebar-widget\",\"LI\",\"widget_shown\",1640],[\"2018-03-07\",\"sidebar-widget\",\"LI\",\"widget_visible\",1318],[\"2018-03-07\",\"sidebar-widget\",\"LI\",\"widget_click\",50],[\"2018-03-07\",\"sidebar-widget\",\"LI\",\"pageview\",46],[\"2018-03-07\",\"sidebar-widget\",\"LI\",\"stuck_10s\",43],[\"2018-03-07\",\"sidebar-widget\",\"LI\",\"stuck_3m\",18],[\"2018-03-08\",\"overall\",\"LI\",\"widget_shown\",4474],[\"2018-03-08\",\"overall\",\"LI\",\"widget_visible\",2224],[\"2018-03-08\",\"overall\",\"LI\",\"widget_click\",120],[\"2018-03-08\",\"overall\",\"LI\",\"pageview\",185],[\"2018-03-08\",\"overall\",\"LI\",\"stuck_10s\",168],[\"2018-03-08\",\"overall\",\"LI\",\"stuck_3m\",71],[\"2018-03-08\",\"article-end-widget1\",\"LI\",\"widget_shown\",1334],[\"2018-03-08\",\"article-end-widget1\",\"LI\",\"widget_visible\",392],[\"2018-03-08\",\"article-end-widget1\",\"LI\",\"widget_click\",39],[\"2018-03-08\",\"article-end-widget1\",\"LI\",\"pageview\",43],[\"2018-03-08\",\"article-end-widget1\",\"LI\",\"stuck_10s\",40],[\"2018-03-08\",\"article-end-widget1\",\"LI\",\"stuck_3m\",14],[\"2018-03-08\",\"article-end-widget2\",\"LI\",\"widget_shown\",1330],[\"2018-03-08\",\"article-end-widget2\",\"LI\",\"widget_visible\",387],[\"2018-03-08\",\"article-end-widget2\",\"LI\",\"widget_click\",34],[\"2018-03-08\",\"article-end-widget2\",\"LI\",\"pageview\",29],[\"2018-03-08\",\"article-end-widget2\",\"LI\",\"stuck_10s\",27],[\"2018-03-08\",\"article-end-widget2\",\"LI\",\"stuck_3m\",11],[\"2018-03-08\",\"sidebar-widget\",\"LI\",\"widget_shown\",1810],[\"2018-03-08\",\"sidebar-widget\",\"LI\",\"widget_visible\",1445],[\"2018-03-08\",\"sidebar-widget\",\"LI\",\"widget_click\",47],[\"2018-03-08\",\"sidebar-widget\",\"LI\",\"pageview\",46],[\"2018-03-08\",\"sidebar-widget\",\"LI\",\"stuck_10s\",42],[\"2018-03-08\",\"sidebar-widget\",\"LI\",\"stuck_3m\",18]]}"}],"_postman_id":"326f461d-14e1-4cd5-9d32-3963a9325f9f"},{"name":"Top Items (Trending Items Chart)","id":"352a93fa-e7af-4c4a-bae4-345d9e80733b","request":{"method":"POST","header":[{"key":"x-api-key","value":"","description":"Your API Key
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"query\": \"topItems\", \n \"startTime\": \"2018-03-05 00:00:00\", \n \"endTime\": \"2018-03-08 00:00:00\",\n \"timeZone\": \"America/Los_Angeles\",\n \"numItems\": 200\n}"},"url":"https://labapi.liftigniter.com/v1/query","description":"This query fetches items with the highest number of clicks over the given time period, and returns the list of items along with the number of times each one was recommended, visible, and clicked.
\nRequired parameters:
\nOptional parameters:
\nThis will create a queued job to run the query. The response will contain a jobId to be used in the retrieval query (https://labapi.liftigniter.com/v1/query?jobId=)
\nThe response for the retrieval query will contain a JSON array with the widget_click counts for each variant, then the widget_visible counts. These counts can then be used to calculate the VCTR for each variant.
\n","urlObject":{"protocol":"https","path":["v1","query"],"host":["labapi","liftigniter","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"352a93fa-e7af-4c4a-bae4-345d9e80733b"},{"name":"Individual Item Stats","id":"bbdaa650-80fd-4c08-9e6c-61437c3eba33","request":{"method":"POST","header":[{"key":"x-api-key","value":"","description":"Your API Key
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"query\": \"itemStats\", \n \"startTime\": \"2018-03-05 00:00:00\", \n \"endTime\": \"2018-03-08 00:00:00\",\n \"itemId\": \"https://www.domain.com/2016/03/13/article-1/\",\n \"timeZone\": \"America/Los_Angeles\",\n \"granularity\": \"day\"\n}"},"url":"https://labapi.liftigniter.com/v1/query","description":"Returns activity type counts as a time-series for the specified item.
\nRequired parameters:
\nOptional parameters:
\nThis will create a queued job to run the query. The response will contain a jobId to be used in the retrieval query (https://labapi.liftigniter.com/v1/query?jobId=)
\nThe response for the retrieval query will contain a JSON array with the widget_click counts for each variant, then the widget_visible counts. These counts can then be used to calculate the VCTR for each variant.
\n","urlObject":{"protocol":"https","path":["v1","query"],"host":["labapi","liftigniter","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"bbdaa650-80fd-4c08-9e6c-61437c3eba33"},{"name":"Metadata A|B Testing","id":"ad962532-4b50-4150-92e4-ed72a1df39d4","request":{"method":"POST","header":[{"key":"x-api-key","value":"","description":"Your API Key
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"query\": \"multivariateTesting\", \n \"startTime\": \"2018-03-05 00:00:00\", \n \"endTime\": \"2018-03-08 00:00:00\",\n \"timeZone\": \"America/Los_Angeles\",\n \"items\": [\n {\n \"id\" : \"http://domain.com/articles/item-where-test-is-running\",\n \"fields\" : {\n \"altTitle\" : [\"Array of variants\", \"Title-Var-1\", \"Title-Var-2\"],\n \"altField\": [\"Array of variants\", \"Value-1\", \"Value-2\"]\n }\n }\n ]\n}"},"url":"https://labapi.liftigniter.com/v1/query","description":"This query defines the scope of the results being requested:
\nThis will create a queued job to run the query. The response will contain a jobId to be used in the retrieval query (https://labapi.liftigniter.com/v1/query?jobId=)
\nThe response for the retrieval query will contain a JSON array with the widget_click counts for each variant, then the widget_visible counts. These counts can then be used to calculate the VCTR for each variant.
\n","urlObject":{"protocol":"https","path":["v1","query"],"host":["labapi","liftigniter","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"ad962532-4b50-4150-92e4-ed72a1df39d4"},{"name":"Fetch Job Results","id":"66b339e2-0f38-417f-b696-7eb1d3140649","request":{"method":"GET","header":[{"key":"x-api-key","value":"","description":"Your API key
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://labapi.liftigniter.com/v1/query?jobId=","urlObject":{"protocol":"https","path":["v1","query"],"host":["labapi","liftigniter","com"],"query":[{"description":{"content":"The jobId returned for the specific query type.
\n","type":"text/plain"},"key":"jobId","value":""}],"variable":[]}},"response":[{"id":"33cbb743-0f06-446b-897c-cf9fe529ba6f","name":"Top Items - Fetch Job Results","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"demo-key","description":"Your API key"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://labapi.liftigniter.com/v1/query?jobId=admin_liftigniter-demo_a7a279c9-ac5b-46dc-926f-a70b79a41571","protocol":"https","host":["labapi","liftigniter","com"],"path":["v1","query"],"query":[{"key":"jobId","value":"admin_liftigniter-demo_a7a279c9-ac5b-46dc-926f-a70b79a41571","description":"The jobId returned for the specific query type."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Alt-Svc","value":"clear","name":"Alt-Svc","description":"Custom header"},{"key":"Content-Length","value":"16845","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Security-Policy","value":"default-src 'self'","name":"Content-Security-Policy","description":"Custom header"},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 13 Apr 2018 20:59:58 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Referrer-Policy","value":"origin-when-cross-origin, strict-origin-when-cross-origin","name":"Referrer-Policy","description":"Custom header"},{"key":"Strict-Transport-Security","value":"max-age=31536000","name":"Strict-Transport-Security","description":"A HSTS Policy informing the HTTP client how long to cache the HTTPS only policy and whether this applies to subdomains."},{"key":"Via","value":"1.1 google","name":"Via","description":"Informs the client of proxies through which the response was sent."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"DENY","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-Permitted-Cross-Domain-Policies","value":"master-only","name":"X-Permitted-Cross-Domain-Policies","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\": \"success\",\r\n \"format\": \"job\",\r\n \"cacheHit\": false,\r\n \"bytesProcessed\": 23082586,\r\n \"totalRows\": 200,\r\n \"nextPageToken\": null,\r\n \"columnNames\": [\r\n {\r\n \"name\": \"id\",\r\n \"type\": \"STRING\"\r\n },\r\n {\r\n \"name\": \"recommended\",\r\n \"type\": \"INTEGER\"\r\n },\r\n {\r\n \"name\": \"visible\",\r\n \"type\": \"INTEGER\"\r\n },\r\n {\r\n \"name\": \"clicked\",\r\n \"type\": \"INTEGER\"\r\n }\r\n ],\r\n \"columnValues\": [\r\n [\r\n \"https://www.domain.com/2016/02/17/article-1\",\r\n 1658,\r\n 936,\r\n 20\r\n ],\r\n [\r\n \"https://www.domain.com/2014/08/03/article-2/\",\r\n 942,\r\n 504,\r\n 15\r\n ],\r\n [\r\n \"https://www.domain.com/2016/05/09/article-3/\",\r\n 1087,\r\n 543,\r\n 12\r\n ],\r\n [\r\n \"https://www.domain.com/2015/02/02/article-4/\",\r\n 1151,\r\n 558,\r\n 11\r\n ],\r\n [\r\n \"https://www.domain.com/2016/07/20/article-5/\",\r\n 976,\r\n 480,\r\n 11\r\n ]\r\n ]\r\n}"},{"id":"b7bd3607-feb5-4cb3-a110-9f4005a77e34","name":"Metadata A|B Testing - Fetch Job Results","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"demo-key","description":"Your API key"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://labapi.liftigniter.com/v1/query?jobId=admin_liftigniter-demo_420dded7-4886-4d2a-8507-51c9bc5291d1","protocol":"https","host":["labapi","liftigniter","com"],"path":["v1","query"],"query":[{"key":"jobId","value":"admin_liftigniter-demo_420dded7-4886-4d2a-8507-51c9bc5291d1","description":"The jobId returned for the specific query type."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Alt-Svc","value":"clear","name":"Alt-Svc","description":"Custom header"},{"key":"Content-Length","value":"1793","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Security-Policy","value":"default-src 'self'","name":"Content-Security-Policy","description":"Custom header"},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 13 Apr 2018 20:38:31 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Referrer-Policy","value":"origin-when-cross-origin, strict-origin-when-cross-origin","name":"Referrer-Policy","description":"Custom header"},{"key":"Strict-Transport-Security","value":"max-age=31536000","name":"Strict-Transport-Security","description":"A HSTS Policy informing the HTTP client how long to cache the HTTPS only policy and whether this applies to subdomains."},{"key":"Via","value":"1.1 google","name":"Via","description":"Informs the client of proxies through which the response was sent."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"DENY","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-Permitted-Cross-Domain-Policies","value":"master-only","name":"X-Permitted-Cross-Domain-Policies","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\": \"success\",\r\n \"format\": \"job\",\r\n \"cacheHit\": false,\r\n \"bytesProcessed\": 478864804206,\r\n \"totalRows\": 10,\r\n \"nextPageToken\": null,\r\n \"columnNames\": [\r\n {\r\n \"name\": \"id\",\r\n \"type\": \"STRING\"\r\n },\r\n {\r\n \"name\": \"counts\",\r\n \"type\": \"INTEGER\"\r\n },\r\n {\r\n \"name\": \"type\",\r\n \"type\": \"STRING\"\r\n },\r\n {\r\n \"name\": \"altTitle\",\r\n \"type\": \"STRING\"\r\n }\r\n ],\r\n \"columnValues\": [\r\n [\r\n \"http://www.domain.com/articles/an-example-article\",\r\n 48,\r\n \"widget_click\",\r\n \"5 Reasons A|B Testing Is Awesome\"\r\n ],\r\n [\r\n \"http://www.domain.com/articles/an-example-article\",\r\n 36,\r\n \"widget_click\",\r\n \"A|B Testing and You\"\r\n ],\r\n [\r\n \"http://www.domain.com/articles/an-example-article\",\r\n 39,\r\n \"widget_click\",\r\n \"The Best Reasons To A|B Test\"\r\n ],\r\n [\r\n \"http://www.domain.com/articles/an-example-article\",\r\n 41,\r\n \"widget_click\",\r\n \"You Can A|B Test ANY Item Metadata To Display\"\r\n ],\r\n [\r\n \"http://www.domain.com/articles/an-example-article\",\r\n 38,\r\n \"widget_click\",\r\n \"Try Out A|B Testing Your Item Metadata Today!\"\r\n ],\r\n [\r\n \"http://www.domain.com/articles/an-example-article\",\r\n 51281,\r\n \"widget_visible\",\r\n \"5 Reasons A|B Testing Is Awesome\"\r\n ],\r\n [\r\n \"http://www.domain.com/articles/an-example-article\",\r\n 51365,\r\n \"widget_visible\",\r\n \"A|B Testing and You\"\r\n ],\r\n [\r\n \"http://www.domain.com/articles/an-example-article\",\r\n 51493,\r\n \"widget_visible\",\r\n \"The Best Reasons To A|B Test\"\r\n ],\r\n [\r\n \"http://www.domain.com/articles/an-example-article\",\r\n 51916,\r\n \"widget_visible\",\r\n \"You Can A|B Test ANY Item Metadata\"\r\n ],\r\n [\r\n \"http://www.domain.com/articles/an-example-article\",\r\n 51367,\r\n \"widget_visible\",\r\n \"Try Out A|B Testing Your Item Metadata Today!\"\r\n ]\r\n ]\r\n}"},{"id":"c0a6c26a-1fba-4b4f-94b9-12977c789f81","name":"Activity Summary - Fetch Job Results","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"demo-key","description":"Your API key"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://labapi.liftigniter.com/v1/query?jobId=admin_liftigniter-demo_79d8778b-c697-4335-8df4-717c5188b263","protocol":"https","host":["labapi","liftigniter","com"],"path":["v1","query"],"query":[{"key":"jobId","value":"admin_liftigniter-demo_79d8778b-c697-4335-8df4-717c5188b263","description":"The jobId returned for the specific query type."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Alt-Svc","value":"clear","name":"Alt-Svc","description":"Custom header"},{"key":"Content-Length","value":"633","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Security-Policy","value":"default-src 'self'","name":"Content-Security-Policy","description":"Custom header"},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 13 Apr 2018 20:27:41 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Referrer-Policy","value":"origin-when-cross-origin, strict-origin-when-cross-origin","name":"Referrer-Policy","description":"Custom header"},{"key":"Strict-Transport-Security","value":"max-age=31536000","name":"Strict-Transport-Security","description":"A HSTS Policy informing the HTTP client how long to cache the HTTPS only policy and whether this applies to subdomains."},{"key":"Via","value":"1.1 google","name":"Via","description":"Informs the client of proxies through which the response was sent."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"DENY","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-Permitted-Cross-Domain-Policies","value":"master-only","name":"X-Permitted-Cross-Domain-Policies","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[],"responseTime":null,"body":"{\"status\":\"success\",\"format\":\"job\",\"cacheHit\":false,\"bytesProcessed\":1519104,\"totalRows\":9,\"nextPageToken\":null,\"columnNames\":[{\"name\":\"datetime\",\"type\":\"STRING\"},{\"name\":\"type\",\"type\":\"STRING\"},{\"name\":\"count\",\"type\":\"INTEGER\"}],\"columnValues\":[[\"2018-03-05 00:00:00\",\"pageview\",1845],[\"2018-03-05 00:00:00\",\"widget_click\",95],[\"2018-03-05 00:00:00\",\"widget_visible\",1690],[\"2018-03-06 00:00:00\",\"pageview\",2055],[\"2018-03-06 00:00:00\",\"widget_click\",103],[\"2018-03-06 00:00:00\",\"widget_visible\",1855],[\"2018-03-07 00:00:00\",\"pageview\",2191],[\"2018-03-07 00:00:00\",\"widget_click\",148],[\"2018-03-07 00:00:00\",\"widget_visible\",1864]]}"},{"id":"c96a73b8-7b13-48e4-b005-4c4def693bd3","name":"Individual Item Stats - Fetch Job Results","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"demo-key","description":"Your API key"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://labapi.liftigniter.com/v1/query?jobId=admin_liftigniter-demo_a701b932-ef64-4d5a-89d8-30b7452d4199","protocol":"https","host":["labapi","liftigniter","com"],"path":["v1","query"],"query":[{"key":"jobId","value":"admin_liftigniter-demo_a701b932-ef64-4d5a-89d8-30b7452d4199","description":"The jobId returned for the specific query type."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Alt-Svc","value":"clear","name":"Alt-Svc","description":"Custom header"},{"key":"Content-Length","value":"7143","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Security-Policy","value":"default-src 'self'","name":"Content-Security-Policy","description":"Custom header"},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 13 Apr 2018 21:58:43 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Referrer-Policy","value":"origin-when-cross-origin, strict-origin-when-cross-origin","name":"Referrer-Policy","description":"Custom header"},{"key":"Strict-Transport-Security","value":"max-age=31536000","name":"Strict-Transport-Security","description":"A HSTS Policy informing the HTTP client how long to cache the HTTPS only policy and whether this applies to subdomains."},{"key":"Via","value":"1.1 google","name":"Via","description":"Informs the client of proxies through which the response was sent."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"DENY","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-Permitted-Cross-Domain-Policies","value":"master-only","name":"X-Permitted-Cross-Domain-Policies","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[],"responseTime":null,"body":"{\"status\":\"success\",\"format\":\"job\",\"cacheHit\":false,\"bytesProcessed\":27531657,\"totalRows\":166,\"nextPageToken\":null,\"columnNames\":[{\"name\":\"datetime\",\"type\":\"STRING\"},{\"name\":\"type\",\"type\":\"STRING\"},{\"name\":\"views\",\"type\":\"INTEGER\"}],\"columnValues\":[[\"2018-03-05 00:00:00\",\"widget_shown\",12],[\"2018-03-05 00:00:00\",\"widget_visible\",8],[\"2018-03-05 01:00:00\",\"pageview\",1],[\"2018-03-05 01:00:00\",\"stuck_10s\",1],[\"2018-03-05 01:00:00\",\"widget_click\",1],[\"2018-03-05 01:00:00\",\"widget_shown\",24],[\"2018-03-05 01:00:00\",\"widget_visible\",17],[\"2018-03-05 02:00:00\",\"widget_shown\",10],[\"2018-03-05 02:00:00\",\"widget_visible\",6],[\"2018-03-05 03:00:00\",\"widget_shown\",8],[\"2018-03-05 03:00:00\",\"widget_visible\",3],[\"2018-03-05 04:00:00\",\"pageview\",1],[\"2018-03-05 04:00:00\",\"stuck_10s\",1],[\"2018-03-05 04:00:00\",\"stuck_3m\",1],[\"2018-03-05 04:00:00\",\"widget_shown\",20],[\"2018-03-05 04:00:00\",\"widget_visible\",13],[\"2018-03-05 05:00:00\",\"widget_shown\",6],[\"2018-03-05 05:00:00\",\"widget_visible\",4],[\"2018-03-05 06:00:00\",\"widget_shown\",14],[\"2018-03-05 06:00:00\",\"widget_visible\",8],[\"2018-03-05 07:00:00\",\"pageview\",1],[\"2018-03-05 07:00:00\",\"stuck_10s\",1],[\"2018-03-05 07:00:00\",\"stuck_3m\",1],[\"2018-03-05 07:00:00\",\"widget_click\",1],[\"2018-03-05 07:00:00\",\"widget_shown\",32],[\"2018-03-05 07:00:00\",\"widget_visible\",15],[\"2018-03-05 08:00:00\",\"pageview\",1],[\"2018-03-05 08:00:00\",\"stuck_10s\",1],[\"2018-03-05 08:00:00\",\"widget_shown\",13],[\"2018-03-05 08:00:00\",\"widget_visible\",8],[\"2018-03-05 09:00:00\",\"widget_shown\",10],[\"2018-03-05 09:00:00\",\"widget_visible\",5],[\"2018-03-05 10:00:00\",\"pageview\",1],[\"2018-03-05 10:00:00\",\"stuck_10s\",1],[\"2018-03-05 10:00:00\",\"widget_click\",1],[\"2018-03-05 10:00:00\",\"widget_shown\",15],[\"2018-03-05 10:00:00\",\"widget_visible\",8],[\"2018-03-05 11:00:00\",\"widget_shown\",5],[\"2018-03-05 12:00:00\",\"widget_shown\",3],[\"2018-03-05 12:00:00\",\"widget_visible\",2],[\"2018-03-05 13:00:00\",\"widget_shown\",5],[\"2018-03-05 13:00:00\",\"widget_visible\",4],[\"2018-03-05 14:00:00\",\"widget_shown\",7],[\"2018-03-05 14:00:00\",\"widget_visible\",3],[\"2018-03-05 15:00:00\",\"widget_shown\",3],[\"2018-03-05 15:00:00\",\"widget_visible\",2],[\"2018-03-05 16:00:00\",\"widget_shown\",4],[\"2018-03-05 16:00:00\",\"widget_visible\",3],[\"2018-03-05 17:00:00\",\"widget_shown\",2],[\"2018-03-05 17:00:00\",\"widget_visible\",1],[\"2018-03-05 18:00:00\",\"widget_shown\",1],[\"2018-03-05 18:00:00\",\"widget_visible\",1],[\"2018-03-05 19:00:00\",\"widget_shown\",6],[\"2018-03-05 19:00:00\",\"widget_visible\",3],[\"2018-03-05 20:00:00\",\"widget_shown\",8],[\"2018-03-05 20:00:00\",\"widget_visible\",6],[\"2018-03-05 21:00:00\",\"widget_shown\",9],[\"2018-03-05 21:00:00\",\"widget_visible\",4],[\"2018-03-05 22:00:00\",\"widget_shown\",6],[\"2018-03-05 22:00:00\",\"widget_visible\",4],[\"2018-03-05 23:00:00\",\"widget_shown\",9],[\"2018-03-05 23:00:00\",\"widget_visible\",7],[\"2018-03-06 00:00:00\",\"widget_shown\",4],[\"2018-03-06 00:00:00\",\"widget_visible\",3],[\"2018-03-06 01:00:00\",\"widget_shown\",6],[\"2018-03-06 01:00:00\",\"widget_visible\",4],[\"2018-03-06 02:00:00\",\"widget_shown\",9],[\"2018-03-06 02:00:00\",\"widget_visible\",3],[\"2018-03-06 03:00:00\",\"widget_shown\",10],[\"2018-03-06 03:00:00\",\"widget_visible\",7],[\"2018-03-06 04:00:00\",\"widget_shown\",10],[\"2018-03-06 04:00:00\",\"widget_visible\",8],[\"2018-03-06 05:00:00\",\"widget_shown\",10],[\"2018-03-06 05:00:00\",\"widget_visible\",8],[\"2018-03-06 06:00:00\",\"widget_shown\",21],[\"2018-03-06 06:00:00\",\"widget_visible\",15],[\"2018-03-06 07:00:00\",\"widget_shown\",10],[\"2018-03-06 07:00:00\",\"widget_visible\",8],[\"2018-03-06 08:00:00\",\"widget_shown\",8],[\"2018-03-06 08:00:00\",\"widget_visible\",7],[\"2018-03-06 09:00:00\",\"widget_shown\",13],[\"2018-03-06 09:00:00\",\"widget_visible\",11],[\"2018-03-06 10:00:00\",\"widget_shown\",13],[\"2018-03-06 10:00:00\",\"widget_visible\",9],[\"2018-03-06 11:00:00\",\"widget_shown\",2],[\"2018-03-06 12:00:00\",\"widget_shown\",6],[\"2018-03-06 12:00:00\",\"widget_visible\",1],[\"2018-03-06 13:00:00\",\"widget_shown\",2],[\"2018-03-06 14:00:00\",\"widget_shown\",6],[\"2018-03-06 14:00:00\",\"widget_visible\",1],[\"2018-03-06 15:00:00\",\"widget_shown\",1],[\"2018-03-06 15:00:00\",\"widget_visible\",1],[\"2018-03-06 16:00:00\",\"widget_shown\",4],[\"2018-03-06 16:00:00\",\"widget_visible\",2],[\"2018-03-06 17:00:00\",\"widget_shown\",2],[\"2018-03-06 17:00:00\",\"widget_visible\",1],[\"2018-03-06 18:00:00\",\"widget_shown\",8],[\"2018-03-06 18:00:00\",\"widget_visible\",6],[\"2018-03-06 19:00:00\",\"widget_shown\",3],[\"2018-03-06 19:00:00\",\"widget_visible\",3],[\"2018-03-06 20:00:00\",\"widget_shown\",9],[\"2018-03-06 20:00:00\",\"widget_visible\",4],[\"2018-03-06 21:00:00\",\"widget_shown\",8],[\"2018-03-06 21:00:00\",\"widget_visible\",4],[\"2018-03-06 22:00:00\",\"widget_shown\",5],[\"2018-03-06 22:00:00\",\"widget_visible\",4],[\"2018-03-06 23:00:00\",\"widget_shown\",4],[\"2018-03-06 23:00:00\",\"widget_visible\",4],[\"2018-03-07 00:00:00\",\"widget_shown\",7],[\"2018-03-07 00:00:00\",\"widget_visible\",5],[\"2018-03-07 01:00:00\",\"widget_shown\",7],[\"2018-03-07 01:00:00\",\"widget_visible\",4],[\"2018-03-07 02:00:00\",\"widget_shown\",10],[\"2018-03-07 02:00:00\",\"widget_visible\",3],[\"2018-03-07 03:00:00\",\"widget_shown\",7],[\"2018-03-07 03:00:00\",\"widget_visible\",4],[\"2018-03-07 04:00:00\",\"pageview\",1],[\"2018-03-07 04:00:00\",\"stuck_10s\",1],[\"2018-03-07 04:00:00\",\"widget_click\",2],[\"2018-03-07 04:00:00\",\"widget_shown\",27],[\"2018-03-07 04:00:00\",\"widget_visible\",18],[\"2018-03-07 05:00:00\",\"widget_shown\",3],[\"2018-03-07 05:00:00\",\"widget_visible\",2],[\"2018-03-07 06:00:00\",\"widget_shown\",3],[\"2018-03-07 06:00:00\",\"widget_visible\",2],[\"2018-03-07 07:00:00\",\"widget_shown\",7],[\"2018-03-07 07:00:00\",\"widget_visible\",6],[\"2018-03-07 08:00:00\",\"pageview\",1],[\"2018-03-07 08:00:00\",\"stuck_10s\",1],[\"2018-03-07 08:00:00\",\"stuck_3m\",1],[\"2018-03-07 08:00:00\",\"widget_shown\",12],[\"2018-03-07 08:00:00\",\"widget_visible\",3],[\"2018-03-07 09:00:00\",\"widget_shown\",12],[\"2018-03-07 09:00:00\",\"widget_visible\",5],[\"2018-03-07 10:00:00\",\"widget_shown\",5],[\"2018-03-07 10:00:00\",\"widget_visible\",3],[\"2018-03-07 11:00:00\",\"widget_shown\",3],[\"2018-03-07 11:00:00\",\"widget_visible\",3],[\"2018-03-07 12:00:00\",\"widget_shown\",6],[\"2018-03-07 12:00:00\",\"widget_visible\",7],[\"2018-03-07 13:00:00\",\"widget_shown\",4],[\"2018-03-07 13:00:00\",\"widget_visible\",3],[\"2018-03-07 14:00:00\",\"pageview\",1],[\"2018-03-07 14:00:00\",\"stuck_10s\",1],[\"2018-03-07 14:00:00\",\"widget_click\",2],[\"2018-03-07 14:00:00\",\"widget_shown\",9],[\"2018-03-07 14:00:00\",\"widget_visible\",4],[\"2018-03-07 15:00:00\",\"widget_shown\",1],[\"2018-03-07 16:00:00\",\"widget_shown\",3],[\"2018-03-07 16:00:00\",\"widget_visible\",3],[\"2018-03-07 17:00:00\",\"widget_shown\",3],[\"2018-03-07 17:00:00\",\"widget_visible\",2],[\"2018-03-07 18:00:00\",\"widget_shown\",5],[\"2018-03-07 18:00:00\",\"widget_visible\",3],[\"2018-03-07 19:00:00\",\"widget_shown\",3],[\"2018-03-07 19:00:00\",\"widget_visible\",1],[\"2018-03-07 20:00:00\",\"widget_shown\",1],[\"2018-03-07 21:00:00\",\"pageview\",1],[\"2018-03-07 21:00:00\",\"stuck_10s\",1],[\"2018-03-07 21:00:00\",\"widget_click\",2],[\"2018-03-07 21:00:00\",\"widget_shown\",12],[\"2018-03-07 21:00:00\",\"widget_visible\",5],[\"2018-03-07 22:00:00\",\"widget_shown\",11],[\"2018-03-07 22:00:00\",\"widget_visible\",8],[\"2018-03-07 23:00:00\",\"widget_shown\",7],[\"2018-03-07 23:00:00\",\"widget_visible\",6]]}"}],"_postman_id":"66b339e2-0f38-417f-b696-7eb1d3140649"}],"id":"d41a8d03-939e-4917-9e89-47748ef1d1bf","description":"We have added select public endpoints corresponding to several of the analytics charts available in your LiftIgniter Account Dashboard. The corresponding chart names have been included in parentheses.
\n","_postman_id":"d41a8d03-939e-4917-9e89-47748ef1d1bf"}],"event":[{"listen":"prerequest","script":{"id":"ffb0832b-1654-45ee-b50f-048e50388786","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a917830d-96e9-4eef-8964-17eeb3423520","type":"text/javascript","exec":[""]}}]}