RoscoLive API v1.0

get list of companies with data usage for date range

GET/reports/data_tracking/companies

Returns a list of all available companies to the user with data usage information for that billing cycle.

Request

Query Params

start_date

string

required

Start date for request. YYYYMMDD

Example:

20240101

end_date

string

required

End date for request. YYYYMMDD

Example:

20240130

Request samples

Responses

Success(200)

HTTP Code: 200

Content Type : JSONapplication/json

meta

object

required

Request metadata object

code

integer

required

HTTP status code returned by response

response

object

required

Contains response data

companies

array [object {9}]

required

List of company data objects

result

string

required

"OK" if successful, else "Fail" if error

{
  "meta": {
    "code": 200
  },
  "response": {
    "companies": [
      {
        "active_devices": 5,
        "available_data_pool": 5120,
        "company_id": 1234,
        "overage_cost": 0,
        "override_overage_limits": true,
        "partner_id": 1234,
        "partner_name": "Boyle and Sons",
        "token": "12345678",
        "total_data_usage": 1087
      }
    ]
  },
  "result": "OK"
}

Last modified: 5 months ago