{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","settings":"","params":[],"results":{"codes":[]}},"next":{"description":"","pages":[]},"title":"Conversion Tags","type":"basic","slug":"conversion-tags-1","excerpt":"","body":"Conversion, or [Event Tags](doc:event-tag) are generated by the Buzz API or UI and should be placed on the website where a conversion will be recorded. \n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Sample Tag\"\n}\n[/block]\nA conversion tag will typically look like this:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<!--BEGIN BEESWAX CONVERSION TAG, DO NOT REMOVE --> <img src=\\\"https://cnv.event.prod.bidr.io/log/cnv?tag_id=12345&buzz_key=stinger&value=[VALUE]&segment_key=12345&order=[ORDER]&ord=[CACHEBUSTER]\\\" height=\\\"0\\\" width=\\\"0\\\"> <!--END BEESWAX CONVERSION TAG, DO NOT REMOVE -->\",\n      \"language\": \"html\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Parameters\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"What it means\",\n    \"h-2\": \"What do you need to do\",\n    \"0-0\": \"`tag_id`\",\n    \"0-1\": \"Unique identifier for the tag in Buzz, auto-generated\",\n    \"0-2\": \"Do not edit\",\n    \"1-2\": \"Do not edit\",\n    \"1-1\": \"Unique instance of Buzz, auto-generated\",\n    \"1-0\": \"`buzz_key`\",\n    \"2-0\": \"`value`\",\n    \"2-1\": \"The value assigned to the conversion. For example if the value is set to \\\"30\\\" the conversion will be aggregated with a value of 30. If omitted, the tag value set when the event was created in Buzz will be used.\",\n    \"2-2\": \"If you want to set the value in real time when the user converts, you should replace the value with a number.\",\n    \"3-0\": \"`segment_key`\",\n    \"3-1\": \"The unique id of a segment to put the user into when the user converts. This is generally set when the event is created.\",\n    \"3-2\": \"Do not edit\",\n    \"4-0\": \"`order`\",\n    \"4-1\": \"The number of items purchased as part of the conversion. For example if the value is set to \\\"2\\\" the conversion will be aggregated with a order of 2. If omitted, the tag value set when the event was created in Buzz will be used.\",\n    \"4-2\": \"If you want to set the order in real time when the user converts, you should replace the order with a number.\",\n    \"5-0\": \"`ord`\",\n    \"5-1\": \"Random number to prevent browser caching of the conversion\",\n    \"5-2\": \"Replace the [CACHEBUSTER] string with a random number generated at run time.\"\n  },\n  \"cols\": 3,\n  \"rows\": 6\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Example Javascript\"\n}\n[/block]\nConversion tags can either be inserted server-side by your content management system, or client-side in Javascript on your page. The only requirement for implementation is to replace the `[CACHEBUSTER]` macro with a random number. The code below provides a javascript example, where you should replace the tag with the one generated from Buzz:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"var cachebuster = Math.floor(Math.random() * 10000000000),\\n \\nimg = new Image(); \\nimg.width = 0;\\nimg.height = 0;\\n \\n//replace this with the tag you generated from Buzz\\nimg.src = 'https://cnv.event.prod.bidr.io/log/cnv?tag_id=12345&buzz_key=stinger&value=[VALUE]&segment_key=12345&order=[ORDER]&ord=' + cachebuster;\\n \\ndocument.body.appendChild(img); // or wherever the image should be placed\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]","updates":[],"order":7,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"56cba5c5d5c6241d00ef5e93","parentDoc":null,"createdAt":"2016-02-23T00:20:21.028Z","version":{"version":"0.5","version_clean":"0.5.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["56c35c57c0c4630d004e8650","56c7b9e5379b311700ed8fe3","56c7bab4606ee717003c4766","56c7bb3613e5400d001e8cbd","56cf3f5a5267d70b00494c4b","56cf3f866c5d7a13005ee894","56fd3956caad892200847bce","599da256e7742b002588bb02"],"_id":"56c35c56c0c4630d004e864f","createdAt":"2016-02-16T17:28:54.864Z","project":"56c35c56c0c4630d004e864c","releaseDate":"2016-02-16T17:28:54.864Z","__v":8},"project":"56c35c56c0c4630d004e864c","user":"56c39c05bc41330d009f25d7","__v":4,"category":{"sync":{"isSync":false,"url":""},"pages":["56c7c193f9aa3b0d00c8458f","56cb80a4c675f50b00a4b826","56cb83859f4ae20b00644f1f","56cb853a245b841300806f82","56cb863c32011d2500681925","56cb88a4245b841300806f8b","56cb9915245b841300806fa7","56cb9a079f4ae20b00644f48","56cb9b5bc675f50b00a4b859","56cba5929f4ae20b00644f5d","56cba5c5d5c6241d00ef5e93","56cbab9c9f4ae20b00644f76","56cbad69c675f50b00a4b881","56cbb060d5c6241d00ef5ebb","56cf3c4d6c5d7a13005ee88c","56cf3d0e287eb20b009f9ec7","56cf3d7c5267d70b00494c42","56cf3ee0287eb20b009f9ecd"],"title":"Buzz Concepts","slug":"buzz-concepts","order":0,"from_sync":false,"reference":false,"_id":"56c7bab4606ee717003c4766","createdAt":"2016-02-20T01:00:36.607Z","project":"56c35c56c0c4630d004e864c","__v":18,"version":"56c35c56c0c4630d004e864f"},"githubsync":""}

Buzz API Overview

Buzz Concepts

Buzz API Reference

Buzz JSON Objects

Stinger

Conversion Tags

Conversion, or [Event Tags](doc:event-tag) are generated by the Buzz API or UI and should be placed on the website where a conversion will be recorded. [block:api-header] { "type": "basic", "title": "Sample Tag" } [/block] A conversion tag will typically look like this: [block:code] { "codes": [ { "code": "<!--BEGIN BEESWAX CONVERSION TAG, DO NOT REMOVE --> <img src=\"https://cnv.event.prod.bidr.io/log/cnv?tag_id=12345&buzz_key=stinger&value=[VALUE]&segment_key=12345&order=[ORDER]&ord=[CACHEBUSTER]\" height=\"0\" width=\"0\"> <!--END BEESWAX CONVERSION TAG, DO NOT REMOVE -->", "language": "html" } ] } [/block] [block:api-header] { "type": "basic", "title": "Parameters" } [/block] [block:parameters] { "data": { "h-0": "Parameter", "h-1": "What it means", "h-2": "What do you need to do", "0-0": "`tag_id`", "0-1": "Unique identifier for the tag in Buzz, auto-generated", "0-2": "Do not edit", "1-2": "Do not edit", "1-1": "Unique instance of Buzz, auto-generated", "1-0": "`buzz_key`", "2-0": "`value`", "2-1": "The value assigned to the conversion. For example if the value is set to \"30\" the conversion will be aggregated with a value of 30. If omitted, the tag value set when the event was created in Buzz will be used.", "2-2": "If you want to set the value in real time when the user converts, you should replace the value with a number.", "3-0": "`segment_key`", "3-1": "The unique id of a segment to put the user into when the user converts. This is generally set when the event is created.", "3-2": "Do not edit", "4-0": "`order`", "4-1": "The number of items purchased as part of the conversion. For example if the value is set to \"2\" the conversion will be aggregated with a order of 2. If omitted, the tag value set when the event was created in Buzz will be used.", "4-2": "If you want to set the order in real time when the user converts, you should replace the order with a number.", "5-0": "`ord`", "5-1": "Random number to prevent browser caching of the conversion", "5-2": "Replace the [CACHEBUSTER] string with a random number generated at run time." }, "cols": 3, "rows": 6 } [/block] [block:api-header] { "type": "basic", "title": "Example Javascript" } [/block] Conversion tags can either be inserted server-side by your content management system, or client-side in Javascript on your page. The only requirement for implementation is to replace the `[CACHEBUSTER]` macro with a random number. The code below provides a javascript example, where you should replace the tag with the one generated from Buzz: [block:code] { "codes": [ { "code": "var cachebuster = Math.floor(Math.random() * 10000000000),\n \nimg = new Image(); \nimg.width = 0;\nimg.height = 0;\n \n//replace this with the tag you generated from Buzz\nimg.src = 'https://cnv.event.prod.bidr.io/log/cnv?tag_id=12345&buzz_key=stinger&value=[VALUE]&segment_key=12345&order=[ORDER]&ord=' + cachebuster;\n \ndocument.body.appendChild(img); // or wherever the image should be placed", "language": "javascript" } ] } [/block]