{"_id":"56fc5112896b2c0e00715ef6","editedParams2":true,"parentDoc":null,"category":{"_id":"56cf3f866c5d7a13005ee894","__v":67,"project":"56c35c56c0c4630d004e864c","version":"56c35c56c0c4630d004e864f","pages":["56cf5bb88629f91300fd97c5","56cf5bf68629f91300fd97c7","56cf5fd2287eb20b009f9f37","56cf631a44c5700b0095c1c8","56cf63ae6c5d7a13005eeb58","56cf6408287eb20b009f9f40","56cf643a287eb20b009f9f43","56cf65ba336aa60b0086a435","56cf66df336aa60b0086a440","56cf69b344c5700b0095c1cf","56cf6a3d44c5700b0095c1d3","56cf6ac6336aa60b0086a44e","56cf6b298acacb13008148c9","56cf6cd68629f91300fd97e3","56cf6e048acacb13008148cd","56cf6eac336aa60b0086a455","56cf6edf287eb20b009f9f5a","56cf6f6b336aa60b0086a462","56cf704e8629f91300fd97f0","56cf70bf6c5d7a13005eeb6f","56cf72c6287eb20b009f9f76","56cf74c86c5d7a13005eeb7f","56cf75f5336aa60b0086a496","56cf76b68629f91300fd9801","56cf76da8629f91300fd9805","56cf776c8acacb13008148dc","56cf77ca6c5d7a13005eeb92","56cf788044c5700b0095c1fe","56cf78c28acacb13008148e5","56cf7a9544c5700b0095c207","56cf7b9b44c5700b0095c20c","56cf7c268629f91300fd980f","56cf7c456c5d7a13005eeba4","56d097b1376b040b005b3029","56d0992940d36e1d00bc13dd","56d099ed167e1e1b008079d2","56d09afa376b040b005b3032","56d09ba01ecc471500f1794a","56d09c13376b040b005b3034","56d09cde167e1e1b008079d7","56d09f30167e1e1b008079e2","56d0a00b376b040b005b303d","56d0a063167e1e1b008079e6","56d0a11a7c2e100b000af929","56d0b072167e1e1b00807a2e","56d0b0fb7c2e100b000af98b","56d0b16d1ecc471500f179af","56d0b1ee7c2e100b000af991","56d0b2407c2e100b000af998","56d0b2e640d36e1d00bc1456","56d0b3511ecc471500f179bc","56d0b3aab2cb7013004de65b","56d0b3d1b2cb7013004de65e","56d0b3fe7c2e100b000af9a1","56d0b4d67c2e100b000af9a5","56d0b52fb2cb7013004de666","56d0b59db2cb7013004de66c","56d0b621167e1e1b00807a4c","56d0b787167e1e1b00807a54","56d0b82d167e1e1b00807a55","56d0b8a8167e1e1b00807a5d","56d0b8fe167e1e1b00807a60","56d0b9951ecc471500f179c7","56d0ba55376b040b005b30a1","56d0bac31ecc471500f179cc","56d0bb6e167e1e1b00807a64","56d0bc95167e1e1b00807a6a"],"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-02-25T17:53:10.154Z","from_sync":false,"order":1,"slug":"buzz-api-reference","title":"Buzz API Reference"},"editedParams":true,"__v":10,"project":"56c35c56c0c4630d004e864c","user":"56c39c05bc41330d009f25d7","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"},"githubsync":"","updates":["591610e3652cb41900aedc05"],"next":{"pages":[],"description":""},"createdAt":"2016-03-30T22:20:02.642Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","examples":{"codes":[{"code":"curl -X GET \"[host]/rest/view\" -b cookies.txt -d '{\"view_name\":\"line_item_types\"}'\n# You can also query field values\ncurl -X GET \"[host]/rest/view\" -b cookies.txt -d  '{\"view_name\":\"cities\",\"city_name\":\"Newark\"}'","language":"curl"}]},"method":"get","results":{"codes":[{"code":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"line_item_type_id\": 0,\n            \"line_item_type\": \"banner\",\n            \"sizeless\": false,\n            \"pixel_size\": 1\n        },\n        {\n            \"line_item_type_id\": 1,\n            \"line_item_type\": \"video\",\n            \"sizeless\": false,\n            \"pixel_size\": -1\n        }\n    ]\n}","language":"text","status":200}]},"auth":"required","params":[{"_id":"56fc5112896b2c0e00715ef7","ref":"","in":"query","required":true,"desc":"The view name.","default":"","type":"string","name":"view_name"}],"url":"/rest/view"},"isReference":true,"order":192,"body":"[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"GET\",\n    \"0-1\": \"None\",\n    \"1-0\": \"POST\",\n    \"1-1\": \"Not allowed\",\n    \"2-0\": \"PUT\",\n    \"2-1\": \"Not allowed\",\n    \"3-0\": \"DELETE\",\n    \"3-1\": \"Not allowed\",\n    \"h-0\": \"Method\",\n    \"h-1\": \"Restriction\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Getting a Complete List of Views\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"# Will return a list of all views with descriptions of the fields, or you can get data about a specific view\\ncurl -X GET \\\"[host]/rest/view_list\\\" -b cookies.txt -d '{\\\"view_name\\\":\\\"line_item_types\\\"}'\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\nThe GET request above will show the results below:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"success\\\": true,\\n    \\\"payload\\\": [\\n        {\\n            \\\"view_name\\\": \\\"line_item_types\\\",\\n            \\\"object_type\\\": \\\"static\\\",\\n            \\\"table_name\\\": \\\"line_item_types\\\",\\n            \\\"primary_view\\\": true,\\n            \\\"allow_writes\\\": false,\\n            \\\"customizable\\\": false,\\n            \\\"read_only_db\\\": false,\\n            \\\"fields\\\": [\\n                {\\n                    \\\"view_name\\\": \\\"line_item_types\\\",\\n                    \\\"field\\\": \\\"line_item_type_id\\\",\\n                    \\\"field_order\\\": 1,\\n                    \\\"field_name\\\": \\\"Line Item Type ID\\\",\\n                    \\\"field_hint\\\": null,\\n                    \\\"format\\\": null,\\n                    \\\"link\\\": null,\\n                    \\\"search_type\\\": \\\"int\\\",\\n                    \\\"field_width\\\": null,\\n                    \\\"required\\\": false,\\n                    \\\"hidden\\\": false\\n                },\\n                {\\n                    \\\"view_name\\\": \\\"line_item_types\\\",\\n                    \\\"field\\\": \\\"line_item_type\\\",\\n                    \\\"field_order\\\": 2,\\n                    \\\"field_name\\\": \\\"Type\\\",\\n                    \\\"field_hint\\\": null,\\n                    \\\"format\\\": null,\\n                    \\\"link\\\": null,\\n                    \\\"search_type\\\": \\\"string\\\",\\n                    \\\"field_width\\\": null,\\n                    \\\"required\\\": false,\\n                    \\\"hidden\\\": false\\n                },\\n                {\\n                    \\\"view_name\\\": \\\"line_item_types\\\",\\n                    \\\"field\\\": \\\"sizeless\\\",\\n                    \\\"field_order\\\": 3,\\n                    \\\"field_name\\\": null,\\n                    \\\"field_hint\\\": null,\\n                    \\\"format\\\": null,\\n                    \\\"link\\\": null,\\n                    \\\"search_type\\\": \\\"boolean\\\",\\n                    \\\"field_width\\\": null,\\n                    \\\"required\\\": false,\\n                    \\\"hidden\\\": false\\n                },\\n                {\\n                    \\\"view_name\\\": \\\"line_item_types\\\",\\n                    \\\"field\\\": \\\"pixel_size\\\",\\n                    \\\"field_order\\\": 4,\\n                    \\\"field_name\\\": null,\\n                    \\\"field_hint\\\": null,\\n                    \\\"format\\\": null,\\n                    \\\"link\\\": null,\\n                    \\\"search_type\\\": \\\"int\\\",\\n                    \\\"field_width\\\": null,\\n                    \\\"required\\\": false,\\n                    \\\"hidden\\\": false\\n                }\\n            ]\\n        }\\n    ]\\n}\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"List of Commonly-Used Views\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Table\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"advertiser_category\",\n    \"0-1\": \"Categorization for advertisers (e.g. `automotive`)\",\n    \"1-0\": \"advertiser_index\",\n    \"1-1\": \"A master list of all advertisers\",\n    \"2-0\": \"advertiser_sensitive_category\",\n    \"2-1\": \"List of sensitive categories to describe the advertiser (e.g. alcohol)\",\n    \"4-0\": \"bandwidth\",\n    \"4-1\": \"Codes for user bandwidth targeting\",\n    \"5-0\": \"bidding_strategies\",\n    \"5-1\": \"List of supported bidding strategies\",\n    \"7-0\": \"cities\",\n    \"7-1\": \"Global list of cities and regions. Use `cities_active_view` view for targeting.\",\n    \"10-0\": \"countries\",\n    \"10-1\": \"List of all country codes. Use `countries_active_view` view for targeting.\",\n    \"12-0\": \"creative_approval_vendors\",\n    \"12-1\": \"Creative approval vendors\",\n    \"13-0\": \"creative_sizes\",\n    \"13-1\": \"Acceptable creative sizes (width and height)\",\n    \"14-0\": \"currency\",\n    \"14-1\": \"Acceptable currency codes\",\n    \"15-0\": \"DMA\",\n    \"15-1\": \"Google Metro codes (similar to DMAs)\",\n    \"16-0\": \"environment_types\",\n    \"16-1\": \"Environments in which the ad may be served. 0=web, 1=in-app\",\n    \"17-0\": \"event_types\",\n    \"17-1\": \"Event types\",\n    \"19-0\": \"inventory_source\",\n    \"19-1\": \"Inventory sources (e.g. Google)\",\n    \"21-0\": \"line_item_types\",\n    \"21-1\": \"Line Item types (e.g. banner, mobile, video)\",\n    \"25-0\": \"macros\",\n    \"25-1\": \"Ad server macros allowable in Creatives and Creative Templates\",\n    \"26-0\": \"mime_types\",\n    \"26-1\": \"Acceptable mime types for Creative Asset upload\",\n    \"27-0\": \"object_types\",\n    \"27-1\": \"Object types (e.g. user, creative, targeting_templates)\",\n    \"28-0\": \"regions\",\n    \"28-1\": \"Global list of regions, including US States. Use `regions_active_view` for targeting.\",\n    \"30-0\": \"report_calculated_fields\",\n    \"30-1\": \"Fields in reporting that are calculated when a reporting request is submitted\",\n    \"31-0\": \"report_date_filters\",\n    \"31-1\": \"List of special reporting date parameters supported such as `today`\",\n    \"32-0\": \"report_fields\",\n    \"32-1\": \"List of fields per report (see `reports` below)\",\n    \"33-0\": \"reports\",\n    \"33-1\": \"List of supported reports\",\n    \"34-0\": \"segment_file_format\",\n    \"34-1\": \"Acceptable formats for uploading segment files\",\n    \"36-0\": \"segment_upload_status\",\n    \"36-1\": \"List of possible statuses for a segment file upload\",\n    \"38-0\": \"video_apis\",\n    \"38-1\": \"Types of video APIs supported\",\n    \"39-0\": \"video_companion_types\",\n    \"39-1\": \"Types of video companions (`static`, `HTML`, etc)\",\n    \"40-0\": \"video_creative_transcoding_queue\",\n    \"40-1\": \"List of videos waiting to be transcoded\",\n    \"41-0\": \"video_encoding_profiles\",\n    \"41-1\": \"List of transcoding profiles supported\",\n    \"42-0\": \"video_protocols\",\n    \"42-1\": \"Types of video protocols supported\",\n    \"11-0\": \"countries_active_view\",\n    \"11-1\": \"List of country codes that are enabled for targeting\",\n    \"8-0\": \"cities_active_view\",\n    \"8-1\": \"List of cities and regions that are enabled for targeting (subset based on `countries_active` view, below)\",\n    \"29-0\": \"regions_active_view\",\n    \"29-1\": \"List of regions enabled for targeting.\",\n    \"9-0\": \"continents\",\n    \"9-1\": \"A list of continents in which data centers exist. Used to determine where a [Campaign](doc:campaigns) may be eligible to serve or where a [Segment Upload](doc:segment-upload)  is uploaded.\",\n    \"22-0\": \"lookup_apps\",\n    \"22-1\": \"Useful lookup data about the 100,000 most commonly seen mobile apps\",\n    \"23-0\": \"lookup_domains\",\n    \"23-1\": \"The 100,000 most commonly seen domains\",\n    \"24-0\": \"lookup_inventory\",\n    \"24-1\": \"The 100,000 most commonly seen combinations of site_id and placement_id\",\n    \"35-0\": \"segment_stats\",\n    \"35-1\": \"List of segments with estimated number of users in each segment per continent\",\n    \"20-0\": \"line_item_stats\",\n    \"20-1\": \"Line item objects including many fields showing updated performance results\",\n    \"6-1\": \"Campaign objects including many fields showing updated performance results\",\n    \"6-0\": \"campaign_stats\",\n    \"3-1\": \"Advertiser objects including many fields showing updated performance results\",\n    \"3-0\": \"advertiser_stats\",\n    \"18-0\": \"event_tag_types\",\n    \"18-1\": \"Types of tags supported for events ([event_tag API](doc:event-tag)) and segments ([segment_tag API](doc:segment_tag))\",\n    \"37-0\": \"tag_types\",\n    \"37-1\": \"List of Banner Ad Types from OpenRTB 5.2\"\n  },\n  \"cols\": 2,\n  \"rows\": 43\n}\n[/block]","excerpt":"The View API method allows you to flexibly GET data from the Buzz system. It is especially useful for querying static tables to discover ad types. acceptable mime types, or other lookup fields. Views must be created by the Buzz administrator. Only GET requests are supported.","slug":"view","type":"endpoint","title":"View"}

