Tracking Overview Documentation

You may add additional filtering, sorting, and paginating to the /v1/Tracking/Overview/All request if you would like to reduce the subset of users returned. These are entirely optional, requesting without these parameters will return all results.

Here is a sample request:

Limit

This is the number of results you would like to return. The minimum number you can pass is 1, the maximum number of results is 100. If there are over 100 records, you will have additional pages.

Page

This is the page number you would like. If you make an initial request and there are 5 pages of results, you can pass the same request with a different page number to get those results. 

ForManagerUserId

You can pass a manager's UserId if you would like to filter on his or her assigned students.

Clause

You can use "And" to return results that only match all filters. You can pass "Or" to get results that match this condition, in addition to the other conditions.

FieldValue

This is the value you would like to pass as your filter.

SortField

This is the field you would like to sort on.

SortType

This is the type of sorting you would like on the SortField. Options are “asc” for Ascending or “desc” for Descending order.

FilterContainer

The filter container is where you pass your filter. Each filter further limits the results.

FieldName

This is the field name you would like to filter on.

You may sort of any field of the request body, except for the following:

• CanRenew
• HasCompletedCourse
• DaysUntilExpiration

For duplicate Field Names, it is required you pass the object name. For example, StateCode exists in both the Student and Course object. For the FieldName, please pass Student.StateCode to filter on the student’s state, or Course.StateCode to filter on the course state.

Comparator

This is the comparator type you would like to use. Here are the filter comparator options for each data type:

Course Types from Return Object

This list may be updated at any point:

• Life/Health
• Property/Casualty
• Series 6
• Series 63
• Series 65
• Series 7
• Navigator
• Adjuster
• Casualty
• Ethics & Code
• Health
• Property
• Variable
• Medicare