Searches
About
A search resource identifies a keyword search performed by the authenticated user. Below is a JSON representation of a search:
{"keyword": "A Search", "count": 100}
Properties
A search resource has the following properties:
| Name | Description |
|---|---|
| count | integer The number of times the keyword has been used. |
| keyword | string The search keyword. |
Methods
The API supports the following methods:
| Method | Endpoint | Description |
|---|---|---|
| GET | /searches | Retrieves a list of keyword searches performed by the authenticated user. A valid access token is required |
GET /searches
Request
GET http://marxoft.co.uk/api/cuteradio/searches
Parameters
| Name | Description |
|---|---|
| limit | integer The maximum number of results that should be returned. Must be between 1 and 50. The default is 20. |
| offset | integer The index of the first result to be returned. The index is 0-based. |
| search | string The keyword(s) to be used to filter results. |
| sort | string The property used to sort the results. The default is 'keyword'. |
| sortDescending | boolean Whether result should be sorted in descending order. The default is false. |
Response
{
"items": [
$SEARCH
],
"next": "/searches?limit=20&offset=20&sort=keyword&sortDescending=false"
}
Errors
| Error type | Description |
|---|---|
| 403 - Forbidden | No valid access token was provided. |