get data tracking report

Returns response that contains data tracking information for the devices in the company for the passed in company_id for the time window specified. If the value all is provided to the param company_id, then all available devices will be returned.

Request

Path Params

company_id

integer

required

ID of company to get data for. If all is used, then all available devices will be returned instead.

Example:

123456

Query Params

start_date

integer

required

Start date of time window for data in request (YYMMDD)

>= 6<= 6

Example:

240112

end_date

integer

required

End date of time window for data in request (YYMMDD)

>= 6<= 6

Example:

240118

Body Params multipart/form-data

object {0}

Responses

🟢200Success

application/json

Body

meta

object

required

Request metadata object

code

integer

required

HTTP status code returned by server

response

object

required

report

array [object {17}]

required

result

string

required

"OK" if request successful, otherwise "Failed"

Example

{
    "meta": {
        "code": 200
    },
    "response": {
        "report": [
            {
                "active": 0,
                "company_id": 825,
                "company_name": "Acme Trucks",
                "created_at": "Wed, 02 Jan 2019 19:47:45 GMT",
                "created_days": 2031,
                "data_usage": 0,
                "deleted_at": null,
                "device_id": 11766724,
                "device_limit": 1,
                "existed_days": null,
                "fleet_limit": 1,
                "iccid": "",
                "imei": "0",
                "partner_name": "Rosco Vision Partner",
                "status": "used",
                "vehicle_group": "Group A",
                "vehicle_name": "Truck 1001"
            },
            {
                "active": 1,
                "company_id": 825,
                "company_name": "Acme Trucks",
                "created_at": "Mon, 10 Jul 2023 21:31:20 GMT",
                "created_days": 381,
                "data_usage": 0,
                "deleted_at": null,
                "device_id": 45716178,
                "device_limit": 1,
                "existed_days": null,
                "fleet_limit": 1,
                "iccid": null,
                "imei": null,
                "partner_name": "Rosco Vision Partner",
                "status": "used",
                "vehicle_group": "Groub B",
                "vehicle_name": "Truck 1002"
            },
            {
                "active": 1,
                "company_id": 825,
                "company_name": "Acme Trucks",
                "created_at": "Tue, 02 Oct 2018 17:33:09 GMT",
                "created_days": 2123,
                "data_usage": 0,
                "deleted_at": null,
                "device_id": 49417348,
                "device_limit": 1,
                "existed_days": null,
                "fleet_limit": 1,
                "iccid": "74125896303692587412",
                "imei": "015974000000123",
                "partner_name": "Rosco Vision Partner",
                "status": "used",
                "vehicle_group": "Group A",
                "vehicle_name": "Truck 1005"
            },
            {
                "active": 0,
                "company_id": 825,
                "company_name": "Acme Trucks",
                "created_at": "Mon, 24 May 2021 20:02:19 GMT",
                "created_days": 1158,
                "data_usage": 0,
                "deleted_at": "Thu, 17 Feb 2022 20:55:11 GMT",
                "device_id": 49759267,
                "device_limit": 1,
                "existed_days": 269,
                "fleet_limit": 1,
                "iccid": "74125896303692587412",
                "imei": "015974000000321",
                "partner_name": "Rosco Vision Partner",
                "status": "used",
                "vehicle_group": "Group A",
                "vehicle_name": "Truck 2001"
            }
        ]
    },
    "result": "OK"
}

🟠401Login Required

Request

Request samples

Responses