text
stringlengths
0
10.3k
To get a report on how long each asset dwelled (inside any geofence) during the report period,
create a request specifying the following:
* `reportId`: ID of a report created for a dwelling rule
* `groupBy`: 'asset'
* `measure`: 'duration' [/INST] ['asset', 'geofence']</s>
<s>[INST] Find example values for the parameter below in a list format
name: method
description: Defines the calculation method.
The parameter `method` can only be provided along with `interval`.
The parameter value can be `percentage` only when `measure` is 'asset'.
For example, to get a report on percentage of all assets that were in use during each week,
create a request specifying the following:
* `reportId`: ID of a report created for a utilization rule
* `interval`: 'week'
* `method`: 'percentage'
* `measure`: 'asset'
When `method` is set to 'cumulative' or 'average' and `measure` is set to 'duration' or 'occurrence',
the `groupBy` parameter needs to be provided also.
For example, to get a report on how long all assets dwelled in total in the specified geofence during
each week, create a request specifying the following:
* `reportId`: ID of a report created for a dwelling rule
* `geofenceId`: ID of a geofence
* `interval`: 'week'
* `method`: 'cumulative'
* `measure`: 'duration'
* `groupBy`: 'asset'
When `method` is set to 'cumulative' or 'average' and `measure` is set to 'day',
the `groupBy` parameter is automatically set to 'asset'.
For example, to get a report on how many days on average assets were in use during each month,
create a request specifying the following:
* `reportId`: ID of a report created for a utilization rule
* `interval`: 'month'
* `method`: 'average'
* `measure`: 'day'
* `groupBy`: 'asset' [/INST] ['average', 'cumulative', 'percentage']</s>
<s>[INST] Find example values for the parameter below in a list format
name: status
description: Filter the results by shipment status [/INST] ['pending', 'ongoing', 'completed', 'cancelled']</s>
<s>[INST] Find example values for the parameter below in a list format
name: status
description: Filter the results by segment status [/INST] ['pending', 'ongoing', 'completed', 'cancelled']</s>
<s>[INST] Find example values for the parameter below in a list format
name: mode
description: Tracker mode. [/INST] ['unknown', 'normal', 'flight', 'transport', 'sleep']</s>
<s>[INST] Find example values for the parameter below in a list format
name: type
description: type of records to return [/INST] ['all', 'clicks', 'contacts']</s>
<s>[INST] Find example values for the parameter below in a list format
name: kind
description: Token type [/INST] ["'registration'", "'selfie'", "'plain'"]</s>
<s>[INST] Find example values for the parameter below in a list format
name: type
description: Optional facility type search filter [/INST] ['health', 'cemetery', 'benefits', 'vet_center']</s>
<s>[INST] Find example values for the parameter below in a list format
name: drive_time
description: Filter to only include facilities that are within the specified number of drive time minutes from the requested location. [/INST] [10, 20, 30, 40, 50, 60, 70, 80, 90]</s>
<s>[INST] Find example values for the parameter below in a list format
name: ride_type
description: ID of a ride type [/INST] ['lyft', 'lyft_line', 'lyft_plus', 'lyft_premier', 'lyft_lux', 'lyft_luxsuv']</s>
<s>[INST] Find example values for the parameter below in a list format
name: size
description: screenshots size - "screen" (default) or "page" [/INST] ['screen', 'page']</s>
<s>[INST] Find example values for the parameter below in a list format
name: format
description: image as PNG or JPEG [/INST] ['png', 'jpeg']</s>
<s>[INST] Find example values for the parameter below in a list format
name: size
description: screenshot size - "screen" (default) or "page" [/INST] ['screen', 'page']</s>
<s>[INST] Find example values for the parameter below in a list format
name: hosting
description: hosting option - s3 or browshot [/INST] ['s3', 'browshot']</s>
<s>[INST] Find example values for the parameter below in a list format
name: hosting
description: hosting option: s3 or browshot [/INST] ['s3', 'browshot']</s>
<s>[INST] Find example values for the parameter below in a list format
name: status
description: get list of screenshot in a given status (error, finished, in_process) [/INST] ['error', 'finished', 'in_process']</s>
<s>[INST] Find example values for the parameter below in a list format
name: ratio
description: Use fit to keep the original page ration, and fill to get a thumbnail for the exact width and height. specified. If you provide both width and height, you need to specify the ratio: fit to keep the original width/height ratio (the thumbnail might be smaller than the specified width and height), or fill to crop the image if necessary. [/INST] ['fit', 'fill']</s>
<s>[INST] Find example values for the parameter below in a list format
name: status
description: Filter by scan statuses [/INST] ['queued', 'started', 'under_review', 'completed', 'completed_with_errors', 'failed', 'canceled', 'canceling']</s>
<s>[INST] Find example values for the parameter below in a list format
name: severity
description: Filter by finding severity [/INST] [10, 20, 30]</s>
<s>[INST] Find example values for the parameter below in a list format
name: state
description: Filter by finding states [/INST] ['notfixed', 'invalid', 'accepted', 'fixed']</s>
<s>[INST] Find example values for the parameter below in a list format
name: direction
description: The sorting order (case insensitive). [/INST] ['asc', 'desc']</s>
<s>[INST] Find example values for the parameter below in a list format
name: rollPeriod
description: The period for which you wish to retrieve energy usage data. [/INST] ['ONE_DAY', 'ONE_WEEK', 'ONE_MONTH', 'SIX_MONTHS', 'ONE_YEAR']</s>
<s>[INST] Find example values for the parameter below in a list format