{"info":{"_postman_id":"2d4f917a-b2c9-79f4-650a-4914db76a476","name":"Instant Win API. Documentation","description":"<html><head></head><body><p>To use this API, you will need three <b>Environment variable</b> values:</p>\n<ul>\n  <li><b>{{$</b><b>subdomain}}:</b> &nbsp; &nbsp; each promotion is assigned a unique subdomain</li>\n  <li><b>{{$</b><b>test-api-guid}}:</b> &nbsp;an API key for testing</li>\n  <li><b>{{$<b></b>live-api-guid}}:</b> &nbsp; an API key for the live promotion</li>\n</ul>\nThe values for these variables will be provided when you set up an account via <a href=\"https://www.instantwinapi.com/?utm_medium=website&amp;utm_campaign=links&amp;utm_source=documenter.getpostman.com\">instantwinapi.com</a>.\nOnce you have set these in the Postman app you will be able to test/use the API directly from Postman without doing any coding.\n\n<p><b>WARNING:</b> In production, do not use client side scripting when connecting to the API as you will be exposing the API key.</p>\n<p>Please visit <a href=\"https://www.instantwinapi.com/?utm_medium=website&amp;utm_campaign=links&amp;utm_source=documenter.getpostman.com\">instantwinapi.com</a> for the latest info or send us an email: <a href=\"mailto:info@instantwinapi.com\">info@instantwinapi.com</a>. By <a href=\"https://www.tpal.com.au/?utm_medium=website&amp;utm_campaign=links&amp;utm_source=documenter.getpostman.com\">TPAL®</a>.</p>\n<p><b>Postman notes:</b></p>\n<ul>\n  <li>The programming language used in the panel on the right can be changed via the dropdown at the top of the page.</li>\n  <li>In the Postman app, there are more languages available, including <b>NodeJS, C, C#, Java and Shell.</b></li>\n  <li><b>Global</b> and <b>Environment</b> variables within the Postman app are denoted by double braces, e.g. Global: <b>{{$</b><b>guid}}</b>, <b>{{$</b><b>randomInt}}</b> and <b>{{$</b><b>timestamp}}</b>.</li>\n  <li>Environment variables are set via the 'cog' icon next to the Environment dropdown in the Postman app (top rght). You can set:  <b>{{$</b><b>subdomain}}</b>, <b>{{$</b><b>test-api-key}}</b> and <b>{{$</b><b>live-api-key}}</b>.</li>  \n\n</ul>\n<img src=\"https://in.getclicky.com/101039209ns.gif\" width=\"1\" height=\"1\">\n\n</body></html>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"1550264","collectionId":"2d4f917a-b2c9-79f4-650a-4914db76a476","publishedId":"6fePfU2","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2017-09-11T14:30:33.000Z"},"item":[{"name":"/api/entry","id":"94b945bf-5025-866a-ff24-43649ab0ee9d","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"description":"<p>Your API key. You should have two, one for testing and one for the live promotion.</p>\n","key":"apiKey","type":"text","value":"{{$test-api-guid}}"},{"description":"<p>Should be unique for every request to the API. If it isn’t, an error will be returned. Recommend using a GUID.</p>\n","key":"transactionId","type":"text","value":"9cbc11dd-5e56-4c62-bc9e-8ae42c2e2794"},{"description":"<p>SOMETIMES required - depends on rules of promotion. Some promotions have rules like: no more than 2 entries per calendar day.</p>\n","key":"entrantId","type":"text","value":"","disabled":true},{"description":"<p>NOT required. Restricts a possible win to the prize type specified.\nLeave empty/null to run as normal.</p>\n","key":"prizeTypeId","type":"text","value":"","disabled":true},{"description":"<p>NOT required. When using the TEST API key, you can request a specific response using this code (0,1,2). There must be prizes available to force a win.\nLeave empty/null to run as normal.</p>\n","key":"forceResponse","type":"text","value":"","disabled":true},{"description":"<p>NOT required. Data that can be sent for logging and/or reconciliation.\nLeave empty/null to run as normal.</p>\n","key":"logData","type":"text","value":"","disabled":true}]},"url":"https://{{$subdomain}}.instantwinapi.com/api/entry","description":"<p><br /></p><h3><b>HEADERS</b></h3>\n<b>Content-Type:</b> application/x-www-form-urlencoded<p></p>\n<p><br /></p><h3><b>PARAMETERS</b></h3><p></p>\n<table>\n<tr>\n  <th>Key</th>\n  <th>Type</th>\n  <th>Example</th>\n  <th>Notes</th>\n</tr>\n<tr>\n  <td>apiKey</td>\n  <td>string</td>\n  <td>a8ca3e57-5893-4c19-9d71-36d10cad8770</td>\n  <td><b>Required.</b>\n    Your API key. You should have two, one for testing and one for the live promotion.\n  </td>\n</tr>\n<tr>\n  <td>transactionId</td>\n  <td>string</td>\n  <td>abc123\n  or\n  0f8a38eb-02e4-4477-9a02-0e60ce606e89</td>\n  <td><b>Required.</b>\n    Should be unique for every request to the API. If it isn’t, an error will be returned. Recommend using a GUID.\n  </td>\n</tr>\n<tr>\n  <td>entrantId</td>\n  <td>string</td>\n  <td>email@example.com</td>\n  <td><b>anything</b>\n    Sometimes required. Depends on the T&amp;Cs of the promotion, e.g. no more than 2 entries per calendar day.\n    \n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>Leave empty/null to run as normal.\n</code></pre>  </td>\n</tr>\n<tr>\n  <td>prizeTypeId</td>\n  <td>GUID</td>\n  <td>a38038d3-b352-49a3-9c73-9cf2c0392f31</td>\n  <td><b>Not required.</b>\n  NOT required. Restricts a possible win to the prize type specified.\n\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>Leave empty/null to run as normal.\n</code></pre>  </td>\n</tr>\n<tr>\n  <td>forceResponse</td>\n  <td>int</td>\n  <td><b>0:</b> No win. This entry will not win a prize.<br /><b>1:</b> Win. This entry will win a prize.<br /><b>NOTES:</b><ul><li>A win can NOT be forced in the TEST promo if the prize pool is exhausted</li><li>If there is more than one prize type available, then it will be chosen randomly</li></ul><b>2:</b> Promotion closed. Simulate the response that is returned when a promotion is closed, i.e. current time is before promotion start or after promotion end.\n  </td>\n  <td><b>Not required.</b>\n    This parameter only works on the TEST API, it will be ignored by the LIVE API.<br />When using the TEST API key, you can request a specific response using this code. There must be prizes available to force a win.\n    \n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>Leave empty/null to run as normal.\n</code></pre>  </td>\n</tr>\n<tr>\n  <td>logData</td>\n  <td>string</td>\n  <td>anything</td>\n  <td><b>Not required.</b>\n    Data that can be sent for logging and/or reconciliation. Common examples are user details, e.g. name, email, entry-id, etc. Can be any format, e.g. CSV, XML, JSON, etc.\n    \n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>Leave empty/null to run as normal.\n</code></pre>  </td>\n</tr>\n</table>\n\n<p><br /></p><h3><b>RESPONSE EXAMPLES</b></h3><p></p>\n<pre><h4>Win</h4>{\n    <b>\"id\":</b> \"<i>{$response-guid}</i>\",\n    <b>\"transactionId\":</b> \"<i>{$transaction-id}</i>\",\n    <b>\"promotionId\":</b> \"<i>{$promotion-guid}</i>\",\n    <b>\"responseTimeUtc\":</b> \"2017-07-25T05:11:52.6859343Z\",\n    <b>\"entryTimeUtc\":</b> \"2017-07-25T05:11:52.467202Z\",\n    <b>\"isTestMode\":</b> true,\n    <b>\"forceResponse\":</b> 1,\n    <b>\"isWinner\":</b> true,\n    <b>\"prize\":</b> {\n        <b>\"id\":</b> \"<i>{$prize-guid}</i>\",\n        <b>\"prizeType\":</b> {\n            <b>\"id\":</b> \"<i>{$prize-type-guid}</i>\",\n            <b>\"name\":</b> \"<i>{$prize-type-name}</i>\"\n        }\n    },\n    <b>\"status\":</b> {\n        <b>\"code\":</b> 0,\n        <b>\"description\":</b> \"Success\",\n        <b>\"data\":</b> \"\"\n    },\n    <b>\"processingTimeMs\":</b> 36.6757000000002\n}\n</pre>\n\n<pre><h4>No win</h4>{\n    <b>\"id\":</b> \"<i>{$response-guid}</i>\",\n    <b>\"transactionId\":</b> \"<i>{$transaction-id}</i>\",\n    <b>\"promotionId\":</b> \"<i>{$promotion-guid}</i>\",\n    <b>\"responseTimeUtc\":</b> \"2017-07-25T05:30:01.1126584Z\",\n    <b>\"entryTimeUtc\":</b> \"2017-07-25T05:30:01.1126584Z\",\n    <b>\"isTestMode\":</b> true,\n    <b>\"forceResponse\":</b> null,\n    <b>\"isWinner\":</b> false,\n    <b>\"prize\":</b> null,\n    <b>\"status\":</b> {\n        <b>\"code\":</b> 0,\n        <b>\"description\":</b> \"Success\",\n        <b>\"data\":</b> \"\"\n    },\n    <b>\"processingTimeMs\":</b> 15.600900000000001\n}\n</pre>\n\n<pre><h4>Error</h4>{\n    <b>\"id\":</b> \"<i>{$response-guid}</i>\",\n    <b>\"transactionId\":</b> \"<i>{$transaction-id}</i>\",\n    <b>\"promotionId\":</b> \"<i>{$promotion-guid}</i>\",\n    <b>\"responseTimeUtc\":</b> \"2017-07-25T05:23:34.7290302Z\",\n    <b>\"entryTimeUtc\":</b> null,\n    <b>\"isTestMode\":</b> true,\n    <b>\"forceResponse\":</b> null,\n    <b>\"isWinner\":</b> null,\n    <b>\"prize\":</b> null,\n    <b>\"status\":</b> {\n        <b>\"code\":</b> 2,\n        <b>\"description\":</b> \"Invalid entry data\",\n        <b>\"data\":</b> \"transactionId must not be empty, and must not have been used before.\"\n    },\n    <b>\"processingTimeMs\":</b> 15.6288\n}\n</pre>\n\n<table>\n<tr>\n  <th>Key</th>\n  <th>Type</th>\n  <th>Notes</th>\n</tr>\n<tr>\n  <td>id</td>\n  <td>GUID</td>\n  <td>A unique GUID for this response</td>\n</tr>\n<tr>\n  <td>transactionId</td>\n  <td>string</td>\n  <td>The transaction ID that was provided with the request. Must be unique.</td>\n</tr>\n<tr>\n  <td>promotionId</td>\n  <td>GUID</td>\n  <td>The GUID of the promotion. This is different to the API key. Promotion GUID's are different for TEST and LIVE API keys.</td>\n</tr>\n<tr>\n  <td>responseTimeUTC</td>\n  <td>date</td>\n  <td>The exact UTC time the response was generated</td>\n</tr>\n<tr>\n  <td>entryTimeUTC</td>\n  <td>date</td>\n  <td>The exact UTC time the entry was processed. Will be <b>null</b> if entry didn't occur (due to error, etc)</td>\n</tr>\n<tr>\n  <td>isTestMode</td>\n  <td>bool</td>\n  <td>If the request was made using the TEST API key. Invalid for LIVE API key.</td>\n</tr>\n<tr>\n  <td>isWinner</td>\n  <td>bool</td>\n  <td>If this entry was a winner. Will be <b>null</b> if the entry didn't occur (due to error, etc).</td>\n</tr>\n<tr>\n  <td>prize</td>\n  <td>object</td>\n  <td>An object containing prize data. Will be <b>null</b> if no prize won, or no entry occurred.</td>\n</tr>\n<tr>\n  <td>status</td>\n  <td>object</td>\n  <td>An object containing the status of the response</td>\n</tr>\n<tr>\n  <td>processingTimeMs</td>\n  <td>decimal</td>\n  <td>Number of milliseconds it took to process the response</td>\n</tr>\n\n<tr>\n  <th><br />Prize</th>\n</tr>\n<tr>\n  <td>id</td>\n  <td>GUID</td>\n  <td>A unique GUID for this specific prize</td>\n</tr>\n<tr>\n  <td>prizeType</td>\n  <td>object</td>\n  <td>An object containing prize type data</td>\n</tr>\n\n<tr>\n  <th><br />Prize Type</th>\n</tr>\n<tr>\n  <td>id</td>\n  <td>GUID</td>\n  <td>A unique GUID for this specific prize type</td>\n</tr>\n<tr>\n  <td>name</td>\n  <td>string</td>\n  <td>The name of the prize type</td>\n</tr>\n\n<tr>\n  <th><br />Status</th>\n</tr>\n<tr>\n  <td>code</td>\n  <td>int</td>\n  <td>A numeric code representing a response status</td>\n</tr>\n<tr>\n  <td>description</td>\n  <td>string</td>\n  <td>A simple description of the response status</td>\n</tr>\n<tr>\n  <td>data</td>\n  <td>string</td>\n  <td>Any additional data relating to the response. May be empty.</td>\n</tr>\n\n<tr>\n  <th><br />Error Codes</th>\n</tr>\n<tr>\n  <td>0</td>\n  <td>int</td>\n  <td>Success</td>\n</tr>\n<tr>\n  <td>1</td>\n  <td>int</td>\n  <td>A valid apiKey is required</td>\n</tr>\n<tr>\n  <td>2</td>\n  <td>int</td>\n  <td>A valid, unique transactionId is required</td>\n</tr>\n<tr>\n  <td>3</td>\n  <td>int</td>\n  <td>A valid prizeTypeId is required.\n  NOTE: whether mandatory or not depends on promotion rules.</td>\n</tr>\n<tr>\n  <td>4</td>\n  <td>int</td>\n  <td>A valid entrantId is required.\n  NOTE: whether mandatory or not depends on promotion rules.</td>\n</tr>\n<tr>\n  <td>5</td>\n  <td>int</td>\n  <td>The forceResponse parameter must be 0, 1, or 2</td>\n</tr>\n<tr>\n  <td>20</td>\n  <td>int</td>\n  <td>This promotion is closed</td>\n</tr>\n<tr>\n  <td>21</td>\n  <td>int</td>\n  <td>Entry frequency exceeded.\n  NOTE: This is dependent on the promotion rules (e.g. 2 entries per day) and utilises the optional entrantId field.\n  </td>\n</tr>\n<tr>\n  <td>99</td>\n  <td>int</td>\n  <td>Unknown/server error</td>\n</tr>\n</table>\n\n<p><br /></p><h3><b>SUMMARY</b></h3><p></p>\n<hr />","urlObject":{"protocol":"https","path":["api","entry"],"host":["{{$subdomain}}","instantwinapi","com"],"query":[],"variable":[]}},"response":[{"id":"132114bb-6de7-5698-ac5b-1b18b5c4f5ba","name":"✅ · No win · CLICK FOR MORE","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"apiKey","value":"${api-guid}","type":"text","description":"Your API key. You should have two, one for testing and one for the live promotion."},{"key":"transactionId","value":"${unique-transaction-id}","type":"text","description":"Should be unique for every request to the API. If it isn’t, an error will be returned. Recommend using a GUID."},{"key":"forceResponse","value":"0","type":"text","description":"NOT required. When using the TEST API key, you can request a specific response using this code (0,1,2). There must be prizes available to force a win.\nLeave empty/null to run as normal.","disabled":true},{"key":"entrantId","value":"","description":"SOMETIMES required - depends on rules of promotion. Some promotions have rules like: no more than 2 entries per calendar day","type":"text","disabled":true},{"key":"prizeTypeId","value":"prizeTypeGuid","description":"NOT required. Restricts a possible win to the prize type specified.\nLeave empty/null to run as normal.","type":"text","disabled":true},{"key":"logData","value":"","description":"NOT required. Data that can be sent for logging and/or reconciliation.\nLeave empty/null to run as normal.","type":"text","disabled":true}]},"url":"https://${subdomain}.instantwinapi.com/api/entry"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-encoding","value":"gzip","type":"text","enabled":true,"name":"content-encoding","description":""},{"key":"content-type","value":"application/json; charset=utf-8","type":"text","enabled":true,"name":"content-type","description":""},{"key":"date","value":"25 Jul 2017 05:30:01 GMT","type":"text","enabled":true,"name":"date","description":""},{"key":"strict-transport-security","value":"max-age=2592000; includeSubDomains; preload","type":"text","enabled":true,"name":"strict-transport-security","description":""},{"key":"x-content-type-options","value":"nosniff","type":"text","enabled":true,"name":"x-content-type-options","description":""}],"cookie":[],"responseTime":"0","body":"{\n    \"id\": \"${response-guid}\",\n    \"transactionId\": \"${transaction-id}\",\n    \"promotionId\": \"${promotion-guid}\",\n    \"responseTimeUtc\": \"2017-07-25T05:30:01.1126584Z\",\n    \"entryTimeUtc\": \"2017-07-25T05:30:01.1126584Z\",\n    \"isTestMode\": true,\n    \"forceResponse\": null,\n    \"isWinner\": false,\n    \"prize\": null,\n    \"status\": {\n        \"code\": 0,\n        \"description\": \"Success\",\n        \"data\": \"\"\n    },\n    \"processingTimeMs\": 15\n}"},{"id":"205245f6-7cd5-4290-7bd1-05128eca0a05","name":"❌ · Error (duplicate transaction id) · CLICK FOR MORE","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"apiKey","value":"${api-guid}","type":"text","description":"Your API key. You should have two, one for testing and one for the live promotion."},{"key":"transactionId","value":"${unique-transaction-id}","type":"text","description":"Should be unique for every request to the API. If it isn’t, an error will be returned. Recommend using a GUID."},{"key":"forceResponse","value":"0","type":"text","description":"NOT required. When using the TEST API key, you can request a specific response using this code (0,1,2). There must be prizes available to force a win.\nLeave empty/null to run as normal.","disabled":true},{"key":"entrantId","value":"","description":"SOMETIMES required - depends on rules of promotion. Some promotions have rules like: no more than 2 entries per calendar day","type":"text","disabled":true},{"key":"prizeTypeId","value":"prizeTypeGuid","description":"NOT required. Restricts a possible win to the prize type specified.\nLeave empty/null to run as normal.","type":"text","disabled":true},{"key":"logData","value":"","description":"NOT required. Data that can be sent for logging and/or reconciliation.\nLeave empty/null to run as normal.","type":"text","disabled":true}]},"url":"https://${subdomain}.instantwinapi.com/api/entry"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-encoding","value":"gzip","type":"text","enabled":true,"name":"content-encoding","description":""},{"key":"content-type","value":"application/json; charset=utf-8","type":"text","enabled":true,"name":"content-type","description":""},{"key":"date","value":"25 Jul 2017 05:23:34 GMT","type":"text","enabled":true,"name":"date","description":""},{"key":"strict-transport-security","value":"max-age=2592000; includeSubDomains; preload","type":"text","enabled":true,"name":"strict-transport-security","description":""},{"key":"x-content-type-options","value":"nosniff","type":"text","enabled":true,"name":"x-content-type-options","description":""}],"cookie":[],"responseTime":"0","body":"{\n    \"id\": \"${response-guid}\",\n    \"transactionId\": \"${transaction-id}\",\n    \"promotionId\": \"${promotion-guid}\",\n    \"responseTimeUtc\": \"2017-07-25T05:23:34.7290302Z\",\n    \"entryTimeUtc\": null,\n    \"isTestMode\": true,\n    \"forceResponse\": null,\n    \"isWinner\": null,\n    \"prize\": null,\n    \"status\": {\n        \"code\": 2,\n        \"description\": \"Invalid entry data\",\n        \"data\": \"transactionId must not be empty, and must not have been used before.\"\n    },\n    \"processingTimeMs\": 10\n}"},{"id":"43fcf7f5-824b-2cf9-f231-53330e036087","name":"✅ · Win (forced response) · CLICK FOR MORE","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"apiKey","value":"${api-guid}","type":"text","description":"Your API key. You should have two, one for testing and one for the live promotion."},{"key":"transactionId","value":"${unique-transaction-id}","type":"text","description":"Should be unique for every request to the API. If it isn’t, an error will be returned. Recommend using a GUID."},{"key":"forceResponse","value":"1","type":"text","description":"NOT required. When using the TEST API key, you can request a specific response using this code (0,1,2). There must be prizes available to force a win.\nLeave empty/null to run as normal."},{"key":"entrantId","value":"","description":"SOMETIMES required - depends on rules of promotion. Some promotions have rules like: no more than 2 entries per calendar day","type":"text","disabled":true},{"key":"prizeTypeId","value":"prizeTypeGuid","description":"NOT required. Restricts a possible win to the prize type specified.\nLeave empty/null to run as normal.","type":"text","disabled":true},{"key":"logData","value":"","description":"NOT required. Data that can be sent for logging and/or reconciliation.\nLeave empty/null to run as normal.","type":"text","disabled":true}]},"url":"https://${subdomain}.instantwinapi.com/api/entry"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-encoding","value":"gzip","description":"","type":"text","name":"content-encoding"},{"key":"content-type","value":"application/json; charset=utf-8","description":"","type":"text","name":"content-type"},{"key":"date","value":"25 Jul 2017 05:11:53 GMT","description":"","type":"text","name":"date"},{"key":"strict-transport-security","value":"max-age=2592000; includeSubDomains; preload","description":"","type":"text","name":"strict-transport-security"},{"key":"x-content-type-options","value":"nosniff","description":"","type":"text","name":"x-content-type-options"}],"cookie":[],"responseTime":"0","body":"{\n    \"id\": \"${response-guid}\",\n    \"transactionId\": \"${transaction-id}\",\n    \"promotionId\": \"${promotion-guid}\",\n    \"responseTimeUtc\": \"2017-07-25T05:11:52.6859343Z\",\n    \"entryTimeUtc\": \"2017-07-25T05:11:52.467202Z\",\n    \"isTestMode\": true,\n    \"forceResponse\": 1,\n    \"isWinner\": true,\n    \"prize\": {\n        \"id\": \"${prize-guid}\",\n        \"prizeType\": {\n            \"id\": \"${prize-type-guid}\",\n            \"name\": \"${prize-type-name}\"\n        }\n    },\n    \"status\": {\n        \"code\": 0,\n        \"description\": \"Success\",\n        \"data\": \"\"\n    },\n    \"processingTimeMs\": 21\n}"}],"_postman_id":"94b945bf-5025-866a-ff24-43649ab0ee9d"},{"name":"/api/status","id":"218d07c5-4208-f8a8-c3e6-b20542764e68","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"description":"<p>API key for the promotion</p>\n","key":"apiKey","type":"text","value":"00000000-0000-0000-0000-000000000001"},{"description":"<p>NOT required. Restricts the info to a prizeTypeGuid\nLeave empty/null to run as normal.</p>\n","key":"prizeTypeId","type":"text","value":"","disabled":true},{"description":"<p>NOT required. Default is 100.</p>\n","key":"winnersCount","type":"text","value":"","disabled":true},{"description":"<p>NOT required. Default is 500.</p>\n","key":"entriesCount","type":"text","value":"","disabled":true},{"description":"<p>NOT required. Default is false.</p>\n","key":"showLogData","type":"text","value":"","disabled":true}]},"url":"https://{{$subdomain}}.instantwinapi.com/api/status","description":"<p><br /></p><h3><b>HEADERS</b></h3>\n<b>Content-Type:</b> application/x-www-form-urlencoded<p></p>\n<p><br /></p><h3><b>PARAMETERS</b></h3><p></p>\n<table>\n<tr>\n  <th>Key</th>\n  <th>Type</th>\n  <th>Example</th>\n  <th>Notes</th>\n</tr>\n<tr>\n  <td>apiKey</td>\n  <td>string</td>\n  <td>a8ca3e57-5893-4c19-9d71-36d10cad8770</td>\n  <td><b>Required.</b>\n    Your API key. You should have two, one for testing and one for the live promotion.\n  </td>\n</tr>\n<tr>\n  <td>prizeTypeId</td>\n  <td>GUID</td>\n  <td>a38038d3-b352-49a3-9c73-9cf2c0392f31</td>\n  <td><b>Not Required.</b>\n  NOT Required. Restricts the winners and prize type info to this particule GUID. Also means that entry data is not returned.\n\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>Leave empty/null to run as normal.\n</code></pre>  </td>\n</tr>\n<tr>\n  <td>winnersCount</td>\n  <td>int</td>\n  <td>100\n  </td>\n  <td><b>Not required.</b>\n    Limits output of winners. Default is 100.\n    \n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>Leave empty/null to run as normal.\n</code></pre>  </td>\n</tr>\n<tr>\n  <td>entriesCount</td>\n  <td>int</td>\n  <td>500\n  </td>\n  <td><b>Not required.</b>\n    Limits output of entries. Default is 500.\n    \n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>Leave empty/null to run as normal.\n</code></pre>  </td>\n</tr>\n<tr>\n  <td>showLogData</td>\n  <td>bool</td>\n  <td>false\n  </td>\n  <td><b>Not required.</b>\n    Default is false. If true, will return the first 1000 chars of the [logData] field. This is the optional field used in requests for logging. Can be anything, e.g. CSV, XML, JSON, etc.\n    \n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>Leave empty/null to run as normal.\n</code></pre>  </td>\n</tr>\n</table>\n\n<p><br /></p><h3><b>SUMMARY</b></h3><p></p>\n<hr />","urlObject":{"protocol":"https","path":["api","status"],"host":["{{$subdomain}}","instantwinapi","com"],"query":[],"variable":[]}},"response":[{"id":"337ca5fe-47c6-4c69-beac-f7897b340250","name":"✅ · Status/Summary · CLICK FOR MORE","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"description":"API key for the promotion","key":"apiKey","type":"text","value":"79b3e982-ef63-4815-b15d-bd4a9f15dcd1"},{"description":"NOT required. Restricts the info to a prizeTypeGuid\nLeave empty/null to run as normal.","key":"prizeTypeId","type":"text","value":"{guid}","disabled":true},{"description":"NOT required. Default is 100.","key":"winnersCount","type":"text","value":"100","disabled":true},{"description":"NOT required. Default is 500.","key":"entriesCount","type":"text","value":"500","disabled":true},{"description":"NOT required. Default is false.","key":"showLogData","type":"text","value":"false","disabled":true}]},"url":"https://{{$subdomain}}.instantwinapi.com/api/status"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n    \"promotions\": [\r\n        {\r\n            \"promotionId\": \"475ce8c8-f7f9-455a-b395-80c41daa629f\",\r\n            \"isTest\": true,\r\n            \"startTimeUTC\": \"2019-05-14T00:00:00\",\r\n            \"endTimeUTC\": \"2020-12-31T23:59:00\",\r\n            \"timeToStart\": \"0\",\r\n            \"timeElapsed\": \"34:05:04:47\",\r\n            \"timeRemaining\": \"563:18:55:12\",\r\n            \"prizeTypesCount\": 4,\r\n            \"entriesCount\": 9,\r\n            \"winnersCount\": 4,\r\n            \"status\": []\r\n        }\r\n    ],\r\n    \"prizeTypes\": [\r\n        {\r\n            \"promotionId\": \"475ce8c8-f7f9-455a-b395-80c41daa629f\",\r\n            \"prizeTypeId\": \"10000000-0000-0000-0000-000000000001\",\r\n            \"prizeTypeTitle\": \"Major Prize\",\r\n            \"prizeCount\": 100,\r\n            \"prizeCountOK\": true,\r\n            \"prizeCountWon\": 1,\r\n            \"winIntervalInitial\": \"5:23:31:11\",\r\n            \"winIntervalRemaining\": \"5:16:40:33\"\r\n        },\r\n        {\r\n            \"promotionId\": \"475ce8c8-f7f9-455a-b395-80c41daa629f\",\r\n            \"prizeTypeId\": \"20000000-0000-0000-0000-000000000002\",\r\n            \"prizeTypeTitle\": \"Minor Prize. A\",\r\n            \"prizeCount\": 200,\r\n            \"prizeCountOK\": true,\r\n            \"prizeCountWon\": 1,\r\n            \"winIntervalInitial\": \"2:23:45:35\",\r\n            \"winIntervalRemaining\": \"2:19:59:40\"\r\n        },\r\n        {\r\n            \"promotionId\": \"475ce8c8-f7f9-455a-b395-80c41daa629f\",\r\n            \"prizeTypeId\": \"30000000-0000-0000-0000-000000000003\",\r\n            \"prizeTypeTitle\": \"Minor Prize. B\",\r\n            \"prizeCount\": 300,\r\n            \"prizeCountOK\": true,\r\n            \"prizeCountWon\": 1,\r\n            \"winIntervalInitial\": \"1:23:50:23\",\r\n            \"winIntervalRemaining\": \"1:21:15:14\"\r\n        },\r\n        {\r\n            \"promotionId\": \"475ce8c8-f7f9-455a-b395-80c41daa629f\",\r\n            \"prizeTypeId\": \"40000000-0000-0000-0000-000000000004\",\r\n            \"prizeTypeTitle\": \"Minor Prize. C\",\r\n            \"prizeCount\": 400,\r\n            \"prizeCountOK\": true,\r\n            \"prizeCountWon\": 1,\r\n            \"winIntervalInitial\": \"1:11:52:47\",\r\n            \"winIntervalRemaining\": \"1:09:54:43\"\r\n        }\r\n    ],\r\n    \"winners\": [\r\n        {\r\n            \"responseId\": \"92dc9de3-a246-4d56-b774-2af73b87d0e3\",\r\n            \"transactionId\": \"f615f376-5ac7-4305-91b2-d2585497ba0d\",\r\n            \"entrantId\": null,\r\n            \"responseTimeUTC\": \"2019-06-17T05:04:36\",\r\n            \"responseTimeLocal\": \"2019-06-17T15:04:36\",\r\n            \"forceResponse\": null,\r\n            \"statusCode\": null,\r\n            \"statusDescription\": \"Success\",\r\n            \"prizeTypeId\": \"10000000-0000-0000-0000-000000000001\",\r\n            \"prizeId\": \"e9b9f7fb-0a39-45e3-9b11-e4d98540b178\",\r\n            \"userIP\": \"124.19.3.250\",\r\n            \"processingTimeMs\": 94,\r\n            \"logData\": null\r\n        },\r\n        {\r\n            \"responseId\": \"f096b013-623c-4041-9ccf-1dc49a8e1ec5\",\r\n            \"transactionId\": \"75fb4ed8-96c0-4d8a-8651-093b79109888\",\r\n            \"entrantId\": null,\r\n            \"responseTimeUTC\": \"2019-06-17T05:04:32\",\r\n            \"responseTimeLocal\": \"2019-06-17T15:04:32\",\r\n            \"forceResponse\": null,\r\n            \"statusCode\": null,\r\n            \"statusDescription\": \"Success\",\r\n            \"prizeTypeId\": \"30000000-0000-0000-0000-000000000003\",\r\n            \"prizeId\": \"2a0ccd57-5547-4ab8-a601-019e1d743f9c\",\r\n            \"userIP\": \"124.19.3.250\",\r\n            \"processingTimeMs\": 31,\r\n            \"logData\": null\r\n        },\r\n        {\r\n            \"responseId\": \"e672778e-f6c1-4802-84c3-d3b50c24132f\",\r\n            \"transactionId\": \"140ebf4d-53bf-43da-afa6-a8a5c388175a\",\r\n            \"entrantId\": null,\r\n            \"responseTimeUTC\": \"2019-06-17T05:04:30\",\r\n            \"responseTimeLocal\": \"2019-06-17T15:04:30\",\r\n            \"forceResponse\": null,\r\n            \"statusCode\": null,\r\n            \"statusDescription\": \"Success\",\r\n            \"prizeTypeId\": \"40000000-0000-0000-0000-000000000004\",\r\n            \"prizeId\": \"6963d7fb-5d6a-4611-9ce0-00116123d2d5\",\r\n            \"userIP\": \"124.19.3.250\",\r\n            \"processingTimeMs\": 297,\r\n            \"logData\": null\r\n        },\r\n        {\r\n            \"responseId\": \"639dbd0e-6d0d-475f-be15-f6be5d21bf9e\",\r\n            \"transactionId\": \"768c835b-eae2-4e32-a996-a16bcebcc405\",\r\n            \"entrantId\": null,\r\n            \"responseTimeUTC\": \"2019-06-17T05:04:27\",\r\n            \"responseTimeLocal\": \"2019-06-17T15:04:27\",\r\n            \"forceResponse\": null,\r\n            \"statusCode\": null,\r\n            \"statusDescription\": \"Success\",\r\n            \"prizeTypeId\": \"20000000-0000-0000-0000-000000000002\",\r\n            \"prizeId\": \"ff0f4e6c-f8b6-465f-874a-a02fb03be9c1\",\r\n            \"userIP\": \"124.19.3.250\",\r\n            \"processingTimeMs\": 63,\r\n            \"logData\": null\r\n        }\r\n    ],\r\n    \"entries\": [\r\n        {\r\n            \"responseId\": \"83b0ff77-588a-424d-aefb-69f934acfdea\",\r\n            \"transactionId\": \"27fdb125-4c6c-4e7d-b24e-1c9c2975506b\",\r\n            \"entrantId\": null,\r\n            \"responseTimeUTC\": \"2019-06-17T05:04:41\",\r\n            \"responseTimeLocal\": \"2019-06-17T15:04:41\",\r\n            \"forceResponse\": null,\r\n            \"statusCode\": null,\r\n            \"statusDescription\": \"Success\",\r\n            \"prizeTypeId\": null,\r\n            \"prizeId\": null,\r\n            \"userIP\": \"… 250\",\r\n            \"processingTimeMs\": 16,\r\n            \"logData\": null\r\n        },\r\n        {\r\n            \"responseId\": \"ecd799b0-3230-42a1-89e1-40a368cdace1\",\r\n            \"transactionId\": \"f4c1d401-ea81-414f-a0a3-61053e8845ea\",\r\n            \"entrantId\": null,\r\n            \"responseTimeUTC\": \"2019-06-17T05:04:39\",\r\n            \"responseTimeLocal\": \"2019-06-17T15:04:39\",\r\n            \"forceResponse\": null,\r\n            \"statusCode\": null,\r\n            \"statusDescription\": \"Success\",\r\n            \"prizeTypeId\": null,\r\n            \"prizeId\": null,\r\n            \"userIP\": \"… 250\",\r\n            \"processingTimeMs\": 47,\r\n            \"logData\": null\r\n        },\r\n        {\r\n            \"responseId\": \"de480e15-9582-467c-acc9-dbc52a9b1439\",\r\n            \"transactionId\": \"48a6ef2f-c493-4db5-8655-bceaa35222f4\",\r\n            \"entrantId\": null,\r\n            \"responseTimeUTC\": \"2019-06-17T05:04:38\",\r\n            \"responseTimeLocal\": \"2019-06-17T15:04:38\",\r\n            \"forceResponse\": null,\r\n            \"statusCode\": null,\r\n            \"statusDescription\": \"Success\",\r\n            \"prizeTypeId\": null,\r\n            \"prizeId\": null,\r\n            \"userIP\": \"… 250\",\r\n            \"processingTimeMs\": 0,\r\n            \"logData\": null\r\n        },\r\n        {\r\n            \"responseId\": \"92dc9de3-a246-4d56-b774-2af73b87d0e3\",\r\n            \"transactionId\": \"f615f376-5ac7-4305-91b2-d2585497ba0d\",\r\n            \"entrantId\": null,\r\n            \"responseTimeUTC\": \"2019-06-17T05:04:36\",\r\n            \"responseTimeLocal\": \"2019-06-17T15:04:36\",\r\n            \"forceResponse\": null,\r\n            \"statusCode\": null,\r\n            \"statusDescription\": \"Success\",\r\n            \"prizeTypeId\": \"10000000-0000-0000-0000-000000000001\",\r\n            \"prizeId\": \"e9b9f7fb-0a39-45e3-9b11-e4d98540b178\",\r\n            \"userIP\": \"… 250\",\r\n            \"processingTimeMs\": 94,\r\n            \"logData\": null\r\n        },\r\n        {\r\n            \"responseId\": \"aba32de4-d559-49fd-a877-621903c05305\",\r\n            \"transactionId\": \"c9ed7139-e4a4-4d83-9604-1078c94a316c\",\r\n            \"entrantId\": null,\r\n            \"responseTimeUTC\": \"2019-06-17T05:04:34\",\r\n            \"responseTimeLocal\": \"2019-06-17T15:04:34\",\r\n            \"forceResponse\": null,\r\n            \"statusCode\": null,\r\n            \"statusDescription\": \"Success\",\r\n            \"prizeTypeId\": null,\r\n            \"prizeId\": null,\r\n            \"userIP\": \"… 250\",\r\n            \"processingTimeMs\": 16,\r\n            \"logData\": null\r\n        },\r\n        {\r\n            \"responseId\": \"f096b013-623c-4041-9ccf-1dc49a8e1ec5\",\r\n            \"transactionId\": \"75fb4ed8-96c0-4d8a-8651-093b79109888\",\r\n            \"entrantId\": null,\r\n            \"responseTimeUTC\": \"2019-06-17T05:04:32\",\r\n            \"responseTimeLocal\": \"2019-06-17T15:04:32\",\r\n            \"forceResponse\": null,\r\n            \"statusCode\": null,\r\n            \"statusDescription\": \"Success\",\r\n            \"prizeTypeId\": \"30000000-0000-0000-0000-000000000003\",\r\n            \"prizeId\": \"2a0ccd57-5547-4ab8-a601-019e1d743f9c\",\r\n            \"userIP\": \"… 250\",\r\n            \"processingTimeMs\": 31,\r\n            \"logData\": null\r\n        },\r\n        {\r\n            \"responseId\": \"e672778e-f6c1-4802-84c3-d3b50c24132f\",\r\n            \"transactionId\": \"140ebf4d-53bf-43da-afa6-a8a5c388175a\",\r\n            \"entrantId\": null,\r\n            \"responseTimeUTC\": \"2019-06-17T05:04:30\",\r\n            \"responseTimeLocal\": \"2019-06-17T15:04:30\",\r\n            \"forceResponse\": null,\r\n            \"statusCode\": null,\r\n            \"statusDescription\": \"Success\",\r\n            \"prizeTypeId\": \"40000000-0000-0000-0000-000000000004\",\r\n            \"prizeId\": \"6963d7fb-5d6a-4611-9ce0-00116123d2d5\",\r\n            \"userIP\": \"… 250\",\r\n            \"processingTimeMs\": 297,\r\n            \"logData\": null\r\n        },\r\n        {\r\n            \"responseId\": \"639dbd0e-6d0d-475f-be15-f6be5d21bf9e\",\r\n            \"transactionId\": \"768c835b-eae2-4e32-a996-a16bcebcc405\",\r\n            \"entrantId\": null,\r\n            \"responseTimeUTC\": \"2019-06-17T05:04:27\",\r\n            \"responseTimeLocal\": \"2019-06-17T15:04:27\",\r\n            \"forceResponse\": null,\r\n            \"statusCode\": null,\r\n            \"statusDescription\": \"Success\",\r\n            \"prizeTypeId\": \"20000000-0000-0000-0000-000000000002\",\r\n            \"prizeId\": \"ff0f4e6c-f8b6-465f-874a-a02fb03be9c1\",\r\n            \"userIP\": \"… 250\",\r\n            \"processingTimeMs\": 63,\r\n            \"logData\": null\r\n        },\r\n        {\r\n            \"responseId\": \"1fe44fd3-dfc6-49ee-bdf4-09385f9e9264\",\r\n            \"transactionId\": \"d80c76d7-a7e4-474c-e7dc-a93a79a636e9\",\r\n            \"entrantId\": null,\r\n            \"responseTimeUTC\": \"2019-06-17T04:59:11\",\r\n            \"responseTimeLocal\": \"2019-06-17T14:59:11\",\r\n            \"forceResponse\": null,\r\n            \"statusCode\": null,\r\n            \"statusDescription\": \"Success\",\r\n            \"prizeTypeId\": null,\r\n            \"prizeId\": null,\r\n            \"userIP\": \"… .48\",\r\n            \"processingTimeMs\": 439,\r\n            \"logData\": null\r\n        }\r\n    ]\r\n}"}],"_postman_id":"218d07c5-4208-f8a8-c3e6-b20542764e68"}],"event":[{"listen":"prerequest","script":{"id":"58b9a6f2-923e-4c9f-bf0d-860232b1bfce","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7dc652ae-6c54-4857-a716-5523b58f9a7b","type":"text/javascript","exec":[""]}}]}