RoscoLive API v1.0

Get drivers coaching events

GET/driver/coaching

Returns a list of events assigned for coaching of all drivers for the passed in company ID.

:::info[]
Note that events with has_feedback=true are not returned and are not considered when calculating driver score. Coaching sessions with coaching_type="score" are returned in any case.
:::

User Role Permissions

The following table shows which user roles are allowed to send requests using this API endpoint.

Role	Permission
Partner
Partner View
Custom Partner
Fleet Manager
Group Manager
User
Custom User

Request

Query Params

start_date

string <YYYYMMDD>

required

Start date for request. YYYYMMDD

>= 8 characters<= 8 characters

Example:

20250112

end_date

string <YYYYMMDD>

required

End date for request. YYYYMMDD

>= 8 characters<= 8 characters

Example:

20250113

company_id

integer

optional

ID of company
NOTE: only required for partner role users

Example:

12345

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

>= 100<= 599

response

array [object {14}]

required

Contains response data

action_item

optional

The item in which the coaching session was initiated on

coach_email

string <email>

optional

Email address of driver coach assigned to this coaching session

coaching_type

enum<string>

optional

Type of coaching session assigned

Allowed values:

scoreevent

created_by

integer

optional

ID of user who created the coaching session

driver_email

string <email> | null

optional

Email address of driver if provided

driver_first_name

string

optional

driver_id

integer

optional

Record ID of driver in RoscoLive (not assigned Driver ID)

driver_last_name

string

optional

due_date

string <date>

optional

Due date of coaching session

event_ts

string <date-time> | null

optional

Timestamp of event to be coached on

event_type

string

optional

Type of the event to be coached on

integer

optional

Record ID of coaching session

note

string

optional

Field for notes submitted with coaching session

status

enum<string>

optional

Status of coaching session

Allowed values:

incompletecompleteoverdue

result

enum<string>

required

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

Allowed values:

OKFailed

{
  "meta": {
    "code": 200
  },
  "response": [
    {
      "action_item": "200.0",
      "coach_email": "coach@example.com",
      "coaching_type": "score",
      "created_by": 551,
      "driver_email": null,
      "driver_first_name": "John",
      "driver_id": 67,
      "driver_last_name": "Smith",
      "due_date": "2025-02-06",
      "event_ts": null,
      "event_type": null,
      "id": 71,
      "note": null,
      "status": "incomplete"
    },
    {
      "action_item": 116404825,
      "coach_email": "coach@example.com",
      "coaching_type": "event",
      "created_by": 551,
      "driver_email": "jsmith@example.com",
      "driver_first_name": "John",
      "driver_id": 67,
      "driver_last_name": "Smith",
      "due_date": "2025-02-07",
      "event_ts": "Thu, 02 Jan 2025 15:12:27 GMT",
      "event_type": "Distraction",
      "id": 72,
      "note": "Driver is looking at phone",
      "status": "complete"
    }
  ],
  "result": "OK"
}

Last modified: 25 days ago