Allows you to search course catalog search history records.
A 0-based index of the paged results you wish to receive. In general, you should start with a value of zero and increment it as you need to retrieve additional results. If not supplied, a value of 0 is used (the first page of results).
Indicates how many results you want per page. if not supplied, a default value of 100 is used.
The value you want to sort by. If not supplied, a default value of "SearchTime DESC" will be assumed. You can append " DESC" after the sort value to sort descending. For example, "SearchTime DESC" would sort by when the search was run in descending order.
Possible values:
- SearchTime
- LastName
An optional parameter used to filter for searches run by a particular user.
An optional parameter used to filter for searches run by a particular user using an external identifier.
An optional parameter used to filter for searches run after a specified date. When used in conjunction with the "searchedBefore" parameter, it becomes possible to filter for a given time range. This should be provided in unix epoch format, which is the number of seconds that have elapsed since midnight UTC January 1st, 1970.
An optional parameter used to filter for searches run before a specified date. When used in conjunction with the "searchedAfter" parameter, it becomes possible to filter for a given time range. This should be provided in unix epoch format, which is the number of seconds that have elapsed since midnight UTC January 1st, 1970.
OK Response
Indicates the status of the API request.
0 = Success
10 = Error
20 = Not found
30 = Invalid integration key
Error details. This will only have a value if an error was encountered. The status property will also be set to Error (10).
The total number of results that match the search conditions, not all of which may be in the current result set.
The total number of result pages that match the search conditions.
See CourseAssignmentSearchResult
The search result's unique identifier
The user's unique identifier
The user's external ID, usually a unique identifier from the calling system
The user's first name
The user's last name
The unique identifier of the organization the user belongs to
When the search was run. Provided in Unix epoch format, which is the number of seconds that have elapsed since midnight UTC January 1st, 1970.
The text filter entered by the user
All tags selected by the user. See Tag type below.
The tag's unique identifier.
The tag's name.
Unique identifiers of all clubs the search was filtered against.
The zero-based index of the page of results displayed by the search
The total number of results matched by the search