{"_id":"56fbe7db587e43170081eb21","__v":0,"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"},"githubsync":"","editedParams2":true,"project":"56c35c56c0c4630d004e864c","user":"56c39c05bc41330d009f25d7","parentDoc":null,"editedParams":true,"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-03-30T14:51:07.752Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"curl -X POST \"[host]/rest/event\" -b cookies.txt -d '{\"advertiser_id\":1, \"event_name\":\"new event\", \"value\":100, \"segment_id\":1, \"event_type_id\":1}'","language":"curl"}]},"method":"post","results":{"codes":[{"language":"json","status":200,"name":"","code":"{\n    \"success\": true,\n    \"message\": \"event created with ID = 1\",\n    \"payload\": {\n        \"id\": 1\n    }\n}"}]},"settings":"","auth":"required","params":[{"_id":"56c38f9c2d97560d00e23cba","ref":"","in":"body","required":true,"desc":"Name of the event, <100 characters","default":"","type":"string","name":"event_name"},{"_id":"56c39b11e1e4190d003429b6","ref":"","in":"body","required":true,"desc":"Must be a valid and active Advertiser","default":"","type":"int","name":"advertiser_id"},{"_id":"56fbe7db587e43170081eb27","ref":"","in":"body","required":false,"desc":"Type of event, used for organizational purposes. Lookup against event_type table. Example `0`=Purchase, `1`=Landing Page, etc.","default":"","type":"int","name":"event_type_id"},{"_id":"56fbe7db587e43170081eb26","ref":"","in":"body","required":false,"desc":"If set, the user will be placed into this Segment when the Event is called. Segment must be valid and active and must belong to the same Account as the Event.","default":"","type":"int","name":"segment_id"},{"_id":"56fbe7db587e43170081eb25","ref":"","in":"body","required":true,"desc":"Default value of the conversion","default":"","type":"double","name":"value"},{"_id":"56fbe7db587e43170081eb24","ref":"","in":"body","required":false,"desc":"Should this Event be counted every time (`0`) or only once per user (`1`)","default":"","type":"boolean","name":"count_unique"},{"_id":"56fbe7db587e43170081eb23","ref":"","in":"body","required":false,"desc":"Amount, in seconds, to look back for clicks after an Event takes place. Positive number, no more than the system limit, which is generally set at `2592000` (30 days).","default":"2592000","type":"int","name":"click_window"},{"_id":"56fbe7db587e43170081eb22","ref":"","in":"body","required":false,"desc":"Amount, in seconds, to look back for impressions after an Event takes place. Positive number, no more than the system limit, which is generally set at `2592000` (30 days).","default":"2592000","type":"int","name":"view_window"}],"url":"/rest/event"},"isReference":true,"order":84,"body":"","excerpt":"","slug":"event","type":"endpoint","title":"event"}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

event_name:
required
string
Name of the event, <100 characters
advertiser_id:
required
integer
Must be a valid and active Advertiser
event_type_id:
integer
Type of event, used for organizational purposes. Lookup against event_type table. Example `0`=Purchase, `1`=Landing Page, etc.
segment_id:
integer
If set, the user will be placed into this Segment when the Event is called. Segment must be valid and active and must belong to the same Account as the Event.
value:
required
double
Default value of the conversion
count_unique:
boolean
Should this Event be counted every time (`0`) or only once per user (`1`)
click_window:
integer2592000
Amount, in seconds, to look back for clicks after an Event takes place. Positive number, no more than the system limit, which is generally set at `2592000` (30 days).
view_window:
integer2592000
Amount, in seconds, to look back for impressions after an Event takes place. Positive number, no more than the system limit, which is generally set at `2592000` (30 days).

Examples


Result Format


User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}