report_save

report_save_id

int32

required

Unique ID for the saved report

report_name

string

Name for the report. <255 characters.

report_id

int32

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

JSON description of fields to retrieve. If omitted, the entire definition of the report will be returned when this report is executed.

request_details

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.

user_id

int32

Defaults to null

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.

200200