The base URL used to connect to the API on the server
yellowfin.serverInfo.releaseVersion
The release version of Yellowfin running on the server (eg. "6.1")
yellowfin.serverInfo.buildVersion
The build version of Yellowfin running on the server (eg. "20120601")
yellowfin.serverInfo.javaVersion
The java version installed on the server
yellowfin.serverInfo.operatingSystem
The Operating System running on the server
yellowfin.serverInfo.operatingSystemArch
The Operating System architecture on the server
yellowfin.serverInfo.operatingSystemVersion
The Operating System version on the server
yellowfin.serverInfo.schemaVersion
The schema version of the Yellowfin configuration database
...
Expand
title
Expand here...
Option
Description
reportUUID
Either reportUUID, reportId or wsName must be present. The unique ID identifying the dashboard to load.
reportId
Either reportUUID, reportId or wsName must be present. The numeric reportId identifying the report to load. It is recommended to use the reportUUID parameter instead.
wsName
Either reportUUID, reportId or wsName must be present. The Web Service name identifying the report to load. It is recommended to use the reportUUID parameter instead.
elementId
Either elementId or element must be present. The id of the html element in which to load the report.
element
Either elementId or element must be present. The html element in which to load the report.
showTitle
Default: true Set to false to omit the title bar at the top of the report. All interactive buttons included in the title bar will also be omitted.
showInfo
Default: true Set to false to omit the Info button in the title bar.
showFilters
Default: true Set to false to omit the Filters button in the title bar. Any user-prompt filters will not be displayed.
showSections
Default: true Set to false to omit the Sections button in the title bar (for reports with tabbed or multi-page sections).
showSeries
Default: true Set to false to omit the Series button in the title bar (for reports with the series selection option).
showPageLinks
Default: true Set to false to omit the previous page/next page button in the title bar (for reports with multiple pages).
showExport
Default: true Set to false to omit the Export button in the title bar.
height
Default: automatically detected from the dimensions of the enclosing elementSet element Set this to a numeric value to override the report height.
width
Default: automatically detected from the dimensions of the enclosing elementSet element Set this to a numeric value to override the report width.
display
Default: chart Set to table to display the report initially as a table. Set to chart to display the report initially as a chart. This is ignored for reports that do not have both table and chart available.
fitTableWidth
Default: true Set to true to attempt to scale the report to the width of the enclosing element.
canChangeDisplay
Default: true Set to false to omit the buttons that allow the user to switch between chart and table display.
filters
Set to an object containing filter values to pass to the report.
username
Set this along with the password parameter to authenticate as a particular user when loading the report. This avoids the need for users to enter their login details before viewing restricted reports.
password
Set this along with the username parameter to authenticate as a particular user when loading the report.
...
Expand
title
Expand here...
Property
Description
filterUUID
A unique identifier for the filter.
filterId
A numeric identifier for the filter.
nativeType
The native data type of the filter.
description
The description of the filter.
operator
The operator used with the filter.
display
The display style used by the filter.
dependencies
Set to true if other filters in the report are dependent on this one.
list
Set to true if the filter is a list style (allows multiple values).
between
Set to true if the filter is a between style (requires a start and end value).
listValues
If the filter is displayed as a drop-down list, this property contains a list of available options.
...
Expand
title
Expand here...
Option
Description
dashUUID
Must be present. The unique identifier for the dashboard to load.
elementId
Either elementId or element must be present. The id of the html element in which to load the dashboard.
element
Either elementId or element must be present. The html element in which to load the dashboard.
showTitle
Default: true Set to false to omit the title bar at the top of the dashboard. All interactive buttons included in the title bar will also be omitted.
showInfo
Default: true Set to false to omit the Info button in the title bar.
showFilters
Default: true Set to false to omit the Filters button in the title bar. Any analytical filters will not be displayed.
showExport
Default: true Set to false to omit the Export button in the title bar.
height
Default: automatically set from the dimensions of the reports in the dashboard. Set this to a numeric value to override the dashboard height. If the reports in the dashboard require more space, a vertical scrollbar will be added.
width
Default: automatically set from the logged-in user's preferences or the system configuration settingSet setting Set this to a numeric value to override the dashboard width. Set this to auto to use the full width of the enclosing element.
filters
Set to an object containing filter values to pass to the dashboard.
username
Set this along with the password parameter to authenticate as a particular user when loading the dashboard. This avoids the need for users to enter their login details before viewing restricted dashboards.
password
Set this along with the username parameter to authenticate as a particular user when loading the dashboard.
...
Expand
title
Expand here...
Properties
Description
key
A unique key for this filter or filter group.
type
Set to FILTERGROUP if this object represents a filter group. Other values indicate a type of analytic filter.
description
The description of the filter or filter group.
groupId
For filter groups: a numeric identifier for the group.
state
For filter groups: set to OPEN if the group is currently opened.
display
For filters: the display style used by the filter.
dependencies
For filters: set to true if other filters in the dashboard are dependent on this one.
list
For filters: set to true if the filter is a list style (allows multiple values).
between
For filters: set to true if the filter is a between style (requires a start and end value).
listValues
For filters: if the filter is displayed as a drop-down list, this property contains a list of available options.