API GPS Tracking Software. White Label

Report

GET /get_reports

Definition

Query String

lang	string Validation default: en	required
user_api_hash	string Validation default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS	required

Responses application/json

200 400 401 500

Schema
Example
expand all

object
status	integer	optional
items	object	optional
reports	object	optional
total	integer Validation {pagination}	optional
per_page	integer Validation {pagination}	optional
current_page	Validation {pagination}	optional
last_page	integer Validation {pagination}	optional
from	integer Validation {pagination}	optional
to	integer Validation {pagination}	optional
next_page_url	null string Validation {pagination}	optional
prev_page_url	null string Validation {pagination}
url	string Validation {pagination}	optional
data	array[object] Validation {report}	optional
id	integer string	optional
user_id	integer string	optional
title	string	optional
type	integer string	optional
format	string	optional
show_addresses	null integer	optional
zones_instead	null integer	optional
stops	integer string	optional
speed_limit	null number	optional
daily	null integer	optional
weekly	null integer	optional
email	string	optional
weekly_email_sent	string	optional
daily_email_sent	string	optional
devices	array[integer]	optional
geofences	array[integer]	optional
types	array[object]	optional
id	integer	optional
title	string	optional

{
  "status": 1,
  "items": {
    "reports": {
      "total": 1,
      "per_page": 10,
      "current_page": 1,
      "last_page": 1,
      "next_page_url": null,
      "prev_page_url": null,
      "from": 1,
      "to": 1,
      "data": [
        {
          "id": "2",
          "user_id": "2",
          "title": "Report title",
          "type": "4",
          "format": "html",
          "show_addresses": null,
          "zones_instead": null,
          "stops": "1",
          "speed_limit": null,
          "daily": null,
          "weekly": null,
          "email": "",
          "weekly_email_sent": "2016-06-27 00:00:00",
          "daily_email_sent": "2016-06-26 00:00:00",
          "devices": [
            3
          ],
          "geofences": []
        }
      ],
      "url": "/api/get_reports"
    },
    "types": [
      {
        "id": 1,
        "title": "General information"
      },
      {
        "id": 2,
        "title": "General information (merged)"
      },
      {
        "id": 3,
        "title": "Drives and stops"
      },
      {
        "id": 18,
        "title": "Drives and stops / Geofences"
      },
      {
        "id": 4,
        "title": "Travel sheet"
      },
      {
        "id": 5,
        "title": "Overspeed"
      },
      {
        "id": 6,
        "title": "Underspeed"
      },
      {
        "id": 7,
        "title": "Geofence in/out"
      },
      {
        "id": 15,
        "title": "Geofence in/out 24 hour mode"
      },
      {
        "id": 8,
        "title": "Events"
      },
      {
        "id": 10,
        "title": "Fuel level"
      },
      {
        "id": 11,
        "title": "Fuel fillings"
      },
      {
        "id": 12,
        "title": "Fuel thefts"
      },
      {
        "id": 13,
        "title": "Temperature"
      },
      {
        "id": 14,
        "title": "RAG"
      }
    ]
  }
}

Schema
Example
expand all

object
status	integer	optional
errors	object	optional

{
  "status": 0,
  "errors": {}
}

Schema
Example
expand all

object
status	integer	optional
error	string	optional

{
  "status": 0,
  "error": "No language selected."
}

Schema
Example
expand all

GET /get_reports_types

Definition

Query String

lang	string Validation default: en	required
user_api_hash	string Validation default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS	required

Responses

200 400 401 500

Schema
Example
expand all

object
items	array[object] Validation {reportType}	optional
type	integer	optional
name	string	optional
formats	array[string]	optional
fields	array[string]	optional
parameters	null array[object]	optional
title	string	optional
name	string	optional
type	string	optional
default	null integer string	optional
options	null array[object]	optional
id	integer string	optional
title	string	optional
validation	null string	optional
status	integer	optional

