{"_id":"56e1fe4026a9f20e00bde205","category":{"_id":"56d4ec4773dcd20b00fb8769","__v":1,"version":"56aff08c3a5b810d00745d9c","pages":["56d4ec8573dcd20b00fb876a"],"project":"56aff08c3a5b810d00745d99","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-03-01T01:11:35.547Z","from_sync":false,"order":3,"slug":"authorization","title":"Platform REST API"},"editedParams2":true,"user":"566887ff8639090d00759415","version":{"_id":"56aff08c3a5b810d00745d9c","project":"56aff08c3a5b810d00745d99","__v":31,"createdAt":"2016-02-01T23:55:56.544Z","releaseDate":"2016-02-01T23:55:56.544Z","categories":["56aff08d3a5b810d00745d9d","56aff24f3a5b810d00745da0","56aff25dbc304a0d00ace207","56aff287e0b1e40d00c53798","56aff2b260a37a0d00ed8883","56aff2b8e0b1e40d00c53799","56aff2bd5b1f01170014dc7b","56aff2c9d21e9c0d00b62993","56aff493aef9a21700da0e67","56aff4ce1486990d009c0f64","56aff4da5b1f01170014dc7d","56aff4dfe0b1e40d00c537a2","56aff4e59d32e30d0006d3e9","56aff4e91486990d009c0f65","56aff4f93a5b810d00745da2","56aff4fe9d32e30d0006d3ea","56b91c7ab1e03e0d001057c5","56c4f51aba4a540d0091b9a2","56cd09488c4a331d002c1e44","56d4ec4773dcd20b00fb8769","56e79bc515f96b2200878e54","56ec25c538ff1d2200d56cc2","56ec3a6f36bc8e0e00f190c8","56ec3e308ea7ce0e00a3d8b0","5724d8fe4255580e005938b2","5724dc842ad0bc1700122803","5776ef2a04f7500e0095dc37","57ab9f70b5e8742000e17eb9","57d7117646dcc30e007dd21f","58e6abd5b1eece19008b7d31","59288c65e2653627003e1221"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1"},"__v":10,"parentDoc":null,"editedParams":true,"project":"56aff08c3a5b810d00745d99","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-03-10T23:07:44.962Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"56bd141fe0b1580d00b5d18f","examples":{"codes":[]},"method":"get","auth":"required","params":[{"_id":"56ccd19e94c8f00b00b83f42","ref":"","in":"path","required":true,"desc":"Unique identifier for your Boomtrain site.","default":"","type":"string","name":"site_id"},{"_id":"56e99cf0cbeede0e0006e5c6","ref":"","in":"path","required":true,"desc":"URL path parameter. Indicates the type of identifier used to identify the user. Currently-supported identifier types are `email`, `user_id`, and `bsin`. A user's `bsin` can be obtained through the route documented at [Get a Boomtrain Identifier for a Person](https://boomtrain.readme.io/docs/get-a-boomtrain-identifier-for-a-person)","default":"","type":"string","name":"identifier_type"},{"_id":"56bd1626ac1c5c1900b2dbf2","ref":"","in":"path","required":true,"desc":"URL path parameter. Indicates the identifier for the user receiving recommendations.","default":"","type":"string","name":"identifier"},{"_id":"577d43d02bcb6b0e00e9f573","ref":"","in":"query","required":false,"desc":"Number of recommendations to return.","default":"","type":"int","name":"count"},{"_id":"57520367bb25bb1900a9683c","ref":"","in":"query","required":false,"desc":"URL path parameter. If `true` then don't record recommendations. Accepts any of `t`, `true`, `y`, `yes`, or `1` as `true`, all other values are treated as false.","default":"false","type":"string","name":"test"},{"_id":"57520367bb25bb1900a9683b","ref":"","in":"query","required":false,"desc":"A list of `resource_type|resource_id` strings, representing resources to exclude from recommendations.","default":"","type":"array_string","name":"exclude"},{"_id":"57520367bb25bb1900a9683a","ref":"","in":"query","required":false,"desc":"A list of `resource_type|resource_id` strings, representing a set of resources to base the recommendations on.","default":"","type":"array_string","name":"seeds"},{"_id":"57520367bb25bb1900a96839","ref":"","in":"query","required":false,"desc":"Identifies the caller for the request. For general API usage, use the string `api`.","default":"","type":"string","name":"caller"},{"_id":"57520367bb25bb1900a96838","ref":"","in":"query","required":false,"desc":"Identifies the campaign for which the recommendations are being requested, e.g. \"Daily Newsletter\" or \"Product Page Sidebar\"","default":"","type":"string","name":"campaign"},{"_id":"57520367bb25bb1900a96837","ref":"","in":"query","required":false,"desc":"Allows for segmenting within campaigns. Can be used for A/B testing or grouping users.","default":"","type":"string","name":"segment"},{"_id":"57520367bb25bb1900a96836","ref":"","in":"query","required":false,"desc":"Identifies individual sends of one particular campaign in contexts where recommendations are sent in timed batches.","default":"","type":"string","name":"batch"},{"_id":"577d43d02bcb6b0e00e9f572","ref":"","in":"query","required":false,"desc":"URL path parameter, filters the recommendations to a specified set. See *Filter Specification* below for details.","default":"","type":"string","name":"filter"},{"_id":"59cd25cb899eb00010ef29a8","ref":"","in":"query","required":false,"desc":"The medium making the request. Currently supported values include `android`, `display`, `email`, `ios`, `mobile`, `web`, `other`. If no value or a different value is specified, `other` will be used.","default":"other","type":"string","name":"medium"}],"url":"/v:version/:site_id/:identifier_type/:identifier"},"isReference":true,"order":1,"body":"[block:textarea]\n{\n  \"text\": \"## Request\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl 'https://recommendations.api.boomtrain.com/v1/your_site/email/user:::at:::example.com?compact=true&test=true&filter=pubDate:AFTER:-P7D&exclude=article|abcd'\",\n      \"language\": \"curl\",\n      \"name\": \"Using Email Address\"\n    },\n    {\n      \"code\": \"curl 'https://recommendations.api.boomtrain.com/v1/your_site/bsin/Lhzn0ClM1A397PINUa%2BzVSoh%2BH06noQl%2F9wNxvKWLa8jEsNFj58yKhA6bOoeDNG2S6TYsmkkj6u7xDdcOcp1tA%3D%3D?compact=true&test=true&filter=pubDate:after:-P7D&exclude=article|abcd'\",\n      \"language\": \"text\",\n      \"name\": \"Using BSIN\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"When you're ready to deploy this endpoint, remove 'test=true' from the URL. Otherwise, user metrics will not be recorded.\",\n  \"title\": \"Please Note:\"\n}\n[/block]\n## Results\n[block:code]\n{\n  \"codes\": [\n    {\n      \"name\": 200,\n      \"code\": \"{\\n\\t\\\"data\\\": {\\n    \\\"rec-set-id\\\": \\\"820875ed-66e5-4a23-a9a7-fd611e2013f0\\\",\\n\\t\\t\\\"recs\\\": [\\n\\t\\t\\t{\\n\\t\\t\\t\\t\\\"click-url\\\": \\\"https://redirect.api.boomtrain.com/click/application/abc?r=article:1234&c=None&b=None&rd=http://example.com\\\",\\n\\t\\t\\t\\t\\\"id\\\": \\\"1234\\\",\\n\\t\\t\\t\\t\\\"props\\\": {\\n\\t\\t\\t\\t\\t\\\"author\\\": \\\"Dave Williams\\\",\\n\\t\\t\\t\\t\\t\\\"modDate\\\": '2016-02-12T14:20:32+00:00',\\n\\t\\t\\t\\t\\t\\\"pubDate\\\": '2016-02-01T14:14:25+00:00',\\n\\t\\t\\t\\t\\t\\\"keyword\\\": \\\"entertainment\\\",\\n\\t\\t\\t\\t\\t\\\"title\\\": \\\"All Day Holiday Movie Marathon Slated for Feb. 29\\\"\\n\\t\\t\\t\\t},\\n\\t\\t\\t\\t\\\"rec-id\\\": \\\"ab539ac5-da75-11e5-ae12-0a69b99457cf\\\",\\n\\t\\t\\t\\t\\\"resource-type\\\": \\\"article\\\",\\n\\t\\t\\t\\t\\\"thumbnail\\\": \\\"http://images.boomtrain.com/nPxlsbnUidapRiOPVDYew7h3gk1qo7m95OPmYdPe67Y.png\\\"\\n\\t\\t\\t},\\n\\t\\t\\t{\\n\\t\\t\\t\\t\\\"click-url\\\": \\\"https://redirect.api.boomtrain.com/click/application/abc?r=article:0229&c=None&b=None&rd=http://example.com/2\\\",\\n\\t\\t\\t\\t\\\"id\\\": \\\"0229\\\",\\n\\t\\t\\t\\t\\\"props\\\": {\\n\\t\\t\\t\\t\\t\\\"author\\\": \\\"John Smith\\\",\\n\\t\\t\\t\\t\\t\\\"modDate\\\": '2016-02-12T14:20:32+00:00',\\n\\t\\t\\t\\t\\t\\\"pubDate\\\": '2016-02-01T14:14:25+00:00',\\n\\t\\t\\t\\t\\t\\\"keyword\\\": \\\"news\\\",\\n\\t\\t\\t\\t\\t\\\"title\\\": \\\"Rumblings in the Marianas Trench\\\"\\n\\t\\t\\t\\t},\\n\\t\\t\\t\\t\\\"rec-id\\\": \\\"ab539ac5-da75-11e5-ae12-0a69b99457cf\\\",\\n\\t\\t\\t\\t\\\"resource-type\\\": \\\"article\\\",\\n\\t\\t\\t\\t\\\"thumbnail\\\": \\\"http://images.boomtrain.com/EvA0Q1EjAgyK78AwUhzNqdq0WIt0oSXx6smKGv4hgc0.gif\\\"\\n\\t\\t\\t}\\n\\t\\t],\\n\\t\\t\\\"type\\\": \\\"personalized\\\",\\n\\t\\t\\\"view-pixel\\\": \\\"https://redirect.api.boomtrain.com/vp/site/MPYIlJ5wVbiAk/WKDz+eTt7tPvJn8diIBkjyf0PO9vEUSI155pgjju+XgdHpH0S8sVcrTntNZ2A1954wgyZ80A==?c=None&b=None&p=True&rt=None&rid=None&r=None&rsid=ae3ace96-e701-11e5-9ddd-12d5480515d7\\\"\\n\\t}\\n}\",\n      \"language\": \"json\",\n      \"status\": 200\n    },\n    {\n      \"name\": 404,\n      \"code\": \"{\\n  \\\"errors\\\": [\\n    {\\n      \\\"message\\\": \\\"The requested URL was not found on the server.  If you entered the URL manually please check your spelling and try again.\\\",\\n      \\\"request_url\\\": \\\"http://recommendations.api.boomtrain.com/v1/feedbuzz/emailz/abc@b.com\\\",\\n      \\\"status\\\": 404\\n    }\\n  ]\\n}\",\n      \"language\": \"json\",\n      \"status\": 404\n    },\n    {\n      \"status\": 500,\n      \"language\": \"text\",\n      \"code\": \"{\\n  \\\"errors\\\": [\\n    {\\n      \\\"message\\\": \\\"We had a reactor leak here now. Give us a few minutes to lock it down. Large leak, very dangerous.\\\",\\n      \\\"status\\\": 500\\n    }\\n  ]\\n}\",\n      \"name\": 500\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<div>\\n<h4>Filter Specification</h4>Each filter parameter corresponds to a constraint for the recommendations to be returned in a section. If more than one filter parameter is used, the result will be interpreted as the intersection of the filters, i.e. <i>filter1 ∩ filter2 ∩...</i> For example, adding filters <span style='font-family:Consolas,Courier New,monospace'>?filter=resource-type::article&filter=keywords::dogs</span> would filter the section to articles with the \\\"dogs\\\" keyword.<br><br>\\nFilters are specified in the format <span style='font-family:Consolas,Courier New,monospace'>name:operator:value</span> as follows:<br><br>\\n<b>name</b> - A string that indicates which field of your resource the filter will be applied to, e.g. \\\"resource-type\\\", \\\"pubDate\\\", \\\"keywords\\\".<br><b>operator</b> - The operator for the filter. Filter operators allow you to specify relations between the filter values. Supported filters include:<br><br>\\n  <table>\\n    <tbody>\\n      <tr>\\n        <th>Operator</th><th>Values Accepted</th><th>Interpretation</th><th>Example</th>\\n    </tr>\\n  <tr><td>AFTER</td><td>A single ISO-8601 Duration string.</td><td>Can only be applied to timestamp fields such as pubDate and modDate. Returns resources with a timestamp after the end of the provided duration.</td><td><span style='font-family:Consolas,Courier New,monospace'>?filter=pubdate:AFTER:-P7D // pubDate after seven days ago. </span></td></tr>\\n  <tr><td>BEFORE</td><td>A single ISO-8601 Duration string.</td><td>Can only be applied to timestamp fields such as pubDate and modDate. Returns resources with a timestamp before the beginning of the provided duration.</td><td><span style='font-family:Consolas,Courier New,monospace'>?filter=expDate:BEFORE:P1D // expDate before 1 day from now. </span></td></tr>\\n  <tr><td>BETWEEN</td><td>Two ISO-8601 Duration strings.</td><td>Can only be applied to timestamp fields such as pubDate and modDate. Returns resources with a timestamp after the first provided value and before the second provided value.</td><td>\\n    <span style='font-family:Consolas,Courier New,monospace'>?filter=pubDate:BETWEEN:-P2D|-P1D // pubDate between 2 days ago and 1 day ago.</span></td></tr>\\n  <tr><td>NOT</td><td>Any number of strings.</td><td>Returns results where the field does not match any of the provided values.</td><td><span style='font-family:Consolas,Courier New,monospace'>?filter=keyword:NOT:dogs|cats // keywords contains neither dogs nor cats.</span> </td></tr>\\n  </tbody>\\n  </table>\\nIf no operator is specified, we check the fields for equality. For example: <ul><li>The filter <span style='font-family:Consolas,Courier New,monospace'>?filter=keywords::dogs|cats</span> will filter to resources that contain either \\\"dogs\\\" or \\\"cats\\\" as a keyword. Note that resource fields with an array type will consider an equality operation to be \\\"true\\\" if _any_ of the values in the array matches the specified value.</li><li>The filter <span style='font-family:Consolas,Courier New,monospace'>?filter=colors::red</span> will filter to resources with the \\\"red\\\" value in the \\\"colors\\\" field.</li></ul><br> <b>values</b> - Strings representing the fields of the resource to filter the recommendation to, separated by '|' characters.\\n<h4>View Pixel Tracking</h4>\\nIn order to provide metrics and data to improve Boomtrain's recommendation systems, the `view-pixel` returned in the result of this call should be impressed whenever these results are viewed by a user. This can be done by adding an invisible image pixel into the HTML body where the request is being shown. For example, <span style='font-family:Consolas,Courier New,monospace'>&lt;img src=\\\"view-pixel returned by this route\\\" /&gt;</span>.\\n</div>\\n<style></style>\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Results\"\n}\n[/block]\nNote that the `view-pixel` should be rendered on each impression of a recommendation set in order to track views of recommendations.\n\nAs well, the `click-url` should be triggered upon click of any recommendation in order to track clicks for the purpose of evaluating performance.","excerpt":"The Basic Recommendations API returns recommendations for a specified user. It differs from the [advanced route](doc:recommendations-advanced) in that it offers support for one set of filters per call.","slug":"recommendations","type":"endpoint","title":"Recommendations (Basic)"}

getRecommendations (Basic)

The Basic Recommendations API returns recommendations for a specified user. It differs from the [advanced route](doc:recommendations-advanced) in that it offers support for one set of filters per call.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

site_id:
required
string
Unique identifier for your Boomtrain site.
identifier_type:
required
string
URL path parameter. Indicates the type of identifier used to identify the user. Currently-supported identifier types are `email`, `user_id`, and `bsin`. A user's `bsin` can be obtained through the route documented at [Get a Boomtrain Identifier for a Person](https://boomtrain.readme.io/docs/get-a-boomtrain-identifier-for-a-person)
identifier:
required
string
URL path parameter. Indicates the identifier for the user receiving recommendations.

Query Params

count:
integer
Number of recommendations to return.
test:
stringfalse
URL path parameter. If `true` then don't record recommendations. Accepts any of `t`, `true`, `y`, `yes`, or `1` as `true`, all other values are treated as false.
exclude:
array of strings
A list of `resource_type|resource_id` strings, representing resources to exclude from recommendations.
seeds:
array of strings
A list of `resource_type|resource_id` strings, representing a set of resources to base the recommendations on.
caller:
string
Identifies the caller for the request. For general API usage, use the string `api`.
campaign:
string
Identifies the campaign for which the recommendations are being requested, e.g. "Daily Newsletter" or "Product Page Sidebar"
segment:
string
Allows for segmenting within campaigns. Can be used for A/B testing or grouping users.
batch:
string
Identifies individual sends of one particular campaign in contexts where recommendations are sent in timed batches.
filter:
string
URL path parameter, filters the recommendations to a specified set. See *Filter Specification* below for details.
medium:
stringother
The medium making the request. Currently supported values include `android`, `display`, `email`, `ios`, `mobile`, `web`, `other`. If no value or a different value is specified, `other` will be used.

Documentation

[block:textarea] { "text": "## Request", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "curl 'https://recommendations.api.boomtrain.com/v1/your_site/email/user@example.com?compact=true&test=true&filter=pubDate:AFTER:-P7D&exclude=article|abcd'", "language": "curl", "name": "Using Email Address" }, { "code": "curl 'https://recommendations.api.boomtrain.com/v1/your_site/bsin/Lhzn0ClM1A397PINUa%2BzVSoh%2BH06noQl%2F9wNxvKWLa8jEsNFj58yKhA6bOoeDNG2S6TYsmkkj6u7xDdcOcp1tA%3D%3D?compact=true&test=true&filter=pubDate:after:-P7D&exclude=article|abcd'", "language": "text", "name": "Using BSIN" } ], "sidebar": true } [/block] [block:callout] { "type": "warning", "body": "When you're ready to deploy this endpoint, remove 'test=true' from the URL. Otherwise, user metrics will not be recorded.", "title": "Please Note:" } [/block] ## Results [block:code] { "codes": [ { "name": 200, "code": "{\n\t\"data\": {\n \"rec-set-id\": \"820875ed-66e5-4a23-a9a7-fd611e2013f0\",\n\t\t\"recs\": [\n\t\t\t{\n\t\t\t\t\"click-url\": \"https://redirect.api.boomtrain.com/click/application/abc?r=article:1234&c=None&b=None&rd=http://example.com\",\n\t\t\t\t\"id\": \"1234\",\n\t\t\t\t\"props\": {\n\t\t\t\t\t\"author\": \"Dave Williams\",\n\t\t\t\t\t\"modDate\": '2016-02-12T14:20:32+00:00',\n\t\t\t\t\t\"pubDate\": '2016-02-01T14:14:25+00:00',\n\t\t\t\t\t\"keyword\": \"entertainment\",\n\t\t\t\t\t\"title\": \"All Day Holiday Movie Marathon Slated for Feb. 29\"\n\t\t\t\t},\n\t\t\t\t\"rec-id\": \"ab539ac5-da75-11e5-ae12-0a69b99457cf\",\n\t\t\t\t\"resource-type\": \"article\",\n\t\t\t\t\"thumbnail\": \"http://images.boomtrain.com/nPxlsbnUidapRiOPVDYew7h3gk1qo7m95OPmYdPe67Y.png\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"click-url\": \"https://redirect.api.boomtrain.com/click/application/abc?r=article:0229&c=None&b=None&rd=http://example.com/2\",\n\t\t\t\t\"id\": \"0229\",\n\t\t\t\t\"props\": {\n\t\t\t\t\t\"author\": \"John Smith\",\n\t\t\t\t\t\"modDate\": '2016-02-12T14:20:32+00:00',\n\t\t\t\t\t\"pubDate\": '2016-02-01T14:14:25+00:00',\n\t\t\t\t\t\"keyword\": \"news\",\n\t\t\t\t\t\"title\": \"Rumblings in the Marianas Trench\"\n\t\t\t\t},\n\t\t\t\t\"rec-id\": \"ab539ac5-da75-11e5-ae12-0a69b99457cf\",\n\t\t\t\t\"resource-type\": \"article\",\n\t\t\t\t\"thumbnail\": \"http://images.boomtrain.com/EvA0Q1EjAgyK78AwUhzNqdq0WIt0oSXx6smKGv4hgc0.gif\"\n\t\t\t}\n\t\t],\n\t\t\"type\": \"personalized\",\n\t\t\"view-pixel\": \"https://redirect.api.boomtrain.com/vp/site/MPYIlJ5wVbiAk/WKDz+eTt7tPvJn8diIBkjyf0PO9vEUSI155pgjju+XgdHpH0S8sVcrTntNZ2A1954wgyZ80A==?c=None&b=None&p=True&rt=None&rid=None&r=None&rsid=ae3ace96-e701-11e5-9ddd-12d5480515d7\"\n\t}\n}", "language": "json", "status": 200 }, { "name": 404, "code": "{\n \"errors\": [\n {\n \"message\": \"The requested URL was not found on the server. If you entered the URL manually please check your spelling and try again.\",\n \"request_url\": \"http://recommendations.api.boomtrain.com/v1/feedbuzz/emailz/abc@b.com\",\n \"status\": 404\n }\n ]\n}", "language": "json", "status": 404 }, { "status": 500, "language": "text", "code": "{\n \"errors\": [\n {\n \"message\": \"We had a reactor leak here now. Give us a few minutes to lock it down. Large leak, very dangerous.\",\n \"status\": 500\n }\n ]\n}", "name": 500 } ], "sidebar": true } [/block] [block:html] { "html": "<div>\n<h4>Filter Specification</h4>Each filter parameter corresponds to a constraint for the recommendations to be returned in a section. If more than one filter parameter is used, the result will be interpreted as the intersection of the filters, i.e. <i>filter1 ∩ filter2 ∩...</i> For example, adding filters <span style='font-family:Consolas,Courier New,monospace'>?filter=resource-type::article&filter=keywords::dogs</span> would filter the section to articles with the \"dogs\" keyword.<br><br>\nFilters are specified in the format <span style='font-family:Consolas,Courier New,monospace'>name:operator:value</span> as follows:<br><br>\n<b>name</b> - A string that indicates which field of your resource the filter will be applied to, e.g. \"resource-type\", \"pubDate\", \"keywords\".<br><b>operator</b> - The operator for the filter. Filter operators allow you to specify relations between the filter values. Supported filters include:<br><br>\n <table>\n <tbody>\n <tr>\n <th>Operator</th><th>Values Accepted</th><th>Interpretation</th><th>Example</th>\n </tr>\n <tr><td>AFTER</td><td>A single ISO-8601 Duration string.</td><td>Can only be applied to timestamp fields such as pubDate and modDate. Returns resources with a timestamp after the end of the provided duration.</td><td><span style='font-family:Consolas,Courier New,monospace'>?filter=pubdate:AFTER:-P7D // pubDate after seven days ago. </span></td></tr>\n <tr><td>BEFORE</td><td>A single ISO-8601 Duration string.</td><td>Can only be applied to timestamp fields such as pubDate and modDate. Returns resources with a timestamp before the beginning of the provided duration.</td><td><span style='font-family:Consolas,Courier New,monospace'>?filter=expDate:BEFORE:P1D // expDate before 1 day from now. </span></td></tr>\n <tr><td>BETWEEN</td><td>Two ISO-8601 Duration strings.</td><td>Can only be applied to timestamp fields such as pubDate and modDate. Returns resources with a timestamp after the first provided value and before the second provided value.</td><td>\n <span style='font-family:Consolas,Courier New,monospace'>?filter=pubDate:BETWEEN:-P2D|-P1D // pubDate between 2 days ago and 1 day ago.</span></td></tr>\n <tr><td>NOT</td><td>Any number of strings.</td><td>Returns results where the field does not match any of the provided values.</td><td><span style='font-family:Consolas,Courier New,monospace'>?filter=keyword:NOT:dogs|cats // keywords contains neither dogs nor cats.</span> </td></tr>\n </tbody>\n </table>\nIf no operator is specified, we check the fields for equality. For example: <ul><li>The filter <span style='font-family:Consolas,Courier New,monospace'>?filter=keywords::dogs|cats</span> will filter to resources that contain either \"dogs\" or \"cats\" as a keyword. Note that resource fields with an array type will consider an equality operation to be \"true\" if _any_ of the values in the array matches the specified value.</li><li>The filter <span style='font-family:Consolas,Courier New,monospace'>?filter=colors::red</span> will filter to resources with the \"red\" value in the \"colors\" field.</li></ul><br> <b>values</b> - Strings representing the fields of the resource to filter the recommendation to, separated by '|' characters.\n<h4>View Pixel Tracking</h4>\nIn order to provide metrics and data to improve Boomtrain's recommendation systems, the `view-pixel` returned in the result of this call should be impressed whenever these results are viewed by a user. This can be done by adding an invisible image pixel into the HTML body where the request is being shown. For example, <span style='font-family:Consolas,Courier New,monospace'>&lt;img src=\"view-pixel returned by this route\" /&gt;</span>.\n</div>\n<style></style>" } [/block] [block:api-header] { "type": "basic", "title": "Results" } [/block] Note that the `view-pixel` should be rendered on each impression of a recommendation set in order to track views of recommendations. As well, the `click-url` should be triggered upon click of any recommendation in order to track clicks for the purpose of evaluating performance.

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}