{"_id":"56fc00fb0256470e005253b6","editedParams":true,"editedParams2":true,"githubsync":"","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"},"parentDoc":null,"__v":2,"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","updates":["57e036b14d55c02200281269"],"next":{"pages":[],"description":""},"createdAt":"2016-03-30T16:38:19.002Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"curl -X PUT \"[host]/rest/report_save\" -b cookies.txt -d '{\"report_save_id\":1, \"report_name\":\"Daily report\", \"frequency\":\"daily\",\"email_to\":\"foo:::at:::bar.com,bar@foo.com\", \"request_details\":{\"field\":[\"advertiser_id\"],\"metric\":[\"impression\",\"CPM\"],\"sort\":[{\"advertiser_id\":1}],\"rows\":100},\"report_format\":\"xls\"}'","language":"curl"}]},"method":"put","results":{"codes":[{"status":200,"name":"","code":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"id\": 1,\n            \"success\": true,\n            \"message\": \"report_save updated with ID 1\"\n        }\n    ],\n    \"message\": \"report_save update: 1 updated successfully\"\n}","language":"json"}]},"settings":"","auth":"required","params":[{"_id":"56fc00fb0256470e005253b7","ref":"","in":"body","required":true,"desc":"Unique ID for the saved report","default":"","type":"int","name":"report_save_id"},{"_id":"56fbf3200256470e0052538a","ref":"","in":"body","required":false,"desc":"Name for the report. <255 characters.","default":"","type":"string","name":"report_name"},{"_id":"56c38f9c2d97560d00e23cba","ref":"","in":"body","required":false,"desc":"ID for the report type to be used to generate the report. Each report includes a definition of available fields, metrics, and filters. A list of valid reports can be retrieved by make a request to /view with \"view_name\":\"reports\"","default":"","type":"int","name":"report_id"},{"_id":"56c38f9c2d97560d00e23cb9","ref":"","in":"body","required":false,"desc":"JSON description of fields to retrieve. If omitted, the entire definition of the report will be returned when this report is executed.","default":"","type":"array_object","name":"request_details"},{"_id":"56fbf3200256470e00525389","ref":"","in":"body","required":false,"desc":"Format to return the report. Valid values include: `none`,`json`,`csv`,`xls`,`xlsx`. If not specified or set to `none` the report results will be returned by the API in the json response and the report will be limited to 1500 rows. If any format is specified other than `none` the report row limit is 15,000, and the resulting report will be saved for retrieval in a separate GET request.","default":"","type":"string","name":"report_format"},{"_id":"56fc00b205fd6e3400ed2ddf","ref":"","in":"body","required":false,"desc":"An Advertiser for which this report applies.","default":"","type":"int","name":"advertiser_id"},{"_id":"56fc00b205fd6e3400ed2dde","ref":"","in":"body","required":false,"desc":"The User that created this report. By default the user ID of the requesting User will be used.","default":"The ID of the User","type":"int","name":"user_id"},{"_id":"56fc00b205fd6e3400ed2ddd","ref":"","in":"body","required":false,"desc":"Frequency that reports should be scheduled. Valid values include `daily`, `weekly` and `monthly`.","default":"","type":"string","name":"frequency"},{"_id":"56fc00b205fd6e3400ed2ddc","ref":"","in":"body","required":false,"desc":"Email addresses, separated by commas, up to 255 characters. If the report's frequency is set and this field is not set, the requesting user's email address will be added.","default":"","type":"string","name":"email_to"},{"_id":"56fc00b205fd6e3400ed2ddb","ref":"","in":"body","required":false,"desc":"Email addresses to cc on scheduled reports","default":"","type":"string","name":"email_cc"},{"_id":"56fc00b205fd6e3400ed2dda","ref":"","in":"body","required":false,"desc":"Whether saved report is still active. If a scheduled report is set to inactive it will no longer be sent.","default":"","type":"boolean","name":"active"}],"url":"/rest/report_save"},"isReference":true,"order":118,"body":"","excerpt":"","slug":"report_save-1","type":"endpoint","title":"report_save"}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

report_save_id:
required
integer
Unique ID for the saved report
report_name:
string
Name for the report. <255 characters.
report_id:
integer
ID for the report type to be used to generate the report. Each report includes a definition of available fields, metrics, and filters. A list of valid reports can be retrieved by make a request to /view with "view_name":"reports"
request_details:
array of objects
JSON description of fields to retrieve. If omitted, the entire definition of the report will be returned when this report is executed.
report_format:
string
Format to return the report. Valid values include: `none`,`json`,`csv`,`xls`,`xlsx`. If not specified or set to `none` the report results will be returned by the API in the json response and the report will be limited to 1500 rows. If any format is specified other than `none` the report row limit is 15,000, and the resulting report will be saved for retrieval in a separate GET request.
advertiser_id:
integer
An Advertiser for which this report applies.
user_id:
integerThe ID of the User
The User that created this report. By default the user ID of the requesting User will be used.
frequency:
string
Frequency that reports should be scheduled. Valid values include `daily`, `weekly` and `monthly`.
email_to:
string
Email addresses, separated by commas, up to 255 characters. If the report's frequency is set and this field is not set, the requesting user's email address will be added.
email_cc:
string
Email addresses to cc on scheduled reports
active:
boolean
Whether saved report is still active. If a scheduled report is set to inactive it will no longer be sent.

Examples


Result Format


User Information

Try It Out

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