{"_id":"59a5b36727cc70002fcb118b","project":"56c35c56c0c4630d004e864c","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"},"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"},"user":"56c39c05bc41330d009f25d7","githubsync":"","__v":2,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-08-29T18:33:11.904Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"code":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"segment_sharing_id\": 542245,\n            \"shared_account_id\": null,\n            \"segment_key\": \"factual-2\",\n            \"shared_buzz_key\": \"stingersbx\",\n            \"cpm_cost\": null,\n            \"account_id\": 74,\n            \"create_date\": \"2016-10-17 17:08:34\",\n            \"update_date\": \"2016-10-17 17:08:34\",\n            \"alternative_id\": null,\n            \"notes\": null,\n            \"active\": true,\n            \"buzz_key\": \"stingersbx\"\n        }\n    ]\n}","language":"text"}]},"method":"get","examples":{"codes":[{"code":"curl -X GET \"[host]/rest/segment_lookup\" -b cookies.txt -d '{\"source\":\"third-party\"}'","language":"curl"}]},"settings":"","auth":"required","params":[{"_id":"56d0bc95167e1e1b00807a6b","ref":"","in":"query","required":false,"desc":"Unique ID for the segment","default":"","type":"int","name":"segment_id"},{"_id":"59a5b545428df70039d30964","ref":"","in":"query","required":false,"desc":"Compound unique key including the Buzz Key and the segment_id","default":"","type":"string","name":"segment_key"},{"_id":"56fbec95698bea2b00de70e6","ref":"","in":"query","required":false,"desc":"Name for the segment","default":"","type":"string","name":"segment_name"},{"_id":"59a5b36727cc70002fcb118c","ref":"","in":"query","required":false,"desc":"Either `third-party` or `local`. See description below.","default":"","type":"string","name":"source"}],"url":"/rest/segment_lookup"},"isReference":true,"order":147,"body":"[block:api-header]\n{\n  \"title\": \"About Segment Sharing\"\n}\n[/block]\nBuzz [Segments](doc:segments) can be shared between Accounts on the same Buzz instance in the case of a [Multi-Account](doc:super-users) Buzz installation. To retrieve a list of Segments shared locally, `\"source\":\"local\"` should be included in the GET request.\n\nMore commonly, \"third-party\" Segments can be shared with a Buzz instance. This is the case with common data providers such as BlueKai, Integral Ad Science, and many others. To retrieve eligible Segments from third parties `\"source\":\"third-party\" should be included in the GET request.\n\nNote, the [Segment Sharing](doc:segment-sharing) API method also response to a GET request, but it will return the Segments the current Account has shared with others, rather than those Shared with the Account. \n[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]","excerpt":"The Segment Lookup object allows you to get segments that are shared with your Account. For example Bluekai or Integral Ad Science segments. This object only accepts GET requests.","slug":"segment_lookup","type":"endpoint","title":"segment_lookup"}

getsegment_lookup

The Segment Lookup object allows you to get segments that are shared with your Account. For example Bluekai or Integral Ad Science segments. This object only accepts GET requests.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

segment_id:
integer
Unique ID for the segment
segment_key:
string
Compound unique key including the Buzz Key and the segment_id
segment_name:
string
Name for the segment
source:
string
Either `third-party` or `local`. See description below.

Examples


Result Format


Documentation

[block:api-header] { "title": "About Segment Sharing" } [/block] Buzz [Segments](doc:segments) can be shared between Accounts on the same Buzz instance in the case of a [Multi-Account](doc:super-users) Buzz installation. To retrieve a list of Segments shared locally, `"source":"local"` should be included in the GET request. More commonly, "third-party" Segments can be shared with a Buzz instance. This is the case with common data providers such as BlueKai, Integral Ad Science, and many others. To retrieve eligible Segments from third parties `"source":"third-party" should be included in the GET request. Note, the [Segment Sharing](doc:segment-sharing) API method also response to a GET request, but it will return the Segments the current Account has shared with others, rather than those Shared with the Account. [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]

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 }}