{"_id":"56c35c58c0c4630d004e8652","user":"56c35c45c4796b0d007eefdf","category":{"_id":"56c35c57c0c4630d004e8650","version":"56c35c56c0c4630d004e864f","__v":17,"pages":["56c35c58c0c4630d004e8652","56c38f9c2d97560d00e23cb8","56c39b11e1e4190d003429b0","56c3a90c28bd680d005e7aa3","56c7b98a8bf67e0d0073477a","56c7b9d7379b311700ed8fe1","56c7bcc55652c217008e0923","56c7bee8606ee717003c4769","56cf423f8629f91300fd9779","56cf45b944c5700b0095c175","56cf4709287eb20b009f9eec","56cf49208acacb1300814884","56cf4c4c287eb20b009f9f01","56cf4d968629f91300fd9797","56cf4ede8acacb1300814890","56cf520b8629f91300fd97a9","56cf52d5287eb20b009f9f12"],"project":"56c35c56c0c4630d004e864c","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-02-16T17:28:55.483Z","from_sync":false,"order":0,"slug":"documentation","title":"Buzz API Overview"},"githubsync":"","project":"56c35c56c0c4630d004e864c","__v":8,"parentDoc":null,"version":{"_id":"56c35c56c0c4630d004e864f","project":"56c35c56c0c4630d004e864c","__v":8,"createdAt":"2016-02-16T17:28:54.864Z","releaseDate":"2016-02-16T17:28:54.864Z","categories":["56c35c57c0c4630d004e8650","56c7b9e5379b311700ed8fe3","56c7bab4606ee717003c4766","56c7bb3613e5400d001e8cbd","56cf3f5a5267d70b00494c4b","56cf3f866c5d7a13005ee894","56fd3956caad892200847bce","599da256e7742b002588bb02"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"0.5.0","version":"0.5"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-02-16T17:28:56.423Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":true,"order":0,"body":"The Buzz API uses a REST interface over http to view, create, update and delete objects. You can access the REST API on the command line using cURL or through a client built in whichever language you prefer. Throughout this documentation we show examples using cURL. The typical syntax for a Buzz request using cURL is:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -X [method] [path]/rest/[object_name] -b cookies.txt -d '{JSON payload}'\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\nExplanation of the cURL command:\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`-X`\",\n    \"0-1\": \"Tells CURL to use the [method] instead of defaulting to GET\",\n    \"1-0\": \"`[method]`\",\n    \"2-0\": \"`[object_name]`\",\n    \"3-0\": \"`-b cookies.txt`\",\n    \"4-0\": \"`-d '{JSON payload}'`\",\n    \"1-1\": \"`GET` = gets object\\n`POST` = writes new object\\n`PUT` = updates existing object\\n`DELETE` = deletes object\",\n    \"2-1\": \"Corresponds to the object you wish to manipulate, examples include `user`, `advertiser`, `line_item`, etc. Object names are lowercase and words are separated with an underscore. A complete list of objects is in the [API Reference](doc:advertisers) section.\",\n    \"3-1\": \"Tells curl to read session cookies from a file called `cookies.txt`, more on this in [Authentication](doc:authentication-1).\",\n    \"4-1\": \"The JSON payload should contain whatever data needs to be sent to the API for querying the system, pushing new data, etc.\"\n  },\n  \"cols\": 2,\n  \"rows\": 5\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Getting Help\"\n}\n[/block]\nTo get help on the command line and see all available objects use the \"help\" object:\n```curl -X GET \"[path]/buzz/rest/help\"```\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Working with Modules\"\n}\n[/block]\nThe API is also used to work with modules that define [Targeting](doc:targeting-module), [Creative Attributes](doc:creative-attributes), and [Bidding Strategies](doc:bidding-strategies). Each of these can have many different modules installed in Buzz, and as a developer you will need to GET available fields from them, and validate whether your inputs are acceptable.\n\nThe chart below summarizes these modules:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Module Type\",\n    \"h-1\": \"What is it?\",\n    \"h-2\": \"Example API Request\",\n    \"0-0\": \"Targeting\",\n    \"0-1\": \"Available targeting criteria for use with a Targeting Template.\",\n    \"0-2\": \"```curl -X [method] [path]/rest/targeting/[module_name] -b cookies.txt -d '{JSON payload}'```\",\n    \"1-0\": \"Creative Attributes\",\n    \"1-1\": \"Attributes associated with a Creative to allow proper matching with available inventory.\",\n    \"1-2\": \"```curl -X [method] [path]/rest/attributes/[module_name] -b cookies.txt -d '{JSON payload}'```\",\n    \"2-0\": \"Bidding Strategies\",\n    \"2-1\": \"Instructions for the ad server/bidding agent to determine the proper delivery (bid) of the ad\",\n    \"2-2\": \"```curl -X [method] [path]/rest/bidding/[module_name] -b cookies.txt -d '{JSON payload}'```\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]","excerpt":"","slug":"getting-started","type":"basic","title":"Getting Started with the Buzz API"}

Getting Started with the Buzz API


The Buzz API uses a REST interface over http to view, create, update and delete objects. You can access the REST API on the command line using cURL or through a client built in whichever language you prefer. Throughout this documentation we show examples using cURL. The typical syntax for a Buzz request using cURL is: [block:code] { "codes": [ { "code": "curl -X [method] [path]/rest/[object_name] -b cookies.txt -d '{JSON payload}'", "language": "curl" } ] } [/block] Explanation of the cURL command: [block:parameters] { "data": { "0-0": "`-X`", "0-1": "Tells CURL to use the [method] instead of defaulting to GET", "1-0": "`[method]`", "2-0": "`[object_name]`", "3-0": "`-b cookies.txt`", "4-0": "`-d '{JSON payload}'`", "1-1": "`GET` = gets object\n`POST` = writes new object\n`PUT` = updates existing object\n`DELETE` = deletes object", "2-1": "Corresponds to the object you wish to manipulate, examples include `user`, `advertiser`, `line_item`, etc. Object names are lowercase and words are separated with an underscore. A complete list of objects is in the [API Reference](doc:advertisers) section.", "3-1": "Tells curl to read session cookies from a file called `cookies.txt`, more on this in [Authentication](doc:authentication-1).", "4-1": "The JSON payload should contain whatever data needs to be sent to the API for querying the system, pushing new data, etc." }, "cols": 2, "rows": 5 } [/block] [block:api-header] { "type": "basic", "title": "Getting Help" } [/block] To get help on the command line and see all available objects use the "help" object: ```curl -X GET "[path]/buzz/rest/help"``` [block:api-header] { "type": "basic", "title": "Working with Modules" } [/block] The API is also used to work with modules that define [Targeting](doc:targeting-module), [Creative Attributes](doc:creative-attributes), and [Bidding Strategies](doc:bidding-strategies). Each of these can have many different modules installed in Buzz, and as a developer you will need to GET available fields from them, and validate whether your inputs are acceptable. The chart below summarizes these modules: [block:parameters] { "data": { "h-0": "Module Type", "h-1": "What is it?", "h-2": "Example API Request", "0-0": "Targeting", "0-1": "Available targeting criteria for use with a Targeting Template.", "0-2": "```curl -X [method] [path]/rest/targeting/[module_name] -b cookies.txt -d '{JSON payload}'```", "1-0": "Creative Attributes", "1-1": "Attributes associated with a Creative to allow proper matching with available inventory.", "1-2": "```curl -X [method] [path]/rest/attributes/[module_name] -b cookies.txt -d '{JSON payload}'```", "2-0": "Bidding Strategies", "2-1": "Instructions for the ad server/bidding agent to determine the proper delivery (bid) of the ad", "2-2": "```curl -X [method] [path]/rest/bidding/[module_name] -b cookies.txt -d '{JSON payload}'```" }, "cols": 3, "rows": 3 } [/block]