{
  "1": {
    "type": 1,
    "name": "General information",
    "formats": [
      "html",
      "xls",
      "pdf",
      "pdf_land"
    ],
    "fields": {
      "1": "speed_limit",
      "2": "stops"
    }
  },
  "2": {
    "type": 2,
    "name": "General information (merged)",
    "formats": [
      "html",
      "xls",
      "pdf",
      "pdf_land"
    ],
    "fields": {
      "1": "speed_limit",
      "2": "stops"
    }
  },
  "3": {
    "type": 3,
    "name": "Drives and stops",
    "formats": [
      "html",
      "xls",
      "pdf",
      "pdf_land"
    ],
    "fields": {
      "2": "stops",
      "3": "show_addresses",
      "4": "zones_instead"
    }
  },
  "4": {
    "type": 4,
    "name": "Travel sheet",
    "formats": [
      "html",
      "xls",
      "pdf",
      "pdf_land"
    ],
    "fields": {
      "2": "stops",
      "3": "show_addresses",
      "4": "zones_instead"
    }
  },
  "5": {
    "type": 5,
    "name": "Overspeed",
    "formats": [
      "html",
      "xls",
      "pdf",
      "pdf_land"
    ],
    "fields": {
      "1": "speed_limit",
      "3": "show_addresses",
      "4": "zones_instead"
    }
  },
  "6": {
    "type": 6,
    "name": "Underspeed",
    "formats": [
      "html",
      "xls",
      "pdf",
      "pdf_land"
    ],
    "fields": {
      "1": "speed_limit",
      "3": "show_addresses",
      "4": "zones_instead"
    }
  },
  "7": {
    "type": 7,
    "name": "Geofence in/out",
    "formats": [
      "html",
      "xls",
      "pdf",
      "pdf_land"
    ],
    "fields": {
      "0": "geofences",
      "3": "show_addresses",
      "4": "zones_instead"
    }
  },
  "8": {
    "type": 8,
    "name": "Events",
    "formats": [
      "html",
      "xls",
      "pdf",
      "pdf_land"
    ],
    "fields": {
      "3": "show_addresses",
      "4": "zones_instead"
    }
  },
  "10": {
    "type": 10,
    "name": "Fuel level",
    "formats": [
      "html"
    ],
    "fields": {
      "3": "show_addresses",
      "4": "zones_instead"
    }
  },
  "11": {
    "type": 11,
    "name": "Fuel fillings",
    "formats": [
      "html",
      "xls",
      "pdf",
      "pdf_land"
    ],
    "fields": {
      "3": "show_addresses",
      "4": "zones_instead"
    }
  },
  "12": {
    "type": 12,
    "name": "Fuel thefts",
    "formats": [
      "html",
      "xls",
      "pdf",
      "pdf_land"
    ],
    "fields": {
      "3": "show_addresses",
      "4": "zones_instead"
    }
  },
  "13": {
    "type": 13,
    "name": "Temperature",
    "formats": [
      "html"
    ],
    "fields": {
      "3": "show_addresses",
      "4": "zones_instead"
    }
  },
  "14": {
    "type": 14,
    "name": "RAG",
    "formats": [
      "html",
      "xls",
      "pdf",
      "pdf_land"
    ],
    "fields": {
      "3": "show_addresses",
      "4": "zones_instead"
    }
  },
  "15": {
    "type": 15,
    "name": "Geofence in/out 24 hour mode",
    "formats": [
      "html",
      "xls",
      "pdf",
      "pdf_land"
    ],
    "fields": [
      "geofences",
      "speed_limit",
      "stops",
      "show_addresses",
      "zones_instead"
    ]
  },
  "16": {
    "type": 16,
    "name": "General information (merged) custom",
    "formats": [
      "html",
      "xls",
      "pdf",
      "pdf_land"
    ],
    "fields": {
      "1": "speed_limit",
      "2": "stops"
    }
  },
  "18": {
    "type": 18,
    "name": "Drives and stops / Geofences",
    "formats": [
      "html",
      "xls",
      "pdf",
      "pdf_land"
    ],
    "fields": {
      "1": "speed_limit",
      "3": "show_addresses",
      "4": "zones_instead"
    }
  },
  "19": {
    "type": 19,
    "name": "Drives and stops / Drivers",
    "formats": [
      "html",
      "xls",
      "pdf",
      "pdf_land"
    ],
    "fields": [
      "geofences",
      "speed_limit",
      "stops",
      "show_addresses",
      "zones_instead"
    ]
  },
  "20": {
    "type": 20,
    "name": "Geofence in/out (Ignition ON/OFF)",
    "formats": [
      "html",
      "xls",
      "pdf",
      "pdf_land"
    ],
    "fields": [
      "geofences",
      "speed_limit",
      "stops",
      "show_addresses",
      "zones_instead"
    ]
  },
  "21": {
    "type": 21,
    "name": "Drives and stops / Drivers (Business)",
    "formats": [
      "html",
      "xls",
      "pdf",
      "pdf_land"
    ],
    "fields": [
      "geofences",
      "speed_limit",
      "stops",
      "show_addresses",
      "zones_instead"
    ]
  },
  "22": {
    "type": 22,
    "name": "Drives and stops / Drivers (Private)",
    "formats": [
      "html",
      "xls",
      "pdf",
      "pdf_land"
    ],
    "fields": [
      "geofences",
      "speed_limit",
      "stops",
      "show_addresses",
      "zones_instead"
    ]
  },
  "23": {
    "type": 23,
    "name": "RAG / Seatbelt",
    "formats": [
      "html",
      "xls",
      "pdf",
      "pdf_land"
    ],
    "fields": {
      "3": "show_addresses",
      "4": "zones_instead"
    }
  },
  "24": {
    "type": 24,
    "name": "Birla Custom",
    "formats": [
      "html",
      "xls",
      "pdf",
      "pdf_land"
    ],
    "fields": [
      "geofences",
      "speed_limit",
      "stops",
      "show_addresses",
      "zones_instead"
    ]
  },
  "25": {
    "type": 25,
    "name": "Object history",
    "formats": [
      "html",
      "xls",
      "pdf",
      "pdf_land"
    ],
    "fields": [
      "geofences",
      "speed_limit",
      "stops",
      "show_addresses",
      "zones_instead"
    ]
  },
  "27": {
    "type": 27,
    "name": "Automon Custom",
    "formats": [
      "html",
      "xls",
      "pdf",
      "pdf_land"
    ],
    "fields": [
      "geofences",
      "speed_limit",
      "stops",
      "show_addresses",
      "zones_instead"
    ]
  },
  "28": {
    "type": 28,
    "name": "Geofence in/out (Shift)",
    "formats": [
      "html",
      "xls",
      "pdf",
      "pdf_land"
    ],
    "fields": [
      "geofences"
    ],
    "parameters": [
      {
        "title": "Shift start",
        "name": "shift_start",
        "type": "select",
        "default": "08:00",
        "options": [
          {
            "id": "00:00",
            "title": "00:00"
          },
          {
            "id": "00:15",
            "title": "00:15"
          },
          {
            "id": "00:30",
            "title": "00:30"
          },
          {
            "id": "00:45",
            "title": "00:45"
          },
          {
            "id": "01:00",
            "title": "01:00"
          },
          {
            "id": "01:15",
            "title": "01:15"
          },
          {
            "id": "01:30",
            "title": "01:30"
          },
          {
            "id": "01:45",
            "title": "01:45"
          },
          {
            "id": "02:00",
            "title": "02:00"
          },
          {
            "id": "02:15",
            "title": "02:15"
          },
          {
            "id": "02:30",
            "title": "02:30"
          },
          {
            "id": "02:45",
            "title": "02:45"
          },
          {
            "id": "03:00",
            "title": "03:00"
          },
          {
            "id": "03:15",
            "title": "03:15"
          },
          {
            "id": "03:30",
            "title": "03:30"
          },
          {
            "id": "03:45",
            "title": "03:45"
          },
          {
            "id": "04:00",
            "title": "04:00"
          },
          {
            "id": "04:15",
            "title": "04:15"
          },
          {
            "id": "04:30",
            "title": "04:30"
          },
          {
            "id": "04:45",
            "title": "04:45"
          },
          {
            "id": "05:00",
            "title": "05:00"
          },
          {
            "id": "05:15",
            "title": "05:15"
          },
          {
            "id": "05:30",
            "title": "05:30"
          },
          {
            "id": "05:45",
            "title": "05:45"
          },
          {
            "id": "06:00",
            "title": "06:00"
          },
          {
            "id": "06:15",
            "title": "06:15"
          },
          {
            "id": "06:30",
            "title": "06:30"
          },
          {
            "id": "06:45",
            "title": "06:45"
          },
          {
            "id": "07:00",
            "title": "07:00"
          },
          {
            "id": "07:15",
            "title": "07:15"
          },
          {
            "id": "07:30",
            "title": "07:30"
          },
          {
            "id": "07:45",
            "title": "07:45"
          },
          {
            "id": "08:00",
            "title": "08:00"
          },
          {
            "id": "08:15",
            "title": "08:15"
          },
          {
            "id": "08:30",
            "title": "08:30"
          },
          {
            "id": "08:45",
            "title": "08:45"
          },
          {
            "id": "09:00",
            "title": "09:00"
          },
          {
            "id": "09:15",
            "title": "09:15"
          },
          {
            "id": "09:30",
            "title": "09:30"
          },
          {
            "id": "09:45",
            "title": "09:45"
          },
          {
            "id": "10:00",
            "title": "10:00"
          },
          {
            "id": "10:15",
            "title": "10:15"
          },
          {
            "id": "10:30",
            "title": "10:30"
          },
          {
            "id": "10:45",
            "title": "10:45"
          },
          {
            "id": "11:00",
            "title": "11:00"
          },
          {
            "id": "11:15",
            "title": "11:15"
          },
          {
            "id": "11:30",
            "title": "11:30"
          },
          {
            "id": "11:45",
            "title": "11:45"
          },
          {
            "id": "12:00",
            "title": "12:00"
          },
          {
            "id": "12:15",
            "title": "12:15"
          },
          {
            "id": "12:30",
            "title": "12:30"
          },
          {
            "id": "12:45",
            "title": "12:45"
          },
          {
            "id": "13:00",
            "title": "13:00"
          },
          {
            "id": "13:15",
            "title": "13:15"
          },
          {
            "id": "13:30",
            "title": "13:30"
          },
          {
            "id": "13:45",
            "title": "13:45"
          },
          {
            "id": "14:00",
            "title": "14:00"
          },
          {
            "id": "14:15",
            "title": "14:15"
          },
          {
            "id": "14:30",
            "title": "14:30"
          },
          {
            "id": "14:45",
            "title": "14:45"
          },
          {
            "id": "15:00",
            "title": "15:00"
          },
          {
            "id": "15:15",
            "title": "15:15"
          },
          {
            "id": "15:30",
            "title": "15:30"
          },
          {
            "id": "15:45",
            "title": "15:45"
          },
          {
            "id": "16:00",
            "title": "16:00"
          },
          {
            "id": "16:15",
            "title": "16:15"
          },
          {
            "id": "16:30",
            "title": "16:30"
          },
          {
            "id": "16:45",
            "title": "16:45"
          },
          {
            "id": "17:00",
            "title": "17:00"
          },
          {
            "id": "17:15",
            "title": "17:15"
          },
          {
            "id": "17:30",
            "title": "17:30"
          },
          {
            "id": "17:45",
            "title": "17:45"
          },
          {
            "id": "18:00",
            "title": "18:00"
          },
          {
            "id": "18:15",
            "title": "18:15"
          },
          {
            "id": "18:30",
            "title": "18:30"
          },
          {
            "id": "18:45",
            "title": "18:45"
          },
          {
            "id": "19:00",
            "title": "19:00"
          },
          {
            "id": "19:15",
            "title": "19:15"
          },
          {
            "id": "19:30",
            "title": "19:30"
          },
          {
            "id": "19:45",
            "title": "19:45"
          },
          {
            "id": "20:00",
            "title": "20:00"
          },
          {
            "id": "20:15",
            "title": "20:15"
          },
          {
            "id": "20:30",
            "title": "20:30"
          },
          {
            "id": "20:45",
            "title": "20:45"
          },
          {
            "id": "21:00",
            "title": "21:00"
          },
          {
            "id": "21:15",
            "title": "21:15"
          },
          {
            "id": "21:30",
            "title": "21:30"
          },
          {
            "id": "21:45",
            "title": "21:45"
          },
          {
            "id": "22:00",
            "title": "22:00"
          },
          {
            "id": "22:15",
            "title": "22:15"
          },
          {
            "id": "22:30",
            "title": "22:30"
          },
          {
            "id": "22:45",
            "title": "22:45"
          },
          {
            "id": "23:00",
            "title": "23:00"
          },
          {
            "id": "23:15",
            "title": "23:15"
          },
          {
            "id": "23:30",
            "title": "23:30"
          },
          {
            "id": "23:45",
            "title": "23:45"
          }
        ],
        "validation": "required|date_format:H:i"
      },
      {
        "title": "Shift finish",
        "name": "shift_finish",
        "type": "select",
        "default": "17:00",
        "options": [
          {
            "id": "00:00",
            "title": "00:00"
          },
          {
            "id": "00:15",
            "title": "00:15"
          },
          {
            "id": "00:30",
            "title": "00:30"
          },
          {
            "id": "00:45",
            "title": "00:45"
          },
          {
            "id": "01:00",
            "title": "01:00"
          },
          {
            "id": "01:15",
            "title": "01:15"
          },
          {
            "id": "01:30",
            "title": "01:30"
          },
          {
            "id": "01:45",
            "title": "01:45"
          },
          {
            "id": "02:00",
            "title": "02:00"
          },
          {
            "id": "02:15",
            "title": "02:15"
          },
          {
            "id": "02:30",
            "title": "02:30"
          },
          {
            "id": "02:45",
            "title": "02:45"
          },
          {
            "id": "03:00",
            "title": "03:00"
          },
          {
            "id": "03:15",
            "title": "03:15"
          },
          {
            "id": "03:30",
            "title": "03:30"
          },
          {
            "id": "03:45",
            "title": "03:45"
          },
          {
            "id": "04:00",
            "title": "04:00"
          },
          {
            "id": "04:15",
            "title": "04:15"
          },
          {
            "id": "04:30",
            "title": "04:30"
          },
          {
            "id": "04:45",
            "title": "04:45"
          },
          {
            "id": "05:00",
            "title": "05:00"
          },
          {
            "id": "05:15",
            "title": "05:15"
          },
          {
            "id": "05:30",
            "title": "05:30"
          },
          {
            "id": "05:45",
            "title": "05:45"
          },
          {
            "id": "06:00",
            "title": "06:00"
          },
          {
            "id": "06:15",
            "title": "06:15"
          },
          {
            "id": "06:30",
            "title": "06:30"
          },
          {
            "id": "06:45",
            "title": "06:45"
          },
          {
            "id": "07:00",
            "title": "07:00"
          },
          {
            "id": "07:15",
            "title": "07:15"
          },
          {
            "id": "07:30",
            "title": "07:30"
          },
          {
            "id": "07:45",
            "title": "07:45"
          },
          {
            "id": "08:00",
            "title": "08:00"
          },
          {
            "id": "08:15",
            "title": "08:15"
          },
          {
            "id": "08:30",
            "title": "08:30"
          },
          {
            "id": "08:45",
            "title": "08:45"
          },
          {
            "id": "09:00",
            "title": "09:00"
          },
          {
            "id": "09:15",
            "title": "09:15"
          },
          {
            "id": "09:30",
            "title": "09:30"
          },
          {
            "id": "09:45",
            "title": "09:45"
          },
          {
            "id": "10:00",
            "title": "10:00"
          },
          {
            "id": "10:15",
            "title": "10:15"
          },
          {
            "id": "10:30",
            "title": "10:30"
          },
          {
            "id": "10:45",
            "title": "10:45"
          },
          {
            "id": "11:00",
            "title": "11:00"
          },
          {
            "id": "11:15",
            "title": "11:15"
          },
          {
            "id": "11:30",
            "title": "11:30"
          },
          {
            "id": "11:45",
            "title": "11:45"
          },
          {
            "id": "12:00",
            "title": "12:00"
          },
          {
            "id": "12:15",
            "title": "12:15"
          },
          {
            "id": "12:30",
            "title": "12:30"
          },
          {
            "id": "12:45",
            "title": "12:45"
          },
          {
            "id": "13:00",
            "title": "13:00"
          },
          {
            "id": "13:15",
            "title": "13:15"
          },
          {
            "id": "13:30",
            "title": "13:30"
          },
          {
            "id": "13:45",
            "title": "13:45"
          },
          {
            "id": "14:00",
            "title": "14:00"
          },
          {
            "id": "14:15",
            "title": "14:15"
          },
          {
            "id": "14:30",
            "title": "14:30"
          },
          {
            "id": "14:45",
            "title": "14:45"
          },
          {
            "id": "15:00",
            "title": "15:00"
          },
          {
            "id": "15:15",
            "title": "15:15"
          },
          {
            "id": "15:30",
            "title": "15:30"
          },
          {
            "id": "15:45",
            "title": "15:45"
          },
          {
            "id": "16:00",
            "title": "16:00"
          },
          {
            "id": "16:15",
            "title": "16:15"
          },
          {
            "id": "16:30",
            "title": "16:30"
          },
          {
            "id": "16:45",
            "title": "16:45"
          },
          {
            "id": "17:00",
            "title": "17:00"
          },
          {
            "id": "17:15",
            "title": "17:15"
          },
          {
            "id": "17:30",
            "title": "17:30"
          },
          {
            "id": "17:45",
            "title": "17:45"
          },
          {
            "id": "18:00",
            "title": "18:00"
          },
          {
            "id": "18:15",
            "title": "18:15"
          },
          {
            "id": "18:30",
            "title": "18:30"
          },
          {
            "id": "18:45",
            "title": "18:45"
          },
          {
            "id": "19:00",
            "title": "19:00"
          },
          {
            "id": "19:15",
            "title": "19:15"
          },
          {
            "id": "19:30",
            "title": "19:30"
          },
          {
            "id": "19:45",
            "title": "19:45"
          },
          {
            "id": "20:00",
            "title": "20:00"
          },
          {
            "id": "20:15",
            "title": "20:15"
          },
          {
            "id": "20:30",
            "title": "20:30"
          },
          {
            "id": "20:45",
            "title": "20:45"
          },
          {
            "id": "21:00",
            "title": "21:00"
          },
          {
            "id": "21:15",
            "title": "21:15"
          },
          {
            "id": "21:30",
            "title": "21:30"
          },
          {
            "id": "21:45",
            "title": "21:45"
          },
          {
            "id": "22:00",
            "title": "22:00"
          },
          {
            "id": "22:15",
            "title": "22:15"
          },
          {
            "id": "22:30",
            "title": "22:30"
          },
          {
            "id": "22:45",
            "title": "22:45"
          },
          {
            "id": "23:00",
            "title": "23:00"
          },
          {
            "id": "23:15",
            "title": "23:15"
          },
          {
            "id": "23:30",
            "title": "23:30"
          },
          {
            "id": "23:45",
            "title": "23:45"
          }
        ],
        "validation": "required|date_format:H:i"
      },
      {
        "title": "Shift start tolerance",
        "name": "shift_start_tolerance",
        "type": "select",
        "options": [
          {
            "id": 0,
            "title": "0 min"
          },
          {
            "id": 1,
            "title": "1 min"
          },
          {
            "id": 2,
            "title": "2 min"
          },
          {
            "id": 3,
            "title": "3 min"
          },
          {
            "id": 4,
            "title": "4 min"
          },
          {
            "id": 5,
            "title": "5 min"
          },
          {
            "id": 6,
            "title": "6 min"
          },
          {
            "id": 7,
            "title": "7 min"
          },
          {
            "id": 8,
            "title": "8 min"
          },
          {
            "id": 9,
            "title": "9 min"
          },
          {
            "id": 10,
            "title": "10 min"
          },
          {
            "id": 11,
            "title": "11 min"
          },
          {
            "id": 12,
            "title": "12 min"
          },
          {
            "id": 13,
            "title": "13 min"
          },
          {
            "id": 14,
            "title": "14 min"
          },
          {
            "id": 15,
            "title": "15 min"
          },
          {
            "id": 20,
            "title": "20 min"
          },
          {
            "id": 25,
            "title": "25 min"
          },
          {
            "id": 30,
            "title": "30 min"
          },
          {
            "id": 35,
            "title": "35 min"
          },
          {
            "id": 40,
            "title": "40 min"
          },
          {
            "id": 45,
            "title": "45 min"
          },
          {
            "id": 50,
            "title": "50 min"
          },
          {
            "id": 55,
            "title": "55 min"
          },
          {
            "id": 60,
            "title": "60 min"
          }
        ],
        "validation": "required|integer"
      },
      {
        "title": "Shift finish tolerance",
        "name": "shift_finish_tolerance",
        "type": "select",
        "options": [
          {
            "id": 0,
            "title": "0 min"
          },
          {
            "id": 1,
            "title": "1 min"
          },
          {
            "id": 2,
            "title": "2 min"
          },
          {
            "id": 3,
            "title": "3 min"
          },
          {
            "id": 4,
            "title": "4 min"
          },
          {
            "id": 5,
            "title": "5 min"
          },
          {
            "id": 6,
            "title": "6 min"
          },
          {
            "id": 7,
            "title": "7 min"
          },
          {
            "id": 8,
            "title": "8 min"
          },
          {
            "id": 9,
            "title": "9 min"
          },
          {
            "id": 10,
            "title": "10 min"
          },
          {
            "id": 11,
            "title": "11 min"
          },
          {
            "id": 12,
            "title": "12 min"
          },
          {
            "id": 13,
            "title": "13 min"
          },
          {
            "id": 14,
            "title": "14 min"
          },
          {
            "id": 15,
            "title": "15 min"
          },
          {
            "id": 20,
            "title": "20 min"
          },
          {
            "id": 25,
            "title": "25 min"
          },
          {
            "id": 30,
            "title": "30 min"
          },
          {
            "id": 35,
            "title": "35 min"
          },
          {
            "id": 40,
            "title": "40 min"
          },
          {
            "id": 45,
            "title": "45 min"
          },
          {
            "id": 50,
            "title": "50 min"
          },
          {
            "id": 55,
            "title": "55 min"
          },
          {
            "id": 60,
            "title": "60 min"
          }
        ],
        "validation": "required|integer"
      },
      {
        "title": "Excessive exit",
        "name": "excessive_exit",
        "type": "integer",
        "default": 10,
        "validation": "required|integer"
      }
    ]
  },
  "29": {
    "type": 29,
    "name": "Engine hours Daily",
    "formats": [
      "html",
      "xls",
      "pdf",
      "pdf_land"
    ],
    "fields": []
  }

Schema
Example
expand all

object
status	integer	optional
errors	object	optional

{
  "status": 0,
  "errors": {}
}

Schema
Example
expand all

object
status	integer	optional
error	string	optional

{
  "status": 0,
  "error": "No language selected."
}

Schema
Example
expand all

GET /add_report_data

Definition

Query String

lang	string Validation default: en	required
user_api_hash	string Validation default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS	required

Responses application/json

200 400 401 500

Schema
Example
expand all

object
devices	array[object] Validation {device}	optional
id		optional
user_id	null integer	optional
traccar_device_id	string	optional
icon_id	string	optional
active	string	optional
deleted	string	optional
name	string	optional
imei	string	optional
fuel_measurement_id	string	optional
fuel_quantity	string	optional
fuel_price	string	optional
fuel_per_km	string	optional
sim_number	string	optional
device_model	string	optional
plate_number	string	optional
vin	string	optional
registration_number	string	optional
object_owner	string	optional
expiration_date	string	optional
tail_color	string	optional
tail_length	string	optional
engine_hours	string	optional
detect_engine	string	optional
min_moving_speed	string	optional
min_fuel_fillings	string	optional
min_fuel_thefts	string	optional
snap_to_road	string	optional
created_at	string	optional
updated_at	string	optional
pivot	object	optional
user_id	string	optional
device_id	string	optional
group_id	null	optional
current_driver_id	string	optional
active	string	optional
timezone_id	null	optional
traccar	object	optional
id	string	optional
name	string	optional
uniqueId	string	optional
latestPosition_id	string	optional
lastValidLatitude	string	optional
lastValidLongitude	string	optional
other	string	optional
speed	string	optional
time	string	optional
server_time	string	optional
ack_time	null	optional
altitude	string	optional
course	string	optional
power	null	optional
address	null	optional
protocol	string	optional
latest_positions	string	optional
icon	object	optional
id	object	optional
order	string	optional
width	string	optional
height	string	optional
path	string	optional
sensors	array[object]	optional
id	string	optional
user_id	string	optional
device_id	string	optional
name	string	optional
type	string	optional
tag_name	string	optional
add_to_history	string	optional
on_value	null	optional
off_value	null	optional
shown_value_by	string	optional
fuel_tank_name	null	optional
full_tank	null	optional
full_tank_value	null	optional
min_value	null	optional
max_value	null	optional
formula	null	optional
odometer_value_by	null	optional
odometer_value	null	optional
odometer_value_unit	string	optional
temperature_max	null	optional
temperature_max_value	null	optional
temperature_min	null	optional
temperature_min_value	null	optional
value	string	optional
value_formula	string	optional
show_in_popup	string	optional
unit_of_measurement	string	optional
on_tag_value	null	optional
off_tag_value	null	optional
on_type	null	optional
off_type	null	optional
calibrations	null	optional
services	array[object]	optional
id	string	optional
user_id	string	optional
device_id	string	optional
name	string	optional
expiration_by	string	optional
interval	string	optional
last_service	string	optional
trigger_event_left	string	optional
renew_after_expiration	string	optional
expires	string	optional
expires_date	null	optional
remind	string	optional
remind_date	null	optional
event_sent	string	optional
expired	string	optional
email	string	optional
mobile_phone	string	optional
geofences	array[object] Validation {geofence}	optional
id	integer	optional
type	string Validation Allowed Values: polygon, circle	optional
user_id	integer	optional
group_id	null integer	optional
active	integer	optional
name	string	optional
center	object Validation {LatLng}	optional
lat	number	optional
lng	number	optional
radius	null number	optional
coordinates	string array[object] Validation {LatLng}	optional
lat	number	optional
lng	number	optional
polygon_color	string	optional
created_at	string	optional
updated_at	string	optional
formats	array[object]	optional
id	string	optional
value	string	optional
stops	array[object]	optional
id	integer	optional
value	string	optional
filters	array[object]	optional
id	integer	optional
value	string	optional
types	array[object]	optional
id	integer	optional
value	string	optional
reports	object	optional
total	integer Validation {pagination}	optional
per_page	integer Validation {pagination}	optional
current_page	integer Validation {pagination}	optional
last_page	integer Validation {pagination}	optional
from	integer Validation {pagination}	optional
to	integer Validation {pagination}	optional
next_page_url	null string Validation {pagination}	optional
prev_page_url	null string Validation {pagination}	optional
url	string Validation {pagination}	optional
data	array[object] Validation {report}	optional
id	integer string	optional
user_id	integer string	optional
title	string	optional
type	integer string	optional
format	string	optional
show_addresses	null integer	optional
zones_instead	null integer	optional
stops	integer string	optional
speed_limit	null number	optional
null number		optional
daily	null integer	optional
weekly	null integer	optional
email	string	optional
weekly_email_sent	string	optional
daily_email_sent	string	optional
devices	array[integer]	optional
geofences	array[integer]	optional
logs	object	optional
sorting	object	optional
sort	string	optional
sort_by	string	optional
status	integer	optional

{
  "devices": [
    {
      "id": "3",
      "user_id": null,
      "traccar_device_id": "3",
      "icon_id": "8",
      "active": "1",
      "deleted": "0",
      "name": "Device name",
      "imei": "789832",
      "fuel_measurement_id": "1",
      "fuel_quantity": "0.00",
      "fuel_price": "0.00",
      "fuel_per_km": "0.00",
      "sim_number": "",
      "device_model": "",
      "plate_number": "",
      "vin": "",
      "registration_number": "",
      "object_owner": "",
      "expiration_date": "0000-00-00",
      "tail_color": "#33cc33",
      "tail_length": "5",
      "engine_hours": "gps",
      "detect_engine": "gps",
      "min_moving_speed": "6",
      "min_fuel_fillings": "10",
      "min_fuel_thefts": "10",
      "snap_to_road": "0",
      "created_at": "2016-04-25 16:21:19",
      "updated_at": "2016-06-26 15:52:46",
      "pivot": {
        "user_id": "2",
        "device_id": "3",
        "group_id": null,
        "current_driver_id": "1",
        "active": "1",
        "timezone_id": null
      },
      "traccar": {
        "id": "3",
        "name": "Device name",
        "uniqueId": "789832",
        "latestPosition_id": "99",
        "lastValidLatitude": "55.92299604",
        "lastValidLongitude": "23.34669059",
        "other": "31.083.181.149.238",
        "speed": "0.00",
        "time": "2016-04-29 19:01:26",
        "server_time": "2016-04-29 19:01:26",
        "ack_time": null,
        "altitude": "175",
        "course": "0",
        "power": null,
        "address": null,
        "protocol": "osmand",
        "latest_positions": "55.92297793/23.34665713;55.92336524/23.34666575;55.91928624/23.34572509;55.91590619/23.33778733;55.91986482/23.3255625;55.92581495/23.30829421;55.92748307/23.30725942;55.92966571/23.31183084;55.93430696/23.31986459;55.93769598/23.32408059;55.94483741/23.33093897;55.94417471/23.33107782;55.93988092/23.32629426;55.93719855/23.32534909;55.93344595/23.32372258"
      },
      "icon": {
        "id": "8",
        "order": "3",
        "width": "43.00",
        "height": "57.00",
        "path": "frontend/images/device_icons/8.png"
      },
      "sensors": [
        {
          "id": "1",
          "user_id": "2",
          "device_id": "3",
          "name": "Sensor test",
          "type": "battery",
          "tag_name": "Parameter name",
          "add_to_history": "0",
          "on_value": null,
          "off_value": null,
          "shown_value_by": "tag_value",
          "fuel_tank_name": null,
          "full_tank": null,
          "full_tank_value": null,
          "min_value": null,
          "max_value": null,
          "formula": null,
          "odometer_value_by": null,
          "odometer_value": null,
          "odometer_value_unit": "km",
          "temperature_max": null,
          "temperature_max_value": null,
          "temperature_min": null,
          "temperature_min_value": null,
          "value": "-",
          "value_formula": "0",
          "show_in_popup": "0",
          "unit_of_measurement": "nn",
          "on_tag_value": null,
          "off_tag_value": null,
          "on_type": null,
          "off_type": null,
          "calibrations": null
        }
      ],
      "services": [
        {
          "id": "1",
          "user_id": "2",
          "device_id": "3",
          "name": "Test service",
          "expiration_by": "engine_hours",
          "interval": "0",
          "last_service": "1000",
          "trigger_event_left": "0",
          "renew_after_expiration": "0",
          "expires": "1000",
          "expires_date": null,
          "remind": "1000",
          "remind_date": null,
          "event_sent": "0",
          "expired": "0",
          "email": "",
          "mobile_phone": ""
        }
      ]
    }
  ],
  "geofences": [
    {
      "id": 1,
      "user_id": 2,
      "group_id": null,
      "active": 1,
      "name": "Test geo",
      "coordinates": "[{\"lat\":55.925307141049,\"lng\":23.350710868835},{\"lat\":55.926918076798,\"lng\":23.333630561829},{\"lat\":55.91948797954,\"lng\":23.331656455994},{\"lat\":55.916000873283,\"lng\":23.340711593628},{\"lat\":55.925066697134,\"lng\":23.353199958801}]",
      "polygon_color": "#d000df",
      "created_at": "2016-04-28 22:13:17",
      "updated_at": "2016-04-28 22:13:34"
    }
  ],
  "formats": [
    {
      "id": "html",
      "value": "HTML"
    },
    {
      "id": "xls",
      "value": "XLS"
    },
    {
      "id": "pdf",
      "value": "PDF"
    },
    {
      "id": "pdf_land",
      "value": "PDF (Landscape)"
    }
  ],
  "stops": [
    {
      "id": 1,
      "value": "> 1 min"
    },
    {
      "id": 2,
      "value": "> 2 min"
    },
    {
      "id": 5,
      "value": "> 5 min"
    },
    {
      "id": 10,
      "value": "> 10 min"
    },
    {
      "id": 20,
      "value": "> 20 min"
    },
    {
      "id": 30,
      "value": "> 30 min"
    },
    {
      "id": 60,
      "value": "> 1 h"
    },
    {
      "id": 120,
      "value": "> 2 h"
    },
    {
      "id": 300,
      "value": "> 5 h"
    }
  ],
  "filters": [
    {
      "id": 0,
      "value": ""
    },
    {
      "id": 1,
      "value": "Today"
    },
    {
      "id": 2,
      "value": "Yesterday"
    },
    {
      "id": 3,
      "value": "Before 2 days"
    },
    {
      "id": 4,
      "value": "Before 3 days"
    },
    {
      "id": 5,
      "value": "This week"
    },
    {
      "id": 6,
      "value": "Last week"
    },
    {
      "id": 7,
      "value": "This month"
    },
    {
      "id": 8,
      "value": "Last month"
    }
  ],
  "types": [
    {
      "id": 1,
      "value": "General information"
    },
    {
      "id": 2,
      "value": "General information (merged)"
    },
    {
      "id": 3,
      "value": "Drives and stops"
    },
    {
      "id": 18,
      "value": "Drives and stops / Geofences"
    },
    {
      "id": 4,
      "value": "Travel sheet"
    },
    {
      "id": 5,
      "value": "Overspeed"
    },
    {
      "id": 6,
      "value": "Underspeed"
    },
    {
      "id": 7,
      "value": "Geofence in/out"
    },
    {
      "id": 15,
      "value": "Geofence in/out 24 hour mode"
    },
    {
      "id": 8,
      "value": "Events"
    },
    {
      "id": 10,
      "value": "Fuel level"
    },
    {
      "id": 11,
      "value": "Fuel fillings"
    },
    {
      "id": 12,
      "value": "Fuel thefts"
    },
    {
      "id": 13,
      "value": "Temperature"
    },
    {
      "id": 14,
      "value": "RAG"
    }
  ],
  "reports": {
    "total": 1,
    "per_page": 10,
    "current_page": 1,
    "last_page": 1,
    "next_page_url": null,
    "prev_page_url": null,
    "from": 1,
    "to": 1,
    "data": [
      {
        "id": "2",
        "user_id": "2",
        "title": "Report title",
        "type": "4",
        "format": "html",
        "show_addresses": null,
        "zones_instead": null,
        "stops": "1",
        "speed_limit": null,
        "daily": null,
        "weekly": null,
        "email": "",
        "weekly_email_sent": "2016-06-27 00:00:00",
        "daily_email_sent": "2016-06-26 00:00:00",
        "devices": [
          {
            "id": "3",
            "user_id": null,
            "traccar_device_id": "3",
            "icon_id": "8",
            "active": "1",
            "deleted": "0",
            "name": "Device name",
            "imei": "789832",
            "fuel_measurement_id": "1",
            "fuel_quantity": "0.00",
            "fuel_price": "0.00",
            "fuel_per_km": "0.00",
            "sim_number": "",
            "device_model": "",
            "plate_number": "",
            "vin": "",
            "registration_number": "",
            "object_owner": "",
            "expiration_date": "0000-00-00",
            "tail_color": "#33cc33",
            "tail_length": "5",
            "engine_hours": "gps",
            "detect_engine": "gps",
            "min_moving_speed": "6",
            "min_fuel_fillings": "10",
            "min_fuel_thefts": "10",
            "snap_to_road": "0",
            "created_at": "2016-04-25 16:21:19",
            "updated_at": "2016-06-26 15:52:46",
            "pivot": {
              "report_id": "2",
              "device_id": "3"
            }
          }
        ],
        "geofences": []
      }
    ],
    "url": "/api/get_reports"
  },
  "logs": {
    "sorting": {
      "sort": "desc",
      "sort_by": "id"
    }
  },
  "status": 1
}

Schema
Example
expand all

object
status	integer	optional
errors	object	optional

{
  "status": 0,
  "errors": {}
}

Schema
Example
expand all

object
status	integer	optional
error	string	optional

{
  "status": 0,
  "error": "No language selected."
}

Schema
Example
expand all

POST /add_report

Definition

Query String

lang	string Validation default: en	required
user_api_hash	string Validation default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS	required

Request Body multipart/form-data

schema
Example
expand all

object Validation {reportPost}
title	string	required
type	integer	required
format	string	required
speed_limit	number	optional
devices	array[integer]	required
geofences	array[integer]	optional
daily	integer	optional
weekly	integer	optional
send_to_email	string	optional
date_from	string Validation format: date	required
date_to	string Validation format: date	required
time_from	string Validation format: time	optional
time_to	string Validation format: time	optional
show_addresses	boolean	optional
zones_instead	boolean	optional
stops	integer	optional

Responses application/json

200 400 401 500

Schema
Example
expand all

object Validation {success}
status	integer	optional

Schema
Example
expand all

object
status	integer	optional
errors	object	optional

{
  "status": 0,
  "errors": {}
}

Schema
Example
expand all

object
status	integer	optional
error	string	optional

{
  "status": 0,
  "error": "No language selected."
}

Schema
Example
expand all

POST /edit_report

Definition

Query String

lang	string Validation default: en	required
user_api_hash	string Validation default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS	required

Request Body application/json

schema
Example
expand all

object
id	integer Validation {ObjectID}	required
title	string Validation {reportPost}	required
type	integer Validation {reportPost}	required
format	string Validation {reportPost}	required
speed_limit	object Validation {reportPost}	optional
devices	array[integer] Validation {reportPost}	required
geofences	array[integer] Validation {reportPost}	optional
daily	integer Validation {reportPost}	optional
weekly	integer Validation {reportPost}	optional
send_to_email	string Validation {reportPost}	optional
date_from	Validation {reportPost} format: date	required
date_to	string Validation {reportPost} format: date	optional
time_from	string Validation {reportPost} format: time	optional
time_to	string Validation {reportPost} format: time	optional
show_addresses	boolean Validation {reportPost}	optional
zones_instead	boolean Validation {reportPost}	optional
stops	integer Validation {reportPost}	optional

Responses application/json

200 400 401 500

Schema
Example
expand all

object Validation {success}
status	integer	optional

Schema
Example
expand all

object
status	integer	optional
errors	object	optional

{
  "status": 0,
  "errors": {}
}

Schema
Example
expand all

object
status	integer	optional
error	string	optional

{
  "status": 0,
  "error": "No language selected."
}

Schema
Example
expand all

POST /generate_report

If the request is successfully returned { 'status': 3 'url': ###}. "url" is link to generated report file

Definition

Query String

lang	string Validation default: en	required
user_api_hash	string Validation default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS	required

Request Body multipart/form-data

schema
Example
expand all

object Validation {reportPost}
title	string	required
type	integer	required
format	string	required
speed_limit	number	optional
devices	array[integer]	required
geofences	array[integer]	optional
daily	integer	optional
weekly	integer	optional
send_to_email	string	optional
date_from	string Validation format: date	required
date_to	string Validation format: date	required
time_from	string Validation format: time	optional
time_to	string Validation format: time	optional
show_addresses	boolean	optional
zones_instead	boolean	optional
stops	integer	optional

Responses application/json

200 400 401 500

Schema
Example
expand all

object
status	integer	optional
url	string	optional

Schema
Example
expand all

object
status	integer	optional
errors	object	optional

{
  "status": 0,
  "errors": {}
}

Schema
Example
expand all

object
status	integer	optional
error	string	optional

{
  "status": 0,
  "error": "No language selected."
}

Schema
Example
expand all

GET /destroy_report

Definition

Query String

lang	string Validation default: en	required
user_api_hash	string Validation default: $2y$10$5RACGMNxUdz3h1ug9yAttu95U2acugM0YG1K5wx01ZrNMvpL6BWMS	required
report_id	integer	required

Responses application/json

200 400 401 500

Schema
Example
expand all

object Validation {success}
status	integer	optional

Schema
Example
expand all

object
status	integer	optional
errors	object	optional

{
  "status": 0,
  "errors": {}
}

Schema
Example
expand all

object
status	integer	optional
error	string	optional

{
  "status": 0,
  "error": "No language selected."
}

Schema
Example
expand all

MODEL reportPost

schema
Example
expand all

object
title	string	required
type	integer	required
format	string	required
speed_limit	number	optional
devices	array[integer]	required
geofences	array[integer]	optional
daily	integer	optional
weekly	integer	optional
send_to_email	string	optional
date_from	string Validation format: date	required
date_to	string Validation format: date	required
time_from	string Validation format: time	optional
time_to	string Validation format: time	optional
show_addresses	boolean	optional
zones_instead	boolean	optional
stops	integer	optional

MODEL report

schema
Example
expand all

object
id	integer string	optional
user_id	integer string	optional
title	string	optional
type	integer string	optional
format	string	optional
show_addresses	null integer	optional
zones_instead	null integer	optional
stops	integer string	optional
speed_limit	null number	optional
daily	null integer	optional
weekly	null integer	optional
email	string	optional
weekly_email_sent	string	optional
daily_email_sent	string	optional
devices	array[integer]	optional
geofences	array[integer]	optional

{
  "id": "2",
  "user_id": "2",
  "title": "Report title",
  "type": "4",
  "format": "html",
  "show_addresses": null,
  "zones_instead": null,
  "stops": "1",
  "speed_limit": null,
  "daily": null,
  "weekly": null,
  "email": "",
  "weekly_email_sent": "2016-06-27 00:00:00",
  "daily_email_sent": "2016-06-26 00:00:00",
  "devices": [
    3
  ],
  "geofences": []
}

MODEL reportType

schema
Example
expand all

object
type	integer	optional
name	string	optional
formats	array[string]	optional
fields	array[string]	optional
parameters	null array[object]	optional
title	string	optional
name	string	optional
type	string	optional
default	null integer string	optional
options	null array[object]	optional
id	integer string	optional
title	string	optional
validation	null string	optional

	Previous
	Route

Next
Map icon

Platform

Applications

Resources

Company

This website uses cookies.
See our Privacy Policy to learn more.

Welcome

Authentication

Device

Sensor

Service

Event

History

Alert

Custom event

Geofence

Route

Report

Map icon

Driver

Command

GPRS Template

SMS Template

Task

Setup

Platform

Applications

Resources

Company