SearchInputReport
public struct SearchInputReport : JSONEncodedBody, SearchInputCriteria
This is derived from the original VTeamMultiRidePeriod impl - it is used on aggregate reporting focused endpoints
-
Undocumented
Declaration
Swift
public var type: ActivityType?
-
Undocumented
Declaration
Swift
public var isAllTime: Bool?
-
Undocumented
Declaration
Swift
public var userIDs: [Int64]?
-
Undocumented
Declaration
Swift
public var ranges: [DateRange]?
-
Limit the search to UserBike.uuid
Declaration
Swift
public var bikeUids: [String]?
-
Undocumented
Declaration
Swift
public var activities: [Activity]?
-
Only include results related to these activities
Declaration
Swift
public var limit: [Activity]?
-
Undocumented
Declaration
Swift
public var groupBy: String?
-
Flag that indicates if the search is inclusive (true) or exclusive (false).
Declaration
Swift
public var isInclusive: Bool?
-
Undocumented
Declaration
Swift
public var range: DateRange?
-
Option to include zones - defaults to true and used in power curve
Declaration
Swift
public var shouldIncludeZones: Bool?
-
Undocumented
Declaration
Swift
public var references: [RelativePeriod]?
-
Simple field list
Declaration
Swift
public var simpleFields: [String]?
-
Undocumented
Declaration
Swift
public var isNotNull: [String]?
-
Undocumented
Declaration
Swift
public var isNull: [String]?
-
Undocumented
Declaration
Swift
public var order: [Order]?
-
Undocumented
Declaration
Swift
public init()
-
Return a
SearchInputReport
which can be used for reporting endpoints, i.e. time in zone for a given activity.Declaration
Swift
public static func forInstance(activityType: ActivityResultType, identifier: Int) -> SearchInputReport
Parameters
activityType
The type of the activity we want a report on.
identifier
The id of the activity we want a report on.
-
Return a
SearchInputReport
which can be used for peak curve reporting endpoints.Declaration
Swift
public static func forInstancePeaksCurve(activityType: ActivityResultType, identifier: Int, referencePeriod: RelativePeriod?) -> SearchInputReport
Parameters
activityType
The type of the activity we want a report on.
identifier
The id of the activity we want a report on.
referencePeriod
The comparison period to be included.
-
Undocumented
Declaration
Swift
public static func forInstanceMetrics(sport: ActivityType, userIDs: [Int64], ranges: [DateRange], fields: [String]) -> SearchInput<SearchInputReport>
-
Build a metrics API query grouped by bike uuids - ie get summary stats by bike ranges can be empty and will defult to all time fields should not be empty. Must be at least one field bikeUids should not be empty.
Declaration
Swift
public static func forInstanceMetricsBikes(ranges: [DateRange], fields: [String], bikeUids: [String]) -> SearchInput<SearchInputReport>