getView

The View API method allows you to flexibly GET data from the Buzz system. It is especially useful for querying static tables to discover ad types. acceptable mime types, or other lookup fields. Views must be created by the Buzz administrator. Only GET requests are supported.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

view_name:
required
string
The view name.

Examples


Result Format


Documentation

[block:parameters] { "data": { "0-0": "GET", "0-1": "None", "1-0": "POST", "1-1": "Not allowed", "2-0": "PUT", "2-1": "Not allowed", "3-0": "DELETE", "3-1": "Not allowed", "h-0": "Method", "h-1": "Restriction" }, "cols": 2, "rows": 4 } [/block] [block:api-header] { "title": "Getting a Complete List of Views" } [/block] [block:code] { "codes": [ { "code": "# Will return a list of all views with descriptions of the fields, or you can get data about a specific view\ncurl -X GET \"[host]/rest/view_list\" -b cookies.txt -d '{\"view_name\":\"line_item_types\"}'", "language": "curl" } ] } [/block] The GET request above will show the results below: [block:code] { "codes": [ { "code": "{\n \"success\": true,\n \"payload\": [\n {\n \"view_name\": \"line_item_types\",\n \"object_type\": \"static\",\n \"table_name\": \"line_item_types\",\n \"primary_view\": true,\n \"allow_writes\": false,\n \"customizable\": false,\n \"read_only_db\": false,\n \"fields\": [\n {\n \"view_name\": \"line_item_types\",\n \"field\": \"line_item_type_id\",\n \"field_order\": 1,\n \"field_name\": \"Line Item Type ID\",\n \"field_hint\": null,\n \"format\": null,\n \"link\": null,\n \"search_type\": \"int\",\n \"field_width\": null,\n \"required\": false,\n \"hidden\": false\n },\n {\n \"view_name\": \"line_item_types\",\n \"field\": \"line_item_type\",\n \"field_order\": 2,\n \"field_name\": \"Type\",\n \"field_hint\": null,\n \"format\": null,\n \"link\": null,\n \"search_type\": \"string\",\n \"field_width\": null,\n \"required\": false,\n \"hidden\": false\n },\n {\n \"view_name\": \"line_item_types\",\n \"field\": \"sizeless\",\n \"field_order\": 3,\n \"field_name\": null,\n \"field_hint\": null,\n \"format\": null,\n \"link\": null,\n \"search_type\": \"boolean\",\n \"field_width\": null,\n \"required\": false,\n \"hidden\": false\n },\n {\n \"view_name\": \"line_item_types\",\n \"field\": \"pixel_size\",\n \"field_order\": 4,\n \"field_name\": null,\n \"field_hint\": null,\n \"format\": null,\n \"link\": null,\n \"search_type\": \"int\",\n \"field_width\": null,\n \"required\": false,\n \"hidden\": false\n }\n ]\n }\n ]\n}", "language": "text" } ] } [/block] [block:api-header] { "type": "basic", "title": "List of Commonly-Used Views" } [/block] [block:parameters] { "data": { "h-0": "Table", "h-1": "Description", "0-0": "advertiser_category", "0-1": "Categorization for advertisers (e.g. `automotive`)", "1-0": "advertiser_index", "1-1": "A master list of all advertisers", "2-0": "advertiser_sensitive_category", "2-1": "List of sensitive categories to describe the advertiser (e.g. alcohol)", "4-0": "bandwidth", "4-1": "Codes for user bandwidth targeting", "5-0": "bidding_strategies", "5-1": "List of supported bidding strategies", "7-0": "cities", "7-1": "Global list of cities and regions. Use `cities_active_view` view for targeting.", "10-0": "countries", "10-1": "List of all country codes. Use `countries_active_view` view for targeting.", "12-0": "creative_approval_vendors", "12-1": "Creative approval vendors", "13-0": "creative_sizes", "13-1": "Acceptable creative sizes (width and height)", "14-0": "currency", "14-1": "Acceptable currency codes", "15-0": "DMA", "15-1": "Google Metro codes (similar to DMAs)", "16-0": "environment_types", "16-1": "Environments in which the ad may be served. 0=web, 1=in-app", "17-0": "event_types", "17-1": "Event types", "19-0": "inventory_source", "19-1": "Inventory sources (e.g. Google)", "21-0": "line_item_types", "21-1": "Line Item types (e.g. banner, mobile, video)", "25-0": "macros", "25-1": "Ad server macros allowable in Creatives and Creative Templates", "26-0": "mime_types", "26-1": "Acceptable mime types for Creative Asset upload", "27-0": "object_types", "27-1": "Object types (e.g. user, creative, targeting_templates)", "28-0": "regions", "28-1": "Global list of regions, including US States. Use `regions_active_view` for targeting.", "30-0": "report_calculated_fields", "30-1": "Fields in reporting that are calculated when a reporting request is submitted", "31-0": "report_date_filters", "31-1": "List of special reporting date parameters supported such as `today`", "32-0": "report_fields", "32-1": "List of fields per report (see `reports` below)", "33-0": "reports", "33-1": "List of supported reports", "34-0": "segment_file_format", "34-1": "Acceptable formats for uploading segment files", "36-0": "segment_upload_status", "36-1": "List of possible statuses for a segment file upload", "38-0": "video_apis", "38-1": "Types of video APIs supported", "39-0": "video_companion_types", "39-1": "Types of video companions (`static`, `HTML`, etc)", "40-0": "video_creative_transcoding_queue", "40-1": "List of videos waiting to be transcoded", "41-0": "video_encoding_profiles", "41-1": "List of transcoding profiles supported", "42-0": "video_protocols", "42-1": "Types of video protocols supported", "11-0": "countries_active_view", "11-1": "List of country codes that are enabled for targeting", "8-0": "cities_active_view", "8-1": "List of cities and regions that are enabled for targeting (subset based on `countries_active` view, below)", "29-0": "regions_active_view", "29-1": "List of regions enabled for targeting.", "9-0": "continents", "9-1": "A list of continents in which data centers exist. Used to determine where a [Campaign](doc:campaigns) may be eligible to serve or where a [Segment Upload](doc:segment-upload) is uploaded.", "22-0": "lookup_apps", "22-1": "Useful lookup data about the 100,000 most commonly seen mobile apps", "23-0": "lookup_domains", "23-1": "The 100,000 most commonly seen domains", "24-0": "lookup_inventory", "24-1": "The 100,000 most commonly seen combinations of site_id and placement_id", "35-0": "segment_stats", "35-1": "List of segments with estimated number of users in each segment per continent", "20-0": "line_item_stats", "20-1": "Line item objects including many fields showing updated performance results", "6-1": "Campaign objects including many fields showing updated performance results", "6-0": "campaign_stats", "3-1": "Advertiser objects including many fields showing updated performance results", "3-0": "advertiser_stats", "18-0": "event_tag_types", "18-1": "Types of tags supported for events ([event_tag API](doc:event-tag)) and segments ([segment_tag API](doc:segment_tag))", "37-0": "tag_types", "37-1": "List of Banner Ad Types from OpenRTB 5.2" }, "cols": 2, "rows": 43 } [/block]