> For the complete documentation index, see [llms.txt](https://docs.globalalerting.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.globalalerting.com/web-api/reports.md).

# Reports

## GET /V2/{tenantVarCode}/reports

> Returns list of enabled reports for specified tenant

```json
{"openapi":"3.0.4","info":{"title":"GAP REST API Documentation V2","version":"v2"},"tags":[{"name":"Reports"}],"paths":{"/V2/{tenantVarCode}/reports":{"get":{"tags":["Reports"],"summary":"Returns list of enabled reports for specified tenant","parameters":[{"name":"tenantVarCode","in":"path","description":"Tenant Var Code","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}},"application/json;IEEE754Compatible=false":{"schema":{"type":"array","items":{"type":"string"}}},"application/json;IEEE754Compatible=true":{"schema":{"type":"array","items":{"type":"string"}}},"application/xml":{"schema":{"type":"array","items":{"type":"string"}}},"text/plain":{"schema":{"type":"array","items":{"type":"string"}}},"application/octet-stream":{"schema":{"type":"array","items":{"type":"string"}}},"text/json":{"schema":{"type":"array","items":{"type":"string"}}},"text/xml":{"schema":{"type":"array","items":{"type":"string"}}},"text/csv":{"schema":{"type":"array","items":{"type":"string"}}}}}}}}}}
```

## GET /V2/{tenantVarCode}/reports/AlertsReport

> Returns alerts report data

```json
{"openapi":"3.0.4","info":{"title":"GAP REST API Documentation V2","version":"v2"},"tags":[{"name":"Reports"}],"paths":{"/V2/{tenantVarCode}/reports/AlertsReport":{"get":{"tags":["Reports"],"summary":"Returns alerts report data","parameters":[{"name":"tenantVarCode","in":"path","description":"Tenant Var Code","required":true,"schema":{"type":"string"}},{"name":"Subtenants","in":"query","description":"When 'subtenants=true' result contains report data for the tenant and all subtenants","schema":{"type":"boolean"}},{"name":"GroupIds","in":"query","description":"Group Ids","schema":{"type":"array","items":{"type":"string"}}},{"name":"DeviceTypes","in":"query","description":"Device Types","schema":{"type":"array","items":{"type":"string"}}},{"name":"DeviceStatus","in":"query","description":"Device Status, optional. Accepted values: \"Active\", \"Inactive\".","schema":{"type":"string"}},{"name":"VehicleTypeTags","in":"query","description":"\"VehicleType\" tag values","schema":{"type":"array","items":{"type":"string"}}},{"name":"DeviceIds","in":"query","description":"Device Ids","schema":{"type":"array","items":{"type":"string"}}},{"name":"UserIds","in":"query","description":"User Ids","schema":{"type":"array","items":{"type":"string"}}},{"name":"CollectionId","in":"query","description":"Cross tenant collection id. Report data is based on the collection (groups and devices related query parameters are ignored).","schema":{"type":"string"}},{"name":"IntervalType","in":"query","description":"Pre-defined custom interval, can be used instead of DateFrom and DateTo. Accepted value: this-week, this-month, this-quarter, this-year, this-financial-year, yesterday, last-week, last-week-sunday, last-7-days, last-10-days, last-30-days, last-4-weeks, last-12-weeks, last-3-months, last-6-months, last-12-months, last-month, last-quarter, last-year, last-financial-year","schema":{"type":"string"}},{"name":"DateFrom","in":"query","description":"Report interval start date. Required when no IntervalType specified.","schema":{"type":"string","format":"date-time"}},{"name":"DateTo","in":"query","description":"Report interval end date. Required when no IntervalType specified.","schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AlertsReportEntry"}}},"application/json;IEEE754Compatible=false":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AlertsReportEntry"}}},"application/json;IEEE754Compatible=true":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AlertsReportEntry"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AlertsReportEntry"}}},"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AlertsReportEntry"}}},"application/octet-stream":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AlertsReportEntry"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AlertsReportEntry"}}},"text/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AlertsReportEntry"}}},"text/csv":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AlertsReportEntry"}}}}}}}}},"components":{"schemas":{"AlertsReportEntry":{"type":"object","properties":{"DeviceId":{"type":"string","description":"Device Id","nullable":true},"DeviceFriendlyName":{"type":"string","description":"Device friendly name","nullable":true},"AlertType":{"type":"string","description":"Alert Type","nullable":true},"StartTimeLocal":{"type":"string","description":"A local date and time of an alert","format":"date-time"},"Latitude":{"type":"number","description":"Latitude","format":"double","nullable":true},"Longitude":{"type":"number","description":"Longitude","format":"double","nullable":true},"Address":{"type":"string","description":"Address","nullable":true},"LocationName":{"type":"string","description":"List of geofence names where an alert occured","nullable":true}},"additionalProperties":false}}}}
```

## GET /V2/{tenantVarCode}/reports/AssetUtilisationReport

> Returns asset utilisation report data

```json
{"openapi":"3.0.4","info":{"title":"GAP REST API Documentation V2","version":"v2"},"tags":[{"name":"Reports"}],"paths":{"/V2/{tenantVarCode}/reports/AssetUtilisationReport":{"get":{"tags":["Reports"],"summary":"Returns asset utilisation report data","parameters":[{"name":"tenantVarCode","in":"path","description":"Tenant Var Code","required":true,"schema":{"type":"string"}},{"name":"Subtenants","in":"query","description":"When 'subtenants=true' result contains report data for the tenant and all subtenants","schema":{"type":"boolean"}},{"name":"GroupIds","in":"query","description":"Group Ids","schema":{"type":"array","items":{"type":"string"}}},{"name":"DeviceTypes","in":"query","description":"Device Types","schema":{"type":"array","items":{"type":"string"}}},{"name":"DeviceStatus","in":"query","description":"Device Status, optional. Accepted values: \"Active\", \"Inactive\".","schema":{"type":"string"}},{"name":"VehicleTypeTags","in":"query","description":"\"VehicleType\" tag values","schema":{"type":"array","items":{"type":"string"}}},{"name":"DeviceIds","in":"query","description":"Device Ids","schema":{"type":"array","items":{"type":"string"}}},{"name":"UserIds","in":"query","description":"User Ids","schema":{"type":"array","items":{"type":"string"}}},{"name":"CollectionId","in":"query","description":"Cross tenant collection id. Report data is based on the collection (groups and devices related query parameters are ignored).","schema":{"type":"string"}},{"name":"IntervalType","in":"query","description":"Pre-defined custom interval, can be used instead of DateFrom and DateTo. Accepted value: this-week, this-month, this-quarter, this-year, this-financial-year, yesterday, last-week, last-week-sunday, last-7-days, last-10-days, last-30-days, last-4-weeks, last-12-weeks, last-3-months, last-6-months, last-12-months, last-month, last-quarter, last-year, last-financial-year","schema":{"type":"string"}},{"name":"DateFrom","in":"query","description":"Report interval start date. Required when no IntervalType specified.","schema":{"type":"string","format":"date-time"}},{"name":"DateTo","in":"query","description":"Report interval end date. Required when no IntervalType specified.","schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AssetUtilisationReportEntry"}}},"application/json;IEEE754Compatible=false":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AssetUtilisationReportEntry"}}},"application/json;IEEE754Compatible=true":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AssetUtilisationReportEntry"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AssetUtilisationReportEntry"}}},"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AssetUtilisationReportEntry"}}},"application/octet-stream":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AssetUtilisationReportEntry"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AssetUtilisationReportEntry"}}},"text/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AssetUtilisationReportEntry"}}},"text/csv":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AssetUtilisationReportEntry"}}}}}}}}},"components":{"schemas":{"AssetUtilisationReportEntry":{"type":"object","properties":{"DeviceId":{"type":"string","description":"Device Id","nullable":true},"DeviceFriendlyName":{"type":"string","description":"Device friendly name","nullable":true},"Trips":{"type":"integer","description":"Number of trips for report period","format":"int32"},"DistanceKm":{"type":"number","description":"Total distance in Km","format":"double"},"DurationSec":{"type":"integer","description":"Total trips duration in seconds","format":"int32"},"DurationString":{"type":"string","description":"Total trips duration text (HH:ss)","nullable":true},"OdometerKm":{"type":"number","description":"Last odometer value in Km","format":"double","nullable":true}},"additionalProperties":false}}}}
```

## GET /V2/{tenantVarCode}/reports/DevicesOverviewReport

> Returns devices overview report data

```json
{"openapi":"3.0.4","info":{"title":"GAP REST API Documentation V2","version":"v2"},"tags":[{"name":"Reports"}],"paths":{"/V2/{tenantVarCode}/reports/DevicesOverviewReport":{"get":{"tags":["Reports"],"summary":"Returns devices overview report data","parameters":[{"name":"tenantVarCode","in":"path","description":"Tenant Var Code","required":true,"schema":{"type":"string"}},{"name":"LastTimeHoursFilter","in":"query","description":"Filter report data by device's last message time:\r\n0 = no filter\r\nvalue greater than zero = time is greater than last X hours (ie: '24' - device reported in the last 24 hours)\r\nnegative value = time is less tan X hours (ie: '-48' - device not reported in the last 48 hours)","schema":{"type":"integer","format":"int32"}},{"name":"Subtenants","in":"query","description":"When 'subtenants=true' result contains report data for the tenant and all subtenants","schema":{"type":"boolean"}},{"name":"GroupIds","in":"query","description":"Group Ids","schema":{"type":"array","items":{"type":"string"}}},{"name":"DeviceTypes","in":"query","description":"Device Types","schema":{"type":"array","items":{"type":"string"}}},{"name":"DeviceStatus","in":"query","description":"Device Status, optional. Accepted values: \"Active\", \"Inactive\".","schema":{"type":"string"}},{"name":"VehicleTypeTags","in":"query","description":"\"VehicleType\" tag values","schema":{"type":"array","items":{"type":"string"}}},{"name":"DeviceIds","in":"query","description":"Device Ids","schema":{"type":"array","items":{"type":"string"}}},{"name":"UserIds","in":"query","description":"User Ids","schema":{"type":"array","items":{"type":"string"}}},{"name":"CollectionId","in":"query","description":"Cross tenant collection id. Report data is based on the collection (groups and devices related query parameters are ignored).","schema":{"type":"string"}},{"name":"IntervalType","in":"query","description":"Pre-defined custom interval, can be used instead of DateFrom and DateTo. Accepted value: this-week, this-month, this-quarter, this-year, this-financial-year, yesterday, last-week, last-week-sunday, last-7-days, last-10-days, last-30-days, last-4-weeks, last-12-weeks, last-3-months, last-6-months, last-12-months, last-month, last-quarter, last-year, last-financial-year","schema":{"type":"string"}},{"name":"DateFrom","in":"query","description":"Report interval start date. Required when no IntervalType specified.","schema":{"type":"string","format":"date-time"}},{"name":"DateTo","in":"query","description":"Report interval end date. Required when no IntervalType specified.","schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DevicesOverviewReportEntry"}}},"application/json;IEEE754Compatible=false":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DevicesOverviewReportEntry"}}},"application/json;IEEE754Compatible=true":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DevicesOverviewReportEntry"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DevicesOverviewReportEntry"}}},"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DevicesOverviewReportEntry"}}},"application/octet-stream":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DevicesOverviewReportEntry"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DevicesOverviewReportEntry"}}},"text/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DevicesOverviewReportEntry"}}},"text/csv":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DevicesOverviewReportEntry"}}}}}}}}},"components":{"schemas":{"DevicesOverviewReportEntry":{"type":"object","properties":{"DeviceId":{"type":"string","description":"Device Id","nullable":true},"DeviceFriendlyName":{"type":"string","description":"Device friendly name","nullable":true},"DeviceType":{"type":"string","description":"Device type","nullable":true},"LastMoMessageTime":{"type":"string","description":"Last MO message date and time (UTC)","format":"date-time","nullable":true},"LastMoMessageAgo":{"type":"string","description":"Text how long ago was last message sent","nullable":true},"LastLatitude":{"type":"number","description":"Last known latitude","format":"double","nullable":true},"LastLongitude":{"type":"number","description":"Last known longitude","format":"double","nullable":true},"Address":{"type":"string","description":"Address","nullable":true},"BatteryPercentage":{"type":"string","description":"Battery (%)","nullable":true}},"additionalProperties":false}}}}
```

## GET /V2/{tenantVarCode}/reports/DriverPerformanceSummaryReport

> Returns driver behaviour report data

```json
{"openapi":"3.0.4","info":{"title":"GAP REST API Documentation V2","version":"v2"},"tags":[{"name":"Reports"}],"paths":{"/V2/{tenantVarCode}/reports/DriverPerformanceSummaryReport":{"get":{"tags":["Reports"],"summary":"Returns driver behaviour report data","parameters":[{"name":"tenantVarCode","in":"path","description":"","required":true,"schema":{"type":"string"}},{"name":"GroupBy","in":"query","description":"Defines if reports is grouped by 'Vehicle' or 'Driver' (default: 'Driver')","schema":{"type":"string"}},{"name":"DrivingViolationTypes","in":"query","description":"Report result can be filtered by violation type: Acceleration, Braking, Turning, Speeding","schema":{"type":"array","items":{"type":"string"}}},{"name":"Subtenants","in":"query","description":"When 'subtenants=true' result contains report data for the tenant and all subtenants","schema":{"type":"boolean"}},{"name":"GroupIds","in":"query","description":"Group Ids","schema":{"type":"array","items":{"type":"string"}}},{"name":"DeviceTypes","in":"query","description":"Device Types","schema":{"type":"array","items":{"type":"string"}}},{"name":"DeviceStatus","in":"query","description":"Device Status, optional. Accepted values: \"Active\", \"Inactive\".","schema":{"type":"string"}},{"name":"VehicleTypeTags","in":"query","description":"\"VehicleType\" tag values","schema":{"type":"array","items":{"type":"string"}}},{"name":"DeviceIds","in":"query","description":"Device Ids","schema":{"type":"array","items":{"type":"string"}}},{"name":"UserIds","in":"query","description":"User Ids","schema":{"type":"array","items":{"type":"string"}}},{"name":"CollectionId","in":"query","description":"Cross tenant collection id. Report data is based on the collection (groups and devices related query parameters are ignored).","schema":{"type":"string"}},{"name":"IntervalType","in":"query","description":"Pre-defined custom interval, can be used instead of DateFrom and DateTo. Accepted value: this-week, this-month, this-quarter, this-year, this-financial-year, yesterday, last-week, last-week-sunday, last-7-days, last-10-days, last-30-days, last-4-weeks, last-12-weeks, last-3-months, last-6-months, last-12-months, last-month, last-quarter, last-year, last-financial-year","schema":{"type":"string"}},{"name":"DateFrom","in":"query","description":"Report interval start date. Required when no IntervalType specified.","schema":{"type":"string","format":"date-time"}},{"name":"DateTo","in":"query","description":"Report interval end date. Required when no IntervalType specified.","schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DriverPerformanceSummaryReportEntry"}}},"application/json;IEEE754Compatible=false":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DriverPerformanceSummaryReportEntry"}}},"application/json;IEEE754Compatible=true":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DriverPerformanceSummaryReportEntry"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DriverPerformanceSummaryReportEntry"}}},"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DriverPerformanceSummaryReportEntry"}}},"application/octet-stream":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DriverPerformanceSummaryReportEntry"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DriverPerformanceSummaryReportEntry"}}},"text/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DriverPerformanceSummaryReportEntry"}}},"text/csv":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DriverPerformanceSummaryReportEntry"}}}}}}}}},"components":{"schemas":{"DriverPerformanceSummaryReportEntry":{"type":"object","properties":{"Score":{"type":"integer","description":"Driver behaviour score","format":"int32"},"Driver":{"type":"string","description":"Driver name (returned when GroupBy parameter equals to 'Driver')","nullable":true},"Vehicle":{"type":"string","description":"Vehicle name (returned when GroupBy parameter equals to 'Vehicle')","nullable":true},"JourneysCount":{"type":"integer","description":"Number of journeys","format":"int32"},"DistanceKm":{"type":"number","description":"Total distance in Km","format":"double"},"DurationSec":{"type":"integer","description":"Total journeys duration in seconds","format":"int32"}},"additionalProperties":false}}}}
```

## GET /V2/{tenantVarCode}/reports/DriverBehaviourReport

> Returns driver behaviour report data

```json
{"openapi":"3.0.4","info":{"title":"GAP REST API Documentation V2","version":"v2"},"tags":[{"name":"Reports"}],"paths":{"/V2/{tenantVarCode}/reports/DriverBehaviourReport":{"get":{"tags":["Reports"],"summary":"Returns driver behaviour report data","parameters":[{"name":"tenantVarCode","in":"path","description":"","required":true,"schema":{"type":"string"}},{"name":"GroupBy","in":"query","description":"Defines if reports is grouped by 'Vehicle' or 'Driver' (default: 'Driver')","schema":{"type":"string"}},{"name":"DrivingViolationTypes","in":"query","description":"Report result can be filtered by violation type: Acceleration, Braking, Turning, Speeding","schema":{"type":"array","items":{"type":"string"}}},{"name":"Subtenants","in":"query","description":"When 'subtenants=true' result contains report data for the tenant and all subtenants","schema":{"type":"boolean"}},{"name":"GroupIds","in":"query","description":"Group Ids","schema":{"type":"array","items":{"type":"string"}}},{"name":"DeviceTypes","in":"query","description":"Device Types","schema":{"type":"array","items":{"type":"string"}}},{"name":"DeviceStatus","in":"query","description":"Device Status, optional. Accepted values: \"Active\", \"Inactive\".","schema":{"type":"string"}},{"name":"VehicleTypeTags","in":"query","description":"\"VehicleType\" tag values","schema":{"type":"array","items":{"type":"string"}}},{"name":"DeviceIds","in":"query","description":"Device Ids","schema":{"type":"array","items":{"type":"string"}}},{"name":"UserIds","in":"query","description":"User Ids","schema":{"type":"array","items":{"type":"string"}}},{"name":"CollectionId","in":"query","description":"Cross tenant collection id. Report data is based on the collection (groups and devices related query parameters are ignored).","schema":{"type":"string"}},{"name":"IntervalType","in":"query","description":"Pre-defined custom interval, can be used instead of DateFrom and DateTo. Accepted value: this-week, this-month, this-quarter, this-year, this-financial-year, yesterday, last-week, last-week-sunday, last-7-days, last-10-days, last-30-days, last-4-weeks, last-12-weeks, last-3-months, last-6-months, last-12-months, last-month, last-quarter, last-year, last-financial-year","schema":{"type":"string"}},{"name":"DateFrom","in":"query","description":"Report interval start date. Required when no IntervalType specified.","schema":{"type":"string","format":"date-time"}},{"name":"DateTo","in":"query","description":"Report interval end date. Required when no IntervalType specified.","schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DriverPerformanceSummaryReportEntry"}}},"application/json;IEEE754Compatible=false":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DriverPerformanceSummaryReportEntry"}}},"application/json;IEEE754Compatible=true":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DriverPerformanceSummaryReportEntry"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DriverPerformanceSummaryReportEntry"}}},"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DriverPerformanceSummaryReportEntry"}}},"application/octet-stream":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DriverPerformanceSummaryReportEntry"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DriverPerformanceSummaryReportEntry"}}},"text/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DriverPerformanceSummaryReportEntry"}}},"text/csv":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DriverPerformanceSummaryReportEntry"}}}}}}}}},"components":{"schemas":{"DriverPerformanceSummaryReportEntry":{"type":"object","properties":{"Score":{"type":"integer","description":"Driver behaviour score","format":"int32"},"Driver":{"type":"string","description":"Driver name (returned when GroupBy parameter equals to 'Driver')","nullable":true},"Vehicle":{"type":"string","description":"Vehicle name (returned when GroupBy parameter equals to 'Vehicle')","nullable":true},"JourneysCount":{"type":"integer","description":"Number of journeys","format":"int32"},"DistanceKm":{"type":"number","description":"Total distance in Km","format":"double"},"DurationSec":{"type":"integer","description":"Total journeys duration in seconds","format":"int32"}},"additionalProperties":false}}}}
```

## GET /V2/{tenantVarCode}/reports/DriverPerformanceDetailedReport

> Returns driver behaviour violation report data

```json
{"openapi":"3.0.4","info":{"title":"GAP REST API Documentation V2","version":"v2"},"tags":[{"name":"Reports"}],"paths":{"/V2/{tenantVarCode}/reports/DriverPerformanceDetailedReport":{"get":{"tags":["Reports"],"summary":"Returns driver behaviour violation report data","parameters":[{"name":"tenantVarCode","in":"path","description":"Tenant Var Code","required":true,"schema":{"type":"string"}},{"name":"DrivingViolationTypes","in":"query","description":"Report result can be filtered by violation type: Acceleration, Braking, Turning, Speeding","schema":{"type":"array","items":{"type":"string"}}},{"name":"Subtenants","in":"query","description":"When 'subtenants=true' result contains report data for the tenant and all subtenants","schema":{"type":"boolean"}},{"name":"GroupIds","in":"query","description":"Group Ids","schema":{"type":"array","items":{"type":"string"}}},{"name":"DeviceTypes","in":"query","description":"Device Types","schema":{"type":"array","items":{"type":"string"}}},{"name":"DeviceStatus","in":"query","description":"Device Status, optional. Accepted values: \"Active\", \"Inactive\".","schema":{"type":"string"}},{"name":"VehicleTypeTags","in":"query","description":"\"VehicleType\" tag values","schema":{"type":"array","items":{"type":"string"}}},{"name":"DeviceIds","in":"query","description":"Device Ids","schema":{"type":"array","items":{"type":"string"}}},{"name":"UserIds","in":"query","description":"User Ids","schema":{"type":"array","items":{"type":"string"}}},{"name":"CollectionId","in":"query","description":"Cross tenant collection id. Report data is based on the collection (groups and devices related query parameters are ignored).","schema":{"type":"string"}},{"name":"IntervalType","in":"query","description":"Pre-defined custom interval, can be used instead of DateFrom and DateTo. Accepted value: this-week, this-month, this-quarter, this-year, this-financial-year, yesterday, last-week, last-week-sunday, last-7-days, last-10-days, last-30-days, last-4-weeks, last-12-weeks, last-3-months, last-6-months, last-12-months, last-month, last-quarter, last-year, last-financial-year","schema":{"type":"string"}},{"name":"DateFrom","in":"query","description":"Report interval start date. Required when no IntervalType specified.","schema":{"type":"string","format":"date-time"}},{"name":"DateTo","in":"query","description":"Report interval end date. Required when no IntervalType specified.","schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DriverPerformanceDetailedReportEntry"}}},"application/json;IEEE754Compatible=false":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DriverPerformanceDetailedReportEntry"}}},"application/json;IEEE754Compatible=true":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DriverPerformanceDetailedReportEntry"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DriverPerformanceDetailedReportEntry"}}},"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DriverPerformanceDetailedReportEntry"}}},"application/octet-stream":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DriverPerformanceDetailedReportEntry"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DriverPerformanceDetailedReportEntry"}}},"text/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DriverPerformanceDetailedReportEntry"}}},"text/csv":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DriverPerformanceDetailedReportEntry"}}}}}}}}},"components":{"schemas":{"DriverPerformanceDetailedReportEntry":{"type":"object","properties":{"TenantVarCode":{"type":"string","description":"Tenant Var Code","nullable":true},"JourneyId":{"type":"string","description":"Journey Id","nullable":true},"DeviceId":{"type":"string","description":"Device Id","nullable":true},"UserId":{"type":"string","description":"User Id","nullable":true},"DateTimeLocal":{"type":"string","description":"Violation date and time (local)","format":"date-time"},"DateTimeUtc":{"type":"string","description":"Violations date and time (UTC)","format":"date-time"},"Latitude":{"type":"number","description":"Latitude","format":"double","nullable":true},"Longitude":{"type":"number","description":"Longitude","format":"double","nullable":true},"Address":{"type":"string","description":"Address","nullable":true},"ViolationType":{"type":"string","description":"Violation type (Acceleration, Braking, Turning, Speeding)","nullable":true},"Limit":{"type":"number","description":"Violation limit - could be max speed (kmh) or acceleration threshold etc","format":"double","nullable":true},"RecordedValue":{"type":"number","description":"Recorded violation value ie: current speeding value or acceleration/braking value","format":"double","nullable":true},"DurationSeconds":{"type":"number","description":"Duration in seconds","format":"double","nullable":true},"Geofence":{"type":"string","description":"List of geofence names where violation occured","nullable":true},"GroupName":{"type":"string","description":"Group name","nullable":true},"DeviceFriendlyName":{"type":"string","description":"Device friendly name","nullable":true},"UserFirstName":{"type":"string","description":"User first name","nullable":true},"UserLastName":{"type":"string","description":"User last name","nullable":true}},"additionalProperties":false}}}}
```

## GET /V2/{tenantVarCode}/reports/DriverBehaviourViolationReport

> Returns driver behaviour violation report data

```json
{"openapi":"3.0.4","info":{"title":"GAP REST API Documentation V2","version":"v2"},"tags":[{"name":"Reports"}],"paths":{"/V2/{tenantVarCode}/reports/DriverBehaviourViolationReport":{"get":{"tags":["Reports"],"summary":"Returns driver behaviour violation report data","parameters":[{"name":"tenantVarCode","in":"path","description":"Tenant Var Code","required":true,"schema":{"type":"string"}},{"name":"DrivingViolationTypes","in":"query","description":"Report result can be filtered by violation type: Acceleration, Braking, Turning, Speeding","schema":{"type":"array","items":{"type":"string"}}},{"name":"Subtenants","in":"query","description":"When 'subtenants=true' result contains report data for the tenant and all subtenants","schema":{"type":"boolean"}},{"name":"GroupIds","in":"query","description":"Group Ids","schema":{"type":"array","items":{"type":"string"}}},{"name":"DeviceTypes","in":"query","description":"Device Types","schema":{"type":"array","items":{"type":"string"}}},{"name":"DeviceStatus","in":"query","description":"Device Status, optional. Accepted values: \"Active\", \"Inactive\".","schema":{"type":"string"}},{"name":"VehicleTypeTags","in":"query","description":"\"VehicleType\" tag values","schema":{"type":"array","items":{"type":"string"}}},{"name":"DeviceIds","in":"query","description":"Device Ids","schema":{"type":"array","items":{"type":"string"}}},{"name":"UserIds","in":"query","description":"User Ids","schema":{"type":"array","items":{"type":"string"}}},{"name":"CollectionId","in":"query","description":"Cross tenant collection id. Report data is based on the collection (groups and devices related query parameters are ignored).","schema":{"type":"string"}},{"name":"IntervalType","in":"query","description":"Pre-defined custom interval, can be used instead of DateFrom and DateTo. Accepted value: this-week, this-month, this-quarter, this-year, this-financial-year, yesterday, last-week, last-week-sunday, last-7-days, last-10-days, last-30-days, last-4-weeks, last-12-weeks, last-3-months, last-6-months, last-12-months, last-month, last-quarter, last-year, last-financial-year","schema":{"type":"string"}},{"name":"DateFrom","in":"query","description":"Report interval start date. Required when no IntervalType specified.","schema":{"type":"string","format":"date-time"}},{"name":"DateTo","in":"query","description":"Report interval end date. Required when no IntervalType specified.","schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DriverPerformanceDetailedReportEntry"}}},"application/json;IEEE754Compatible=false":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DriverPerformanceDetailedReportEntry"}}},"application/json;IEEE754Compatible=true":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DriverPerformanceDetailedReportEntry"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DriverPerformanceDetailedReportEntry"}}},"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DriverPerformanceDetailedReportEntry"}}},"application/octet-stream":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DriverPerformanceDetailedReportEntry"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DriverPerformanceDetailedReportEntry"}}},"text/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DriverPerformanceDetailedReportEntry"}}},"text/csv":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DriverPerformanceDetailedReportEntry"}}}}}}}}},"components":{"schemas":{"DriverPerformanceDetailedReportEntry":{"type":"object","properties":{"TenantVarCode":{"type":"string","description":"Tenant Var Code","nullable":true},"JourneyId":{"type":"string","description":"Journey Id","nullable":true},"DeviceId":{"type":"string","description":"Device Id","nullable":true},"UserId":{"type":"string","description":"User Id","nullable":true},"DateTimeLocal":{"type":"string","description":"Violation date and time (local)","format":"date-time"},"DateTimeUtc":{"type":"string","description":"Violations date and time (UTC)","format":"date-time"},"Latitude":{"type":"number","description":"Latitude","format":"double","nullable":true},"Longitude":{"type":"number","description":"Longitude","format":"double","nullable":true},"Address":{"type":"string","description":"Address","nullable":true},"ViolationType":{"type":"string","description":"Violation type (Acceleration, Braking, Turning, Speeding)","nullable":true},"Limit":{"type":"number","description":"Violation limit - could be max speed (kmh) or acceleration threshold etc","format":"double","nullable":true},"RecordedValue":{"type":"number","description":"Recorded violation value ie: current speeding value or acceleration/braking value","format":"double","nullable":true},"DurationSeconds":{"type":"number","description":"Duration in seconds","format":"double","nullable":true},"Geofence":{"type":"string","description":"List of geofence names where violation occured","nullable":true},"GroupName":{"type":"string","description":"Group name","nullable":true},"DeviceFriendlyName":{"type":"string","description":"Device friendly name","nullable":true},"UserFirstName":{"type":"string","description":"User first name","nullable":true},"UserLastName":{"type":"string","description":"User last name","nullable":true}},"additionalProperties":false}}}}
```

## GET /V2/{tenantVarCode}/reports/EnterpriseLicenseStatisticsReport

> Returns enterprise licence stsatistics report data

```json
{"openapi":"3.0.4","info":{"title":"GAP REST API Documentation V2","version":"v2"},"tags":[{"name":"Reports"}],"paths":{"/V2/{tenantVarCode}/reports/EnterpriseLicenseStatisticsReport":{"get":{"tags":["Reports"],"summary":"Returns enterprise licence stsatistics report data","parameters":[{"name":"tenantVarCode","in":"path","description":"Tenant Var Code","required":true,"schema":{"type":"string"}},{"name":"Subtenants","in":"query","description":"When 'subtenants=true' result contains report data for the tenant and all subtenants","schema":{"type":"boolean"}},{"name":"GroupIds","in":"query","description":"Group Ids","schema":{"type":"array","items":{"type":"string"}}},{"name":"DeviceTypes","in":"query","description":"Device Types","schema":{"type":"array","items":{"type":"string"}}},{"name":"DeviceStatus","in":"query","description":"Device Status, optional. Accepted values: \"Active\", \"Inactive\".","schema":{"type":"string"}},{"name":"VehicleTypeTags","in":"query","description":"\"VehicleType\" tag values","schema":{"type":"array","items":{"type":"string"}}},{"name":"DeviceIds","in":"query","description":"Device Ids","schema":{"type":"array","items":{"type":"string"}}},{"name":"UserIds","in":"query","description":"User Ids","schema":{"type":"array","items":{"type":"string"}}},{"name":"CollectionId","in":"query","description":"Cross tenant collection id. Report data is based on the collection (groups and devices related query parameters are ignored).","schema":{"type":"string"}},{"name":"IntervalType","in":"query","description":"Pre-defined custom interval, can be used instead of DateFrom and DateTo. Accepted value: this-week, this-month, this-quarter, this-year, this-financial-year, yesterday, last-week, last-week-sunday, last-7-days, last-10-days, last-30-days, last-4-weeks, last-12-weeks, last-3-months, last-6-months, last-12-months, last-month, last-quarter, last-year, last-financial-year","schema":{"type":"string"}},{"name":"DateFrom","in":"query","description":"Report interval start date. Required when no IntervalType specified.","schema":{"type":"string","format":"date-time"}},{"name":"DateTo","in":"query","description":"Report interval end date. Required when no IntervalType specified.","schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EnterpriseLicenseStatisticsReportEntry"}}},"application/json;IEEE754Compatible=false":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EnterpriseLicenseStatisticsReportEntry"}}},"application/json;IEEE754Compatible=true":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EnterpriseLicenseStatisticsReportEntry"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EnterpriseLicenseStatisticsReportEntry"}}},"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EnterpriseLicenseStatisticsReportEntry"}}},"application/octet-stream":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EnterpriseLicenseStatisticsReportEntry"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EnterpriseLicenseStatisticsReportEntry"}}},"text/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EnterpriseLicenseStatisticsReportEntry"}}},"text/csv":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EnterpriseLicenseStatisticsReportEntry"}}}}}}}}},"components":{"schemas":{"EnterpriseLicenseStatisticsReportEntry":{"type":"object","properties":{"TenantVarCode":{"type":"string","description":"Tenant Var Code","nullable":true},"TenantName":{"type":"string","description":"Tenant name","nullable":true},"Date":{"type":"string","description":"Date","format":"date-time"},"DevicesCount":{"type":"integer","description":"Number of devices","format":"int64"},"MoMessagesCount":{"type":"integer","description":"Number of MO messages","format":"int64"}},"additionalProperties":false}}}}
```

## GET /V2/{tenantVarCode}/reports/FatigueManagementReport

> Returns fatigue management report data

```json
{"openapi":"3.0.4","info":{"title":"GAP REST API Documentation V2","version":"v2"},"tags":[{"name":"Reports"}],"paths":{"/V2/{tenantVarCode}/reports/FatigueManagementReport":{"get":{"tags":["Reports"],"summary":"Returns fatigue management report data","parameters":[{"name":"tenantVarCode","in":"path","description":"Tenant Var Code","required":true,"schema":{"type":"string"}},{"name":"Subtenants","in":"query","description":"When 'subtenants=true' result contains report data for the tenant and all subtenants","schema":{"type":"boolean"}},{"name":"GroupIds","in":"query","description":"Group Ids","schema":{"type":"array","items":{"type":"string"}}},{"name":"DeviceTypes","in":"query","description":"Device Types","schema":{"type":"array","items":{"type":"string"}}},{"name":"DeviceStatus","in":"query","description":"Device Status, optional. Accepted values: \"Active\", \"Inactive\".","schema":{"type":"string"}},{"name":"VehicleTypeTags","in":"query","description":"\"VehicleType\" tag values","schema":{"type":"array","items":{"type":"string"}}},{"name":"DeviceIds","in":"query","description":"Device Ids","schema":{"type":"array","items":{"type":"string"}}},{"name":"UserIds","in":"query","description":"User Ids","schema":{"type":"array","items":{"type":"string"}}},{"name":"CollectionId","in":"query","description":"Cross tenant collection id. Report data is based on the collection (groups and devices related query parameters are ignored).","schema":{"type":"string"}},{"name":"IntervalType","in":"query","description":"Pre-defined custom interval, can be used instead of DateFrom and DateTo. Accepted value: this-week, this-month, this-quarter, this-year, this-financial-year, yesterday, last-week, last-week-sunday, last-7-days, last-10-days, last-30-days, last-4-weeks, last-12-weeks, last-3-months, last-6-months, last-12-months, last-month, last-quarter, last-year, last-financial-year","schema":{"type":"string"}},{"name":"DateFrom","in":"query","description":"Report interval start date. Required when no IntervalType specified.","schema":{"type":"string","format":"date-time"}},{"name":"DateTo","in":"query","description":"Report interval end date. Required when no IntervalType specified.","schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FatigueManagementReportEntry"}}},"application/json;IEEE754Compatible=false":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FatigueManagementReportEntry"}}},"application/json;IEEE754Compatible=true":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FatigueManagementReportEntry"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FatigueManagementReportEntry"}}},"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FatigueManagementReportEntry"}}},"application/octet-stream":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FatigueManagementReportEntry"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FatigueManagementReportEntry"}}},"text/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FatigueManagementReportEntry"}}},"text/csv":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FatigueManagementReportEntry"}}}}}}}}},"components":{"schemas":{"FatigueManagementReportEntry":{"type":"object","properties":{"UserId":{"type":"string","description":"User Id","nullable":true},"DeviceId":{"type":"string","description":"Device Id","nullable":true},"StartTimeLocal":{"type":"string","description":"Fatigue violation start time (local)","format":"date-time"},"StartTimeUtc":{"type":"string","description":"Fatigue violation start time (UTC)","format":"date-time"},"StartLatitude":{"type":"number","description":"Start latitude","format":"double","nullable":true},"StartLongitude":{"type":"number","description":"Start longitude","format":"double","nullable":true},"StartLocationName":{"type":"string","description":"Start geofence names","nullable":true},"StartAddress":{"type":"string","description":"Start address","nullable":true},"EndTimeLocal":{"type":"string","description":"Fatigue violation end time (local)","format":"date-time","nullable":true},"EndTimeUtc":{"type":"string","description":"Fatigue violation end time (UTC)","format":"date-time","nullable":true},"EndLatitude":{"type":"number","description":"End latitude","format":"double","nullable":true},"EndLongitude":{"type":"number","description":"End longitude","format":"double","nullable":true},"EndLocationName":{"type":"string","description":"End geofence names","nullable":true},"EndAddress":{"type":"string","description":"End address","nullable":true},"DistanceKm":{"type":"number","description":"Distance Km","format":"double"},"DrivingSeconds":{"type":"integer","description":"Driving seconds","format":"int32"},"RestingSeconds":{"type":"integer","description":"Rest period seconds","format":"int32"},"ViolationType":{"type":"string","description":"Violation type","nullable":true},"TenantName":{"type":"string","description":"Tenant name","nullable":true},"GroupName":{"type":"string","description":"Group name","nullable":true},"DeviceFriendlyName":{"type":"string","description":"Device friendly name","nullable":true},"UserFirstName":{"type":"string","description":"User first name","nullable":true},"UserLastName":{"type":"string","description":"User last name","nullable":true}},"additionalProperties":false}}}}
```

## GET /V2/{tenantVarCode}/reports/IdlingSummaryReport

> Returns idling summary report data

```json
{"openapi":"3.0.4","info":{"title":"GAP REST API Documentation V2","version":"v2"},"tags":[{"name":"Reports"}],"paths":{"/V2/{tenantVarCode}/reports/IdlingSummaryReport":{"get":{"tags":["Reports"],"summary":"Returns idling summary report data","parameters":[{"name":"tenantVarCode","in":"path","description":"Tenant Var Code","required":true,"schema":{"type":"string"}},{"name":"Subtenants","in":"query","description":"When 'subtenants=true' result contains report data for the tenant and all subtenants","schema":{"type":"boolean"}},{"name":"GroupIds","in":"query","description":"Group Ids","schema":{"type":"array","items":{"type":"string"}}},{"name":"DeviceTypes","in":"query","description":"Device Types","schema":{"type":"array","items":{"type":"string"}}},{"name":"DeviceStatus","in":"query","description":"Device Status, optional. Accepted values: \"Active\", \"Inactive\".","schema":{"type":"string"}},{"name":"VehicleTypeTags","in":"query","description":"\"VehicleType\" tag values","schema":{"type":"array","items":{"type":"string"}}},{"name":"DeviceIds","in":"query","description":"Device Ids","schema":{"type":"array","items":{"type":"string"}}},{"name":"UserIds","in":"query","description":"User Ids","schema":{"type":"array","items":{"type":"string"}}},{"name":"CollectionId","in":"query","description":"Cross tenant collection id. Report data is based on the collection (groups and devices related query parameters are ignored).","schema":{"type":"string"}},{"name":"IntervalType","in":"query","description":"Pre-defined custom interval, can be used instead of DateFrom and DateTo. Accepted value: this-week, this-month, this-quarter, this-year, this-financial-year, yesterday, last-week, last-week-sunday, last-7-days, last-10-days, last-30-days, last-4-weeks, last-12-weeks, last-3-months, last-6-months, last-12-months, last-month, last-quarter, last-year, last-financial-year","schema":{"type":"string"}},{"name":"DateFrom","in":"query","description":"Report interval start date. Required when no IntervalType specified.","schema":{"type":"string","format":"date-time"}},{"name":"DateTo","in":"query","description":"Report interval end date. Required when no IntervalType specified.","schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IdlingSummaryReportEntry"}}},"application/json;IEEE754Compatible=false":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IdlingSummaryReportEntry"}}},"application/json;IEEE754Compatible=true":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IdlingSummaryReportEntry"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IdlingSummaryReportEntry"}}},"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IdlingSummaryReportEntry"}}},"application/octet-stream":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IdlingSummaryReportEntry"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IdlingSummaryReportEntry"}}},"text/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IdlingSummaryReportEntry"}}},"text/csv":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IdlingSummaryReportEntry"}}}}}}}}},"components":{"schemas":{"IdlingSummaryReportEntry":{"type":"object","properties":{"DeviceId":{"type":"string","description":"Device Id","nullable":true},"DeviceFriendlyName":{"type":"string","description":"Device friendly name","nullable":true},"GroupName":{"type":"string","description":"Group name","nullable":true},"DrivingDurationSec":{"type":"integer","description":"Driving duration seconds","format":"int32"},"IdleDurationSec":{"type":"integer","description":"Idle duration seconds","format":"int32"},"IdlingPercent":{"type":"number","description":"Idling time (%)","format":"double"}},"additionalProperties":false}}}}
```

## GET /V2/{tenantVarCode}/reports/InsightsItinerariesReport

> Returns insights itineraries report data

```json
{"openapi":"3.0.4","info":{"title":"GAP REST API Documentation V2","version":"v2"},"tags":[{"name":"Reports"}],"paths":{"/V2/{tenantVarCode}/reports/InsightsItinerariesReport":{"get":{"tags":["Reports"],"summary":"Returns insights itineraries report data","parameters":[{"name":"tenantVarCode","in":"path","description":"Tenant Var Code","required":true,"schema":{"type":"string"}},{"name":"Subtenants","in":"query","description":"When 'subtenants=true' result contains report data for the tenant and all subtenants","schema":{"type":"boolean"}},{"name":"GroupIds","in":"query","description":"Group Ids","schema":{"type":"array","items":{"type":"string"}}},{"name":"DeviceTypes","in":"query","description":"Device Types","schema":{"type":"array","items":{"type":"string"}}},{"name":"DeviceStatus","in":"query","description":"Device Status, optional. Accepted values: \"Active\", \"Inactive\".","schema":{"type":"string"}},{"name":"VehicleTypeTags","in":"query","description":"\"VehicleType\" tag values","schema":{"type":"array","items":{"type":"string"}}},{"name":"DeviceIds","in":"query","description":"Device Ids","schema":{"type":"array","items":{"type":"string"}}},{"name":"UserIds","in":"query","description":"User Ids","schema":{"type":"array","items":{"type":"string"}}},{"name":"CollectionId","in":"query","description":"Cross tenant collection id. Report data is based on the collection (groups and devices related query parameters are ignored).","schema":{"type":"string"}},{"name":"IntervalType","in":"query","description":"Pre-defined custom interval, can be used instead of DateFrom and DateTo. Accepted value: this-week, this-month, this-quarter, this-year, this-financial-year, yesterday, last-week, last-week-sunday, last-7-days, last-10-days, last-30-days, last-4-weeks, last-12-weeks, last-3-months, last-6-months, last-12-months, last-month, last-quarter, last-year, last-financial-year","schema":{"type":"string"}},{"name":"DateFrom","in":"query","description":"Report interval start date. Required when no IntervalType specified.","schema":{"type":"string","format":"date-time"}},{"name":"DateTo","in":"query","description":"Report interval end date. Required when no IntervalType specified.","schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InsightsItinerariesReportEntry"}}},"application/json;IEEE754Compatible=false":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InsightsItinerariesReportEntry"}}},"application/json;IEEE754Compatible=true":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InsightsItinerariesReportEntry"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InsightsItinerariesReportEntry"}}},"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InsightsItinerariesReportEntry"}}},"application/octet-stream":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InsightsItinerariesReportEntry"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InsightsItinerariesReportEntry"}}},"text/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InsightsItinerariesReportEntry"}}},"text/csv":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InsightsItinerariesReportEntry"}}}}}}}}},"components":{"schemas":{"InsightsItinerariesReportEntry":{"type":"object","properties":{"Travelers":{"type":"string","description":"Comma separated list of traveler names","nullable":true},"StartDate":{"type":"string","description":"Itinerary start date (UTC)","format":"date-time"},"EndDate":{"type":"string","description":"Itinerary end date (UTC)","format":"date-time"},"DurationDays":{"type":"integer","description":"Duration days","format":"int32"},"Destinations":{"type":"string","description":"Destinations","nullable":true},"RiskLevel":{"type":"string","description":"Risk level","nullable":true},"Status":{"type":"string","description":"Itinerary status (approval state)","nullable":true},"PnrNumber":{"type":"string","description":"PNR number","nullable":true},"DepartureCountry":{"type":"string","description":"Departure country","nullable":true}},"additionalProperties":false}}}}
```

## GET /V2/{tenantVarCode}/reports/ItineraryStatisticsReport

> Returns itinerary statistics report data

```json
{"openapi":"3.0.4","info":{"title":"GAP REST API Documentation V2","version":"v2"},"tags":[{"name":"Reports"}],"paths":{"/V2/{tenantVarCode}/reports/ItineraryStatisticsReport":{"get":{"tags":["Reports"],"summary":"Returns itinerary statistics report data","parameters":[{"name":"tenantVarCode","in":"path","description":"Tenant Var Code","required":true,"schema":{"type":"string"}},{"name":"Subtenants","in":"query","description":"When 'subtenants=true' result contains report data for the tenant and all subtenants","schema":{"type":"boolean"}},{"name":"GroupIds","in":"query","description":"Group Ids","schema":{"type":"array","items":{"type":"string"}}},{"name":"DeviceTypes","in":"query","description":"Device Types","schema":{"type":"array","items":{"type":"string"}}},{"name":"DeviceStatus","in":"query","description":"Device Status, optional. Accepted values: \"Active\", \"Inactive\".","schema":{"type":"string"}},{"name":"VehicleTypeTags","in":"query","description":"\"VehicleType\" tag values","schema":{"type":"array","items":{"type":"string"}}},{"name":"DeviceIds","in":"query","description":"Device Ids","schema":{"type":"array","items":{"type":"string"}}},{"name":"UserIds","in":"query","description":"User Ids","schema":{"type":"array","items":{"type":"string"}}},{"name":"CollectionId","in":"query","description":"Cross tenant collection id. Report data is based on the collection (groups and devices related query parameters are ignored).","schema":{"type":"string"}},{"name":"IntervalType","in":"query","description":"Pre-defined custom interval, can be used instead of DateFrom and DateTo. Accepted value: this-week, this-month, this-quarter, this-year, this-financial-year, yesterday, last-week, last-week-sunday, last-7-days, last-10-days, last-30-days, last-4-weeks, last-12-weeks, last-3-months, last-6-months, last-12-months, last-month, last-quarter, last-year, last-financial-year","schema":{"type":"string"}},{"name":"DateFrom","in":"query","description":"Report interval start date. Required when no IntervalType specified.","schema":{"type":"string","format":"date-time"}},{"name":"DateTo","in":"query","description":"Report interval end date. Required when no IntervalType specified.","schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ItineraryStatisticsReportEntry"}}},"application/json;IEEE754Compatible=false":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ItineraryStatisticsReportEntry"}}},"application/json;IEEE754Compatible=true":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ItineraryStatisticsReportEntry"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ItineraryStatisticsReportEntry"}}},"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ItineraryStatisticsReportEntry"}}},"application/octet-stream":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ItineraryStatisticsReportEntry"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ItineraryStatisticsReportEntry"}}},"text/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ItineraryStatisticsReportEntry"}}},"text/csv":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ItineraryStatisticsReportEntry"}}}}}}}}},"components":{"schemas":{"ItineraryStatisticsReportEntry":{"type":"object","properties":{"TenantVarCode":{"type":"string","description":"Tenant Var code","nullable":true},"TenantName":{"type":"string","description":"Tenant name","nullable":true},"Date":{"type":"string","description":"Date","format":"date-time"},"ItinerariesCount":{"type":"integer","description":"Number of itineraries","format":"int64"}},"additionalProperties":false}}}}
```

## GET /V2/{tenantVarCode}/reports/NewDevicesReport

> Returns new devices report data

```json
{"openapi":"3.0.4","info":{"title":"GAP REST API Documentation V2","version":"v2"},"tags":[{"name":"Reports"}],"paths":{"/V2/{tenantVarCode}/reports/NewDevicesReport":{"get":{"tags":["Reports"],"summary":"Returns new devices report data","parameters":[{"name":"tenantVarCode","in":"path","description":"Tenant Var Code","required":true,"schema":{"type":"string"}},{"name":"Subtenants","in":"query","description":"When 'subtenants=true' result contains report data for the tenant and all subtenants","schema":{"type":"boolean"}},{"name":"GroupIds","in":"query","description":"Group Ids","schema":{"type":"array","items":{"type":"string"}}},{"name":"DeviceTypes","in":"query","description":"Device Types","schema":{"type":"array","items":{"type":"string"}}},{"name":"DeviceStatus","in":"query","description":"Device Status, optional. Accepted values: \"Active\", \"Inactive\".","schema":{"type":"string"}},{"name":"VehicleTypeTags","in":"query","description":"\"VehicleType\" tag values","schema":{"type":"array","items":{"type":"string"}}},{"name":"DeviceIds","in":"query","description":"Device Ids","schema":{"type":"array","items":{"type":"string"}}},{"name":"UserIds","in":"query","description":"User Ids","schema":{"type":"array","items":{"type":"string"}}},{"name":"CollectionId","in":"query","description":"Cross tenant collection id. Report data is based on the collection (groups and devices related query parameters are ignored).","schema":{"type":"string"}},{"name":"IntervalType","in":"query","description":"Pre-defined custom interval, can be used instead of DateFrom and DateTo. Accepted value: this-week, this-month, this-quarter, this-year, this-financial-year, yesterday, last-week, last-week-sunday, last-7-days, last-10-days, last-30-days, last-4-weeks, last-12-weeks, last-3-months, last-6-months, last-12-months, last-month, last-quarter, last-year, last-financial-year","schema":{"type":"string"}},{"name":"DateFrom","in":"query","description":"Report interval start date. Required when no IntervalType specified.","schema":{"type":"string","format":"date-time"}},{"name":"DateTo","in":"query","description":"Report interval end date. Required when no IntervalType specified.","schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NewDevicesReportEntry"}}},"application/json;IEEE754Compatible=false":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NewDevicesReportEntry"}}},"application/json;IEEE754Compatible=true":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NewDevicesReportEntry"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NewDevicesReportEntry"}}},"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NewDevicesReportEntry"}}},"application/octet-stream":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NewDevicesReportEntry"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NewDevicesReportEntry"}}},"text/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NewDevicesReportEntry"}}},"text/csv":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NewDevicesReportEntry"}}}}}}}}},"components":{"schemas":{"NewDevicesReportEntry":{"type":"object","properties":{"DeviceId":{"type":"string","description":"Device Id","nullable":true},"DeviceFriendlyName":{"type":"string","description":"Device friendly name","nullable":true},"DeviceDescription":{"type":"string","description":"Device description","nullable":true},"DeviceType":{"type":"string","description":"Device type","nullable":true},"TenantVarCode":{"type":"string","description":"Tenant Var code","nullable":true},"TenantName":{"type":"string","description":"Tenant name","nullable":true},"UserId":{"type":"string","description":"User Id","nullable":true},"Username":{"type":"string","description":"Username","nullable":true},"CreatedDate":{"type":"string","description":"Device created date","format":"date-time"}},"additionalProperties":false}}}}
```

## GET /V2/{tenantVarCode}/reports/NewInsightsItinerariesReport

> Returns new itineraries report data

```json
{"openapi":"3.0.4","info":{"title":"GAP REST API Documentation V2","version":"v2"},"tags":[{"name":"Reports"}],"paths":{"/V2/{tenantVarCode}/reports/NewInsightsItinerariesReport":{"get":{"tags":["Reports"],"summary":"Returns new itineraries report data","parameters":[{"name":"tenantVarCode","in":"path","description":"Tenant Var Code","required":true,"schema":{"type":"string"}},{"name":"Subtenants","in":"query","description":"When 'subtenants=true' result contains report data for the tenant and all subtenants","schema":{"type":"boolean"}},{"name":"GroupIds","in":"query","description":"Group Ids","schema":{"type":"array","items":{"type":"string"}}},{"name":"DeviceTypes","in":"query","description":"Device Types","schema":{"type":"array","items":{"type":"string"}}},{"name":"DeviceStatus","in":"query","description":"Device Status, optional. Accepted values: \"Active\", \"Inactive\".","schema":{"type":"string"}},{"name":"VehicleTypeTags","in":"query","description":"\"VehicleType\" tag values","schema":{"type":"array","items":{"type":"string"}}},{"name":"DeviceIds","in":"query","description":"Device Ids","schema":{"type":"array","items":{"type":"string"}}},{"name":"UserIds","in":"query","description":"User Ids","schema":{"type":"array","items":{"type":"string"}}},{"name":"CollectionId","in":"query","description":"Cross tenant collection id. Report data is based on the collection (groups and devices related query parameters are ignored).","schema":{"type":"string"}},{"name":"IntervalType","in":"query","description":"Pre-defined custom interval, can be used instead of DateFrom and DateTo. Accepted value: this-week, this-month, this-quarter, this-year, this-financial-year, yesterday, last-week, last-week-sunday, last-7-days, last-10-days, last-30-days, last-4-weeks, last-12-weeks, last-3-months, last-6-months, last-12-months, last-month, last-quarter, last-year, last-financial-year","schema":{"type":"string"}},{"name":"DateFrom","in":"query","description":"Report interval start date. Required when no IntervalType specified.","schema":{"type":"string","format":"date-time"}},{"name":"DateTo","in":"query","description":"Report interval end date. Required when no IntervalType specified.","schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NewInsightsItinerariesReportEntry"}}},"application/json;IEEE754Compatible=false":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NewInsightsItinerariesReportEntry"}}},"application/json;IEEE754Compatible=true":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NewInsightsItinerariesReportEntry"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NewInsightsItinerariesReportEntry"}}},"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NewInsightsItinerariesReportEntry"}}},"application/octet-stream":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NewInsightsItinerariesReportEntry"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NewInsightsItinerariesReportEntry"}}},"text/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NewInsightsItinerariesReportEntry"}}},"text/csv":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NewInsightsItinerariesReportEntry"}}}}}}}}},"components":{"schemas":{"NewInsightsItinerariesReportEntry":{"type":"object","properties":{"CreatedDate":{"type":"string","description":"Itinerary created date","format":"date-time"},"Travelers":{"type":"string","description":"Comma separated list of traveler names","nullable":true},"StartDate":{"type":"string","description":"Itinerary start date (UTC)","format":"date-time"},"EndDate":{"type":"string","description":"Itinerary end date (UTC)","format":"date-time"},"DurationDays":{"type":"integer","description":"Duration days","format":"int32"},"Destinations":{"type":"string","description":"Destinations","nullable":true},"RiskLevel":{"type":"string","description":"Risk level","nullable":true},"ApprovalState":{"type":"string","description":"Approval state","nullable":true},"PnrNumber":{"type":"string","description":"PNR number","nullable":true}},"additionalProperties":false}}}}
```

## GET /V2/{tenantVarCode}/reports/PlantHoursDetailReport

> Returns plant hours detail report data

```json
{"openapi":"3.0.4","info":{"title":"GAP REST API Documentation V2","version":"v2"},"tags":[{"name":"Reports"}],"paths":{"/V2/{tenantVarCode}/reports/PlantHoursDetailReport":{"get":{"tags":["Reports"],"summary":"Returns plant hours detail report data","parameters":[{"name":"tenantVarCode","in":"path","description":"Tenant Var Code","required":true,"schema":{"type":"string"}},{"name":"PlantTypes","in":"query","description":"Plant types filter (\"PTO Active\", \"Boom Raised\")","schema":{"type":"array","items":{"type":"string"}}},{"name":"Subtenants","in":"query","description":"When 'subtenants=true' result contains report data for the tenant and all subtenants","schema":{"type":"boolean"}},{"name":"GroupIds","in":"query","description":"Group Ids","schema":{"type":"array","items":{"type":"string"}}},{"name":"DeviceTypes","in":"query","description":"Device Types","schema":{"type":"array","items":{"type":"string"}}},{"name":"DeviceStatus","in":"query","description":"Device Status, optional. Accepted values: \"Active\", \"Inactive\".","schema":{"type":"string"}},{"name":"VehicleTypeTags","in":"query","description":"\"VehicleType\" tag values","schema":{"type":"array","items":{"type":"string"}}},{"name":"DeviceIds","in":"query","description":"Device Ids","schema":{"type":"array","items":{"type":"string"}}},{"name":"UserIds","in":"query","description":"User Ids","schema":{"type":"array","items":{"type":"string"}}},{"name":"CollectionId","in":"query","description":"Cross tenant collection id. Report data is based on the collection (groups and devices related query parameters are ignored).","schema":{"type":"string"}},{"name":"IntervalType","in":"query","description":"Pre-defined custom interval, can be used instead of DateFrom and DateTo. Accepted value: this-week, this-month, this-quarter, this-year, this-financial-year, yesterday, last-week, last-week-sunday, last-7-days, last-10-days, last-30-days, last-4-weeks, last-12-weeks, last-3-months, last-6-months, last-12-months, last-month, last-quarter, last-year, last-financial-year","schema":{"type":"string"}},{"name":"DateFrom","in":"query","description":"Report interval start date. Required when no IntervalType specified.","schema":{"type":"string","format":"date-time"}},{"name":"DateTo","in":"query","description":"Report interval end date. Required when no IntervalType specified.","schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PlantHoursDetailReportEntry"}}},"application/json;IEEE754Compatible=false":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PlantHoursDetailReportEntry"}}},"application/json;IEEE754Compatible=true":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PlantHoursDetailReportEntry"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PlantHoursDetailReportEntry"}}},"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PlantHoursDetailReportEntry"}}},"application/octet-stream":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PlantHoursDetailReportEntry"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PlantHoursDetailReportEntry"}}},"text/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PlantHoursDetailReportEntry"}}},"text/csv":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PlantHoursDetailReportEntry"}}}}}}}}},"components":{"schemas":{"PlantHoursDetailReportEntry":{"type":"object","properties":{"TenantVarCode":{"type":"string","description":"Tenant Var code","nullable":true},"PlantType":{"type":"string","description":"Plant type (\"PTO Active\", \"Boom Raised\")","nullable":true},"IsPending":{"type":"boolean","description":"True if state is still pending at the time report data is generated"},"UserId":{"type":"string","description":"User Id","nullable":true},"DeviceId":{"type":"string","description":"Device Id","nullable":true},"TenantName":{"type":"string","description":"Tenant name","nullable":true},"GroupName":{"type":"string","description":"Group name","nullable":true},"DeviceFriendlyName":{"type":"string","description":"Device friendly name","nullable":true},"UserFirstName":{"type":"string","description":"User first name","nullable":true},"UserLastName":{"type":"string","description":"User last name","nullable":true},"StartTimeLocal":{"type":"string","description":"Interval start time (local)","format":"date-time"},"StartLocationName":{"type":"string","description":"Start geofence names","nullable":true},"StartLatitude":{"type":"number","description":"Start latitude","format":"double","nullable":true},"StartLongitude":{"type":"number","description":"Start longitude","format":"double","nullable":true},"StartAddress":{"type":"string","description":"Start address","nullable":true},"EndTimeLocal":{"type":"string","description":"Interval end time (local)","format":"date-time","nullable":true},"EndLocationName":{"type":"string","description":"End geofence names","nullable":true},"EndLatitude":{"type":"number","description":"End latitude","format":"double","nullable":true},"EndLongitude":{"type":"number","description":"End longitude","format":"double","nullable":true},"EndAddress":{"type":"string","description":"End address","nullable":true},"DurationSeconds":{"type":"integer","description":"Duration in seconds","format":"int32"}},"additionalProperties":false}}}}
```

## GET /V2/{tenantVarCode}/reports/PlantHoursSummaryReport

> Returns plant hours summary report data

```json
{"openapi":"3.0.4","info":{"title":"GAP REST API Documentation V2","version":"v2"},"tags":[{"name":"Reports"}],"paths":{"/V2/{tenantVarCode}/reports/PlantHoursSummaryReport":{"get":{"tags":["Reports"],"summary":"Returns plant hours summary report data","parameters":[{"name":"tenantVarCode","in":"path","description":"Tenant Var Code","required":true,"schema":{"type":"string"}},{"name":"Subtenants","in":"query","description":"When 'subtenants=true' result contains report data for the tenant and all subtenants","schema":{"type":"boolean"}},{"name":"GroupIds","in":"query","description":"Group Ids","schema":{"type":"array","items":{"type":"string"}}},{"name":"DeviceTypes","in":"query","description":"Device Types","schema":{"type":"array","items":{"type":"string"}}},{"name":"DeviceStatus","in":"query","description":"Device Status, optional. Accepted values: \"Active\", \"Inactive\".","schema":{"type":"string"}},{"name":"VehicleTypeTags","in":"query","description":"\"VehicleType\" tag values","schema":{"type":"array","items":{"type":"string"}}},{"name":"DeviceIds","in":"query","description":"Device Ids","schema":{"type":"array","items":{"type":"string"}}},{"name":"UserIds","in":"query","description":"User Ids","schema":{"type":"array","items":{"type":"string"}}},{"name":"CollectionId","in":"query","description":"Cross tenant collection id. Report data is based on the collection (groups and devices related query parameters are ignored).","schema":{"type":"string"}},{"name":"IntervalType","in":"query","description":"Pre-defined custom interval, can be used instead of DateFrom and DateTo. Accepted value: this-week, this-month, this-quarter, this-year, this-financial-year, yesterday, last-week, last-week-sunday, last-7-days, last-10-days, last-30-days, last-4-weeks, last-12-weeks, last-3-months, last-6-months, last-12-months, last-month, last-quarter, last-year, last-financial-year","schema":{"type":"string"}},{"name":"DateFrom","in":"query","description":"Report interval start date. Required when no IntervalType specified.","schema":{"type":"string","format":"date-time"}},{"name":"DateTo","in":"query","description":"Report interval end date. Required when no IntervalType specified.","schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PlantHoursSummaryReportEntry"}}},"application/json;IEEE754Compatible=false":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PlantHoursSummaryReportEntry"}}},"application/json;IEEE754Compatible=true":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PlantHoursSummaryReportEntry"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PlantHoursSummaryReportEntry"}}},"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PlantHoursSummaryReportEntry"}}},"application/octet-stream":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PlantHoursSummaryReportEntry"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PlantHoursSummaryReportEntry"}}},"text/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PlantHoursSummaryReportEntry"}}},"text/csv":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PlantHoursSummaryReportEntry"}}}}}}}}},"components":{"schemas":{"PlantHoursSummaryReportEntry":{"type":"object","properties":{"DeviceId":{"type":"string","description":"Device Id","nullable":true},"DeviceFriendlyName":{"type":"string","description":"Device friendly name","nullable":true},"PtoSeconds":{"type":"integer","description":"PTO active time in seconds","format":"int32"},"BoomSeconds":{"type":"integer","description":"Boom raised time in seconds","format":"int32"},"TenantName":{"type":"string","description":"Tenant name","nullable":true},"GroupName":{"type":"string","description":"Group name","nullable":true}},"additionalProperties":false}}}}
```

## GET /V2/{tenantVarCode}/reports/TimeInGeofenceReport

> Returns time in geofence report data

```json
{"openapi":"3.0.4","info":{"title":"GAP REST API Documentation V2","version":"v2"},"tags":[{"name":"Reports"}],"paths":{"/V2/{tenantVarCode}/reports/TimeInGeofenceReport":{"get":{"tags":["Reports"],"summary":"Returns time in geofence report data","parameters":[{"name":"tenantVarCode","in":"path","description":"Tenant Var Code","required":true,"schema":{"type":"string"}},{"name":"GeofenceIds","in":"query","description":"Geofence Ids","schema":{"type":"array","items":{"type":"string"}}},{"name":"GeofenceTypeTags","in":"query","description":"\"GeofenceType\" tag values","schema":{"type":"array","items":{"type":"string"}}},{"name":"Subtenants","in":"query","description":"When 'subtenants=true' result contains report data for the tenant and all subtenants","schema":{"type":"boolean"}},{"name":"GroupIds","in":"query","description":"Group Ids","schema":{"type":"array","items":{"type":"string"}}},{"name":"DeviceTypes","in":"query","description":"Device Types","schema":{"type":"array","items":{"type":"string"}}},{"name":"DeviceStatus","in":"query","description":"Device Status, optional. Accepted values: \"Active\", \"Inactive\".","schema":{"type":"string"}},{"name":"VehicleTypeTags","in":"query","description":"\"VehicleType\" tag values","schema":{"type":"array","items":{"type":"string"}}},{"name":"DeviceIds","in":"query","description":"Device Ids","schema":{"type":"array","items":{"type":"string"}}},{"name":"UserIds","in":"query","description":"User Ids","schema":{"type":"array","items":{"type":"string"}}},{"name":"CollectionId","in":"query","description":"Cross tenant collection id. Report data is based on the collection (groups and devices related query parameters are ignored).","schema":{"type":"string"}},{"name":"IntervalType","in":"query","description":"Pre-defined custom interval, can be used instead of DateFrom and DateTo. Accepted value: this-week, this-month, this-quarter, this-year, this-financial-year, yesterday, last-week, last-week-sunday, last-7-days, last-10-days, last-30-days, last-4-weeks, last-12-weeks, last-3-months, last-6-months, last-12-months, last-month, last-quarter, last-year, last-financial-year","schema":{"type":"string"}},{"name":"DateFrom","in":"query","description":"Report interval start date. Required when no IntervalType specified.","schema":{"type":"string","format":"date-time"}},{"name":"DateTo","in":"query","description":"Report interval end date. Required when no IntervalType specified.","schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TimeInGeofenceReportEntry"}}},"application/json;IEEE754Compatible=false":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TimeInGeofenceReportEntry"}}},"application/json;IEEE754Compatible=true":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TimeInGeofenceReportEntry"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TimeInGeofenceReportEntry"}}},"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TimeInGeofenceReportEntry"}}},"application/octet-stream":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TimeInGeofenceReportEntry"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TimeInGeofenceReportEntry"}}},"text/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TimeInGeofenceReportEntry"}}},"text/csv":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TimeInGeofenceReportEntry"}}}}}}}}},"components":{"schemas":{"TimeInGeofenceReportEntry":{"type":"object","properties":{"GeofenceName":{"type":"string","description":"Geofence name","nullable":true},"TenantName":{"type":"string","description":"Tenant name","nullable":true},"GroupName":{"type":"string","description":"Group name","nullable":true},"DeviceFriendlyName":{"type":"string","description":"Device friendly name","nullable":true},"StartDriver":{"type":"string","description":"Driver name when geofence entered","nullable":true},"EndDriver":{"type":"string","description":"Drive name when geofence left","nullable":true},"StartTimeLocal":{"type":"string","description":"Enter geofence time (local)","format":"date-time"},"StartTimeUtc":{"type":"string","description":"Enter geofence time (UTC)","format":"date-time"},"StartAddress":{"type":"string","description":"Enter geofence address","nullable":true},"EndTimeLocal":{"type":"string","description":"Leave geofence time (local)","format":"date-time","nullable":true},"EndTimeUtc":{"type":"string","description":"Leave geofence time (UTC)","format":"date-time","nullable":true},"EndAddress":{"type":"string","description":"Leave geofence address","nullable":true},"PeriodSeconds":{"type":"integer","description":"Interval inside geofence in seconds","format":"int32","nullable":true},"DeltaSeconds":{"type":"integer","description":"Relative time inside geofence within report query parameter interval","format":"int32"},"IsPending":{"type":"boolean","description":"True if a device is still inside a geofence when report data generated"}},"additionalProperties":false}}}}
```

## GET /V2/{tenantVarCode}/reports/TripReport

> Returns trip report data

```json
{"openapi":"3.0.4","info":{"title":"GAP REST API Documentation V2","version":"v2"},"tags":[{"name":"Reports"}],"paths":{"/V2/{tenantVarCode}/reports/TripReport":{"get":{"tags":["Reports"],"summary":"Returns trip report data","parameters":[{"name":"tenantVarCode","in":"path","description":"Tenant Var Code","required":true,"schema":{"type":"string"}},{"name":"Subtenants","in":"query","description":"When 'subtenants=true' result contains report data for the tenant and all subtenants","schema":{"type":"boolean"}},{"name":"GroupIds","in":"query","description":"Group Ids","schema":{"type":"array","items":{"type":"string"}}},{"name":"DeviceTypes","in":"query","description":"Device Types","schema":{"type":"array","items":{"type":"string"}}},{"name":"DeviceStatus","in":"query","description":"Device Status, optional. Accepted values: \"Active\", \"Inactive\".","schema":{"type":"string"}},{"name":"VehicleTypeTags","in":"query","description":"\"VehicleType\" tag values","schema":{"type":"array","items":{"type":"string"}}},{"name":"DeviceIds","in":"query","description":"Device Ids","schema":{"type":"array","items":{"type":"string"}}},{"name":"UserIds","in":"query","description":"User Ids","schema":{"type":"array","items":{"type":"string"}}},{"name":"CollectionId","in":"query","description":"Cross tenant collection id. Report data is based on the collection (groups and devices related query parameters are ignored).","schema":{"type":"string"}},{"name":"IntervalType","in":"query","description":"Pre-defined custom interval, can be used instead of DateFrom and DateTo. Accepted value: this-week, this-month, this-quarter, this-year, this-financial-year, yesterday, last-week, last-week-sunday, last-7-days, last-10-days, last-30-days, last-4-weeks, last-12-weeks, last-3-months, last-6-months, last-12-months, last-month, last-quarter, last-year, last-financial-year","schema":{"type":"string"}},{"name":"DateFrom","in":"query","description":"Report interval start date. Required when no IntervalType specified.","schema":{"type":"string","format":"date-time"}},{"name":"DateTo","in":"query","description":"Report interval end date. Required when no IntervalType specified.","schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TripReportEntry"}}},"application/json;IEEE754Compatible=false":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TripReportEntry"}}},"application/json;IEEE754Compatible=true":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TripReportEntry"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TripReportEntry"}}},"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TripReportEntry"}}},"application/octet-stream":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TripReportEntry"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TripReportEntry"}}},"text/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TripReportEntry"}}},"text/csv":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TripReportEntry"}}}}}}}}},"components":{"schemas":{"TripReportEntry":{"type":"object","properties":{"TenantVarCode":{"type":"string","description":"Tenant Var code","nullable":true},"JourneyId":{"type":"string","description":"Journey Id","nullable":true},"UserId":{"type":"string","description":"User Id","nullable":true},"DeviceId":{"type":"string","description":"Device Id","nullable":true},"TenantName":{"type":"string","description":"Tenant name","nullable":true},"GroupName":{"type":"string","description":"Group name","nullable":true},"DeviceFriendlyName":{"type":"string","description":"Device friendly name","nullable":true},"UserFirstName":{"type":"string","description":"User first name","nullable":true},"UserLastName":{"type":"string","description":"User last name","nullable":true},"StartTimeLocal":{"type":"string","description":"Trip start time (local)","format":"date-time"},"StartTimeUtc":{"type":"string","description":"Trip start time (UTC)","format":"date-time"},"StartLocationName":{"type":"string","description":"Start geofence names","nullable":true},"StartLatitude":{"type":"number","description":"Start latitude","format":"double","nullable":true},"StartLongitude":{"type":"number","description":"Start longitude","format":"double","nullable":true},"StartAddress":{"type":"string","description":"Start address","nullable":true},"EndTimeLocal":{"type":"string","description":"Trip end time (local)","format":"date-time","nullable":true},"EndTimeUtc":{"type":"string","description":"Trip end time (UTC)","format":"date-time","nullable":true},"EndLocationName":{"type":"string","description":"End geofence names","nullable":true},"EndLatitude":{"type":"number","description":"End latitude","format":"double","nullable":true},"EndLongitude":{"type":"number","description":"End longitude","format":"double","nullable":true},"EndAddress":{"type":"string","description":"End address","nullable":true},"DistanceKm":{"type":"number","description":"Distance Km","format":"double"},"DrivingSeconds":{"type":"integer","description":"Driving duration in seconds","format":"int32"}},"additionalProperties":false}}}}
```

## GET /V2/{tenantVarCode}/reports/UserLoginReport

> Returns user login report

```json
{"openapi":"3.0.4","info":{"title":"GAP REST API Documentation V2","version":"v2"},"tags":[{"name":"Reports"}],"paths":{"/V2/{tenantVarCode}/reports/UserLoginReport":{"get":{"tags":["Reports"],"summary":"Returns user login report","parameters":[{"name":"tenantVarCode","in":"path","description":"Tenant Var Code","required":true,"schema":{"type":"string"}},{"name":"Subtenants","in":"query","description":"When 'subtenants=true' result contains report data for the tenant and all subtenants","schema":{"type":"boolean"}},{"name":"GroupIds","in":"query","description":"Group Ids","schema":{"type":"array","items":{"type":"string"}}},{"name":"DeviceTypes","in":"query","description":"Device Types","schema":{"type":"array","items":{"type":"string"}}},{"name":"DeviceStatus","in":"query","description":"Device Status, optional. Accepted values: \"Active\", \"Inactive\".","schema":{"type":"string"}},{"name":"VehicleTypeTags","in":"query","description":"\"VehicleType\" tag values","schema":{"type":"array","items":{"type":"string"}}},{"name":"DeviceIds","in":"query","description":"Device Ids","schema":{"type":"array","items":{"type":"string"}}},{"name":"UserIds","in":"query","description":"User Ids","schema":{"type":"array","items":{"type":"string"}}},{"name":"CollectionId","in":"query","description":"Cross tenant collection id. Report data is based on the collection (groups and devices related query parameters are ignored).","schema":{"type":"string"}},{"name":"IntervalType","in":"query","description":"Pre-defined custom interval, can be used instead of DateFrom and DateTo. Accepted value: this-week, this-month, this-quarter, this-year, this-financial-year, yesterday, last-week, last-week-sunday, last-7-days, last-10-days, last-30-days, last-4-weeks, last-12-weeks, last-3-months, last-6-months, last-12-months, last-month, last-quarter, last-year, last-financial-year","schema":{"type":"string"}},{"name":"DateFrom","in":"query","description":"Report interval start date. Required when no IntervalType specified.","schema":{"type":"string","format":"date-time"}},{"name":"DateTo","in":"query","description":"Report interval end date. Required when no IntervalType specified.","schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UserLoginReportEntry"}}},"application/json;IEEE754Compatible=false":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UserLoginReportEntry"}}},"application/json;IEEE754Compatible=true":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UserLoginReportEntry"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UserLoginReportEntry"}}},"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UserLoginReportEntry"}}},"application/octet-stream":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UserLoginReportEntry"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UserLoginReportEntry"}}},"text/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UserLoginReportEntry"}}},"text/csv":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UserLoginReportEntry"}}}}}}}}},"components":{"schemas":{"UserLoginReportEntry":{"type":"object","properties":{"DateLocal":{"type":"string","description":"Logins date (local - tenant time zone)","format":"date-time"},"LoginsCount":{"type":"integer","description":"Number of user logins to the GAP portal per day","format":"int32"}},"additionalProperties":false}}}}
```

## GET /V2/{tenantVarCode}/reports/UsersOverviewReport

> Returns users overview report data

```json
{"openapi":"3.0.4","info":{"title":"GAP REST API Documentation V2","version":"v2"},"tags":[{"name":"Reports"}],"paths":{"/V2/{tenantVarCode}/reports/UsersOverviewReport":{"get":{"tags":["Reports"],"summary":"Returns users overview report data","parameters":[{"name":"tenantVarCode","in":"path","description":"Tenant Var Code","required":true,"schema":{"type":"string"}},{"name":"Subtenants","in":"query","description":"When 'subtenants=true' result contains report data for the tenant and all subtenants","schema":{"type":"boolean"}},{"name":"GroupIds","in":"query","description":"Group Ids","schema":{"type":"array","items":{"type":"string"}}},{"name":"DeviceTypes","in":"query","description":"Device Types","schema":{"type":"array","items":{"type":"string"}}},{"name":"DeviceStatus","in":"query","description":"Device Status, optional. Accepted values: \"Active\", \"Inactive\".","schema":{"type":"string"}},{"name":"VehicleTypeTags","in":"query","description":"\"VehicleType\" tag values","schema":{"type":"array","items":{"type":"string"}}},{"name":"DeviceIds","in":"query","description":"Device Ids","schema":{"type":"array","items":{"type":"string"}}},{"name":"UserIds","in":"query","description":"User Ids","schema":{"type":"array","items":{"type":"string"}}},{"name":"CollectionId","in":"query","description":"Cross tenant collection id. Report data is based on the collection (groups and devices related query parameters are ignored).","schema":{"type":"string"}},{"name":"IntervalType","in":"query","description":"Pre-defined custom interval, can be used instead of DateFrom and DateTo. Accepted value: this-week, this-month, this-quarter, this-year, this-financial-year, yesterday, last-week, last-week-sunday, last-7-days, last-10-days, last-30-days, last-4-weeks, last-12-weeks, last-3-months, last-6-months, last-12-months, last-month, last-quarter, last-year, last-financial-year","schema":{"type":"string"}},{"name":"DateFrom","in":"query","description":"Report interval start date. Required when no IntervalType specified.","schema":{"type":"string","format":"date-time"}},{"name":"DateTo","in":"query","description":"Report interval end date. Required when no IntervalType specified.","schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UsersOverviewReportEntry"}}},"application/json;IEEE754Compatible=false":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UsersOverviewReportEntry"}}},"application/json;IEEE754Compatible=true":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UsersOverviewReportEntry"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UsersOverviewReportEntry"}}},"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UsersOverviewReportEntry"}}},"application/octet-stream":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UsersOverviewReportEntry"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UsersOverviewReportEntry"}}},"text/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UsersOverviewReportEntry"}}},"text/csv":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UsersOverviewReportEntry"}}}}}}}}},"components":{"schemas":{"UsersOverviewReportEntry":{"type":"object","properties":{"FirstName":{"type":"string","description":"User first name","nullable":true},"Surname":{"type":"string","description":"User surname","nullable":true},"EmailAddress":{"type":"string","description":"Email address (username)","nullable":true},"Citizenship":{"type":"string","description":"Citizenship","nullable":true},"UserRole":{"type":"string","description":"User role","nullable":true},"PhoneNumbers":{"type":"string","description":"Phone numbers","nullable":true},"LastLoggedInDate":{"type":"string","description":"Last logged in date (UTC)","format":"date-time","nullable":true},"CreatedDate":{"type":"string","description":"User created date (UTC)","format":"date-time","nullable":true},"Status":{"type":"string","description":"User status (Enabled, Locked Out, Disabled)","nullable":true}},"additionalProperties":false}}}}
```
