/ImmediateReport

The ImmediateReport methods allow you to request ImmediateReports for your account. Unlike many of the other methods in this API, ImmediateReports does not directly access database objects. Instead, it builds and returns datasets of other database objects, such as Device Location information. As such, some of its methods may not abide by standard REST practices.

The ImmediateReport methods serve data for these three original reports: 'history24', 'historyfromto', and 'milesbystate'.

The ImmediateReport Methods

The following list provides a reference for all valid /ImmediateReport HTTP requests.

• GET v1/ImmediateReport/{id}?from={from}&to={to}&devices={devices}&interval={interval}&account={account}

  Summary: Retrieve a report that is run immediately and returned as soon as possible. These reports are typically limited to a small range or timespan.

  Returns:

  Parameters:

  • id: Name of the report to run. Right now the valid values are 'history24', 'historyfromto', and 'milesbystate' (FromUri)
  • from: The DateTime to begin a "historyfromto" and "milesbystate" report. Optional for "historyfromto". Required for "milesbystate". (FromUri)
  • to: The DateTime to end a "historyfromto" and "milesbystate" report. Optional for "historyfromto" default is present day. Required for "milesbystate" (FromUri)
  • devices: A comma-separated list of DeviceIds to lookup for a report. If this is not specified, reports will run for all devices visible to the account. Optional for 'historyfromto' and 'history24'. Required for 'milesbystate'. (FromUri)
  • interval: (Optional) An interval value, in seconds, for the "historyfromto" and "history24" reports. If provided, results will be filtered for the closest historical record to every [Interval] seconds from the beginning to the end of the report. (FromUri)
  • account: (Optional) If this parameter is included, the method will be run on behalf of the specified child Account (if valid). (FromUri)

• POST v1/ImmediateReport/{id}?from={from}&to={to}&interval={interval}&account={account}

  Summary: Retrieve a report that requires a large number of parameters. Place these parameters in the message body in standard JSON format.

  Returns: The requested report, in JSON format

  Parameters:

  • id: Name of the report to run. Right now the valid values are 'history24', 'historyfromto', and 'milesbystate' (FromUri)
  • devices: A comma-separated list of DeviceIds to lookup for a report. If this is not specified, reports will run for all devices visible to the account. Optional for 'historyfromto' and 'history24'. Required for 'milesbystate'. (FromBody)
  • from: The DateTime to begin a "historyfromto" and "milesbystate" report. Optional for "historyfromto". Required for "milesbystate". (FromUri)
  • to: The DateTime to end a "historyfromto" and "milesbystate" report. Optional for "historyfromto" default is present day. Required for "milesbystate" (FromUri)
  • interval: (Optional) An interval value, in seconds, for the "historyfromto" and "history24" reports. If provided, results will be filtered for the closest historical record to every [Interval] seconds from the beginning to the end of the report. (FromUri)
  • account: (Optional) If this parameter is included, the method will be run on behalf of the specified child Account (if valid). (FromUri)