Alerts report

post

https://services.azuga.com/reports/v3/reports/allalertreport

This API allows the user to generate a detailed report on all alert types.

Body Params

startDate

string

required

The start date of the Alerts reports you want to generate.

endDate

string

required

The end date of the Alerts reports you want to generate.

alertTypeId

int32

required

Defaults to -1

Unique Identifier to identify alert types. The alert type ID for each of the alerts is below: * all alerts= -1 * Speeding = 1 * Stop Time = 2 * Idling = 3 * Device_Plugged_In/Removed = 4 * Unauthorized_Vehicle_Usage = 6 * Hard Braking = 7 * Sudden Acceleration = 8 * Check Engine Light = 9 * Vehicle Not Tracking = 10 * Scheduled Maintenance = 11 * Low Fuel = 13 * Ignition = 14 * Posted Speed Limit = 15 * Low Battery = 16 * Cornering = 17 * Panic = 18 * Geofence = NULL * Unknown_Driver = 20 * Unauthorized_Occupant_Count = 21 * Beacon_Unused = 22

browserTimezone

string

required

Defaults to US/Eastern

Local timezone of the user. The following timezones are valid: Canada/Central : CDT/CST ; US/Pacific : PDT/PST ; US/Eastern : EDT/EST ; US/Mountain : MDT/MST ; Etc/Greenwich : GMT ; Asia/Calcutta : IST ; US/Hawaii : HDT/HST ; US/Alaska : AKDT/AKST ; America/Phoenix : MST ; Mexico/General : CST/CDT ; Mexico/BajaSur : MST/MDT ; Mexico/BajaNorte : PST/PDT ; Canada/Newfoundland : NST/NDT ; America/Puerto_Rico : AST ; America/Chicago : CDT/CST ; America/Argentina/Buenos_Aires : ART

filter

object

required

Allows the user to add various filters to the report. orFilter and matchFilter are the valid ones and this field is mandatory.

index

int32

Defaults to 0

An integer indicating the page number

size

int32

Defaults to 100

The number of search results on a page.

desc

boolean

Boolean value denoting the search results order (descending or ascending order)

sortField

string

Adds a sorting field to help users sort the report. The sorting field used here is the date-time(dateTime) and zone.

Response

200200