Contact us Login LIVE DEMO FREE TRIAL

generate(…)

Requests a report generation with the specified parameters.

required subuser rights: reports

parameters:

name description type
from A string containing date/time in “yyyy-MM-dd HH:mm:ss” format (in user’s timezone) String
to A string containing date/time in “yyyy-MM-dd HH:mm:ss” format (in user’s timezone). Specified date must be after “from” date String
geocoder Which geocoder to use. See geocoder/ String
trackers list of tracker’s ids to be included in report [int]
time_filter An object which contains everyday time and weekday limits for processed data, e.g. {“to”:”18:00″, “from”:”12:00″, “weekdays”:[1,2,3,4,5]} Object
plugin a plugin parameter object (see below) JSON object

Parameter object fields:

Part of parameters are plugin-specific. See “Tracker report plugins” section.
Common parameters are:

name description type
plugin_id An id of a tracker report plugin which will be used to generate report. Int

plugin example:

plugin:{"details_interval_minutes":60,"plugin_id":9,"graph_type":"time","smoothing":false,"sensors":[{"tracker_id":tracker_id,"sensor_id":sensor_id}]}

return:

{
    "success": true,
    "id": 222 // (int) id of the report queued for generation. 
              // Can be used to request report generation status and to retrieve generated report
}

errors:

  • 211 (Requested time span is too big) – interval from ‘from’ to ‘to’ is bigger then max allowed time span (see response)
{
    "success": false,
    "status": {
        "code": 211,
        "description": "Requested time span is too big"
    },
    "max_time_span": "P90D" // ISO-8601 interval
}
  • 217 (List contains nonexistent entities) – when one or more of tracker ids belong to nonexistent tracker (or to a tracker belonging to different user)
  • 222 (Plugin not found) – when specified report plugin is not found
  • 236 (Feature unavailable due to tariff restrictions) – when one of the trackers has tariff with disabled reports – (“has_reports” is false)

If you have more questions please contact our support team

Contacts

USA: +1 858 815 9045

Mexico: +52 334 1642158

UK: +44 808 1641499

Germany: +49 1573 5988250

Russia: +7 495 223 0427

Log in

Loading...

We use сookies to improve our website, products and related services, analyze site traffic, and serve targeted advertisements. If you continue to use our services, you consent to our use of сookies. Read more