Create a Report

Create a report based on both a specific report ID and specific objects.

See Parameters below.

Parameters

See both the Body Parameters table and Reports Object List below.

Body Parameters	Required/Optional	Description	Type
`report_type`	required	The type of report you want to create.	string
`report`	required	List of required, specific objects you want to be included within your report. See Report Objects List below.	object
`object_selector`	required	The categories to group reports by.	string
`reportable_value`	required	The value in which to report.	string

Reports Object List

name: The name of the report.
output: The output of the report (pdf, csv, excel, screen).
size: The size of the page (letter or A4).
orientation: The orientation (landscape or portrait) of the page.
has_gridlines: Allows grid lines (or not) to display on the report.
font_size: The size of the font on the report.
entity_id: The ID of the group you want to pull information from.
entity_action_id: The ID of action for which you want to generate the report. This field is only for Action Report.
entity_action_show_all_object: Choose whether to export all the records or just the records where selected action was performed. This field in only for Action Report. Options are true(All objects) and nil(Only objects that have this action).
action_object_list: Choose whether to export all actions or first or last action. This field is only for Action Reports. Options are 1(All), 2(First) and 3(Last).
sum_currency: Included in reports that use currency fields. This selection provides total sums in the report when selected and is set to true by default (when pdf output is selected).
sum_number: Included in reports that use numeric fields. This selection provides numeric totals in the report when selected and is set to false by default (when pdf output is selected).
company_logo: Select to display a company logo on the report (or not).
reportable_id: Dependent on the report type (group, action, etc).
default_image: Allows a default image to display on the report (or not).
archived_record_options: Choose if you want to include/exclude archived records in the report. Options are 0(Include archived assets), 1(Exclude archived assets), 2(Show only archived assets).
report_filters_attributes: Add filters in the report.
form_ordering_fields_attributes: Add ordering in the report.
fields: The list of available fields that can be selected to include within the report.
depreciable_object: Allows the object to depreciate in value (or not).
begin_date: The date on which to begin gathering data for the report.
end_date: The date on which to conclude gathering data for the report.
appreciable_object: Allows the object to appreciate in value (or not).
appreciation_start_date: Selects the start date for the object to begin its appreciation of value.
appreciation_end_date: Selects the end date for the object to end its appreciation of value.
group_page_break: Allows for page breaks (between groups) within the report.

200Successful response