Newer Version Available

This content describes an older version of this product. View Latest

Trended Reports List Resource

Returns or adds to a collection of Trending Reports.
Resource URL
1/wave/trendedreports
Formats
JSON
Available Version
37.0
HTTP Methods
GET POST
GET Response Body
Property Name Type Description Filter Group and Version Available Version
trended​Reports Trended​Report​Representation[] A collection of trended reports. Small, 37.0 37.0
url String URL to get the collection. Small, 37.0 37.0
POST Request Body
Property Name Type Description Required or Optional Available Version
apex​Hooks​Class Asset​Reference​Input​Representation Reference to the apex class to execute after successful trending. 38.0
dashboard​Label String Label for the Analytics Dashboard that will be created. 37.0
dataset​Label String Reference to the report being trended. 37.0
report Asset​Reference​Input​Representation Reference to the report being trended. 37.0
schedule Daily​Schedule​Input​Representation, Weekly​Schedule​Input​Representation, Monthly​Relative​Schedule​Input​Representation, Monthly​Specific​Schedule​Input​Representation Schedule on which the trending should be run. 39.0
POST Response Body
Property Name Type Description Filter Group and Version Available Version
apex​Hooks​Class Asset​Reference​Representation Reference to the apex class which is used for post processing each time the report is trended. Small, 37.0 38.0
dashboard Asset​Reference​Representation Reference to the Dashboard for the trended report. Small, 37.0 37.0
dataset Asset​Reference​Representation Reference to the Dataset with the trended report data. Small, 37.0 37.0
id String The 18 character ID of the trended report. Small, 37.0 37.0
report Asset​Reference​Representation Reference to the Report that is being trended. Small, 37.0 37.0
Schedule Daily​Schedule​Representation, Weekly​Schedule​Representation, Monthly​Relative​Schedule​Representation, Monthly​Specific​Schedule​Representation Schedule of when this report is trended. Small, 39.0 39.0
url String The URL for the trended report. Small, 37.0 37.0
POST Request Parameters
Parameter Name Type Description Required or Optional Available Version
trended​Report Object (Trended​Report​Input​Representation) The trended report to add. Required 37.0
DailyScheduleInputRepresentation
Property Name Type Description Required or Optional Available Version
frequency Connect​Wave​Schedule​Frequency​Type​Enum How often the schedule should be run (Daily, Monthly, MonthlyRelative, or Weekly). 39.0
time Time​Input​Representation When the schedule should be run. 39.0
WeeklyScheduleInputRepresentation
Property Name Type Description Required or Optional Available Version
frequency Connect​Wave​Schedule​Frequency​Type​Enum How often the schedule should be run (Daily, Monthly, MonthlyRelative, or Weekly). 39.0
time Time​Input​Representation When the schedule should be run. 39.0
daysOfWeek Connect​Wave​Day​Of​Week​Enum[] Days of the week on which the schedule will run (Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday). 39.0
MonthlyRelativeScheduleInputRepresentation
Property Name Type Description Required or Optional Available Version
frequency Connect​Wave​Schedule​Frequency​Type​Enum How often the schedule should be run (Daily, Monthly, MonthlyRelative, or Weekly). 39.0
time Time​Input​Representation When the schedule should be run. 39.0
dayInWeek Connect​Wave​Day​Of​Week​Enum Day of the week when the schedule should be run (Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday). 39.0
weekInMonth Connect​Wave​Relative​Week​Enum Relative week in the month when the schedule should be run (First, Second, Third, Fourth, Last). 39.0
MonthlySpecificScheduleInputRepresentation
Property Name Type Description Required or Optional Available Version
frequency Connect​Wave​Schedule​Frequency​Type​Enum How often the schedule should be run (Daily, Monthly, MonthlyRelative, or Weekly). 39.0
time Time​Input​Representation When the schedule should be run. 39.0
daysOfMonth Integer[] Days of the month on which the schedule will run (1-31). Note that months lacking specific days will skip the job. 39.0
TimeInputRepresentation
Property Name Type Description Required or Optional Available Version
hour Integer Hour on which the schedule should be run (in the user's time zone). 39.0
DailyScheduleRepresentation
Property Name Type Description Filter Group and Version Available Version
frequency Connect​Wave​Schedule​Frequency​Type​Enum Frequency on which this schedule is run (Daily, Monthly, MonthlyRelative, or Weekly). Small, 39.0 39.0
time Time​Representation Hour and timezone in which this schedule is run. Small, 39.0 39.0
WeeklyScheduleRepresentation
Property Name Type Description Filter Group and Version Available Version
frequency Connect​Wave​Schedule​Frequency​Type​Enum Frequency on which this schedule is run (Daily, Monthly, MonthlyRelative, or Weekly). Small, 39.0 39.0
time Time​Representation Hour and timezone in which this schedule is run. Small, 39.0 39.0
daysOfWeek Connect​Wave​Day​Of​Week​Enum[] Days of the week on which the schedule will run (Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday). Small, 39.0 39.0
MonthlyRelativeScheduleRepresentation
Property Name Type Description Filter Group and Version Available Version
frequency Connect​Wave​Schedule​Frequency​Type​Enum Frequency on which this schedule is run (Daily, Monthly, MonthlyRelative, or Weekly). Small, 39.0 39.0
time Time​Representation Hour and timezone in which this schedule is run. Small, 39.0 39.0
dayInWeek Connect​Wave​Day​Of​Week​Enum Day within a week (Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday). Small, 39.0 39.0
weekInMonth Connect​Wave​Relative​Week​Enum Week within a month (First, Second, Third, Fourth, Last). Small, 39.0 39.0
MonthlySpecificScheduleRepresentation
Property Name Type Description Filter Group and Version Available Version
frequency Connect​Wave​Schedule​Frequency​Type​Enum Frequency on which this schedule is run (Daily, Monthly, MonthlyRelative, or Weekly). Small, 39.0 39.0
time Time​Representation Hour and timezone in which this schedule is run. Small, 39.0 39.0
daysOfMonth Integer[] Days of the month on which the schedule will run (-1, 1-31). Note that months lacking specific days will skip the job. Can specify a single value of -1 to indicate the last day of the month (-1 cannot be used with additional days). Small, 39.0 39.0
TimeRepresentation
>
Property Name Type Description Filter Group and Version Available Version
hour Integer Hour at which this schedule is run (0-23). Small, 39.0 39.0
timeZone Time​Zone​Representation Time zone of the hour at which the schedule is run. Small, 39.0 39.0
TimeZoneRepresentation
Property Name Type Description Filter Group and Version Available Version
gmt​Offset Double The signed offset, in hours, from GMT. Small, 39.0 39.0
name String The display name of this time zone. Small, 39.0 39.0