Deprecated
search/contentsholder/labels.list
Retrieves a list of labels across all Content Owner Media Units
URL
GET /v1.0/search/contentsholder/labels.list
Parameters
Argument | Required | Default Value | Example | Description |
---|---|---|---|---|
query | Optional | - | - | Filter labels by keywords. |
offset | Optional | 0 | 0 | Defines the start position for retrieving items. Use a number between 0 to 1000 for this argument. |
limit | Optional | 10 | 10 | The argument indicates the maximum number of items to retrieve. Use a number between 1 to 100 for this argument. |
Responses
{
"ok": true,
"labels": [
{
"name": "weather",
"count": 10
},
{
"name": "tokyo",
"count": 350
},
],
"paging": {
"total": 34,
"count": 34,
"offset": 0,
"limit": 50
}
}
The total is "10000" if there are more than 10000 records.
Errors
Error Code | Description |
---|---|
invalid_query | Value passed for “query” is invalid. |
invalid_unit_id | Value passed for “unit_id" is invalid. |
unit_not_found | The Media Unit cannot be found. |
invalid_offset | Value passed for “offset" is invalid. |
invalid_limit | Value passed for “limit" is invalid. |
For other error codes, refer to the Common Errors section of this document.