API Reference
Buyer Cloud HomeGuidesAPI ReferenceChangelog

report_queue

post
https://buzz-key.api.beeswax.com/rest/report_queue
Body Params
string

Name for the report. <255 characters. Name is required if the report_format field is any value other than none

int32
required

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
object
required

JSON description of reporting request.

string
Defaults to none

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.

Response

Updated about 6 years ago

Language
Request
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated about 6 years ago