|
| 1 | +# ApiVideo.Api.TagsApi |
| 2 | + |
| 3 | +All URIs are relative to *https://ws.api.video* |
| 4 | + |
| 5 | +Method | HTTP request | Description |
| 6 | +------------- | ------------- | ------------- |
| 7 | +[**list**](TagsApi.md#listtags) | **GET** /tags | List all video tags |
| 8 | + |
| 9 | + |
| 10 | +<a name="listtags"></a> |
| 11 | +# **list** |
| 12 | +> ListTagsResponse list (string value = null, string sortBy = null, string sortOrder = null, int? currentPage = null, int? pageSize = null) |
| 13 | +
|
| 14 | +List all video tags |
| 15 | + |
| 16 | +This endpoint enables you to search for video tags in a project and see how many videos are tagged with them. If you do not define any query parameters, the endpoint lists all video tags and the numbers of times they are used in a project. |
| 17 | + |
| 18 | +### Example |
| 19 | +```csharp |
| 20 | +using System.Diagnostics; |
| 21 | +using ApiVideo.Client; |
| 22 | + |
| 23 | +namespace Example |
| 24 | +{ |
| 25 | + public class listExample |
| 26 | + { |
| 27 | + public static void Main() |
| 28 | + { |
| 29 | + var basePath = ApiVideoClient.Client.Environment.SANDBOX; |
| 30 | + var apiKey = "YOUR_API_KEY"; |
| 31 | + |
| 32 | + var apiInstance = new ApiVideoClient(apiKey,basePath); |
| 33 | + |
| 34 | + var value = value_example; // string | Use this parameter to search for specific video tags. The API filters results even on partial values, and ignores accents, uppercase, and lowercase. (optional) |
| 35 | + var sortBy = value; // string | Use this parameter to choose which field the API will use to sort the response data. The default is `value`. These are the available fields to sort by: - `value`: Sorts the results based on tag values in alphabetic order. - `videoCount`: Sorts the results based on the number of times a video tag is used. (optional) |
| 36 | + var sortOrder = asc; // string | Use this parameter to sort results. `asc` is ascending and sorts from A to Z. `desc` is descending and sorts from Z to A. (optional) |
| 37 | + var currentPage = 2; // int? | Choose the number of search results to return per page. Minimum value: 1 (optional) (default to 1) |
| 38 | + var pageSize = 30; // int? | Results per page. Allowed values 1-100, default is 25. (optional) (default to 25) |
| 39 | + var apiTagsInstance = apiInstance.Tags(); |
| 40 | + try |
| 41 | + { |
| 42 | + // List all video tags |
| 43 | + ListTagsResponse result = apiTagsInstance.list(value, sortBy, sortOrder, currentPage, pageSize); |
| 44 | + Debug.WriteLine(result); |
| 45 | + } |
| 46 | + catch (ApiException e) |
| 47 | + { |
| 48 | + Debug.Print("Exception when calling TagsApi.list: " + e.Message ); |
| 49 | + Debug.Print("Status Code: "+ e.ErrorCode); |
| 50 | + Debug.Print(e.StackTrace); |
| 51 | + } |
| 52 | + } |
| 53 | + } |
| 54 | +} |
| 55 | +``` |
| 56 | + |
| 57 | +### Parameters |
| 58 | + |
| 59 | +Name | Type | Description | Notes |
| 60 | +------------- | ------------- | ------------- | ------------- |
| 61 | + **value** | **string**| Use this parameter to search for specific video tags. The API filters results even on partial values, and ignores accents, uppercase, and lowercase. | [optional] |
| 62 | + **sortBy** | **string**| Use this parameter to choose which field the API will use to sort the response data. The default is `value`. These are the available fields to sort by: - `value`: Sorts the results based on tag values in alphabetic order. - `videoCount`: Sorts the results based on the number of times a video tag is used. | [optional] |
| 63 | + **sortOrder** | **string**| Use this parameter to sort results. `asc` is ascending and sorts from A to Z. `desc` is descending and sorts from Z to A. | [optional] |
| 64 | + **currentPage** | **int?**| Choose the number of search results to return per page. Minimum value: 1 | [optional] [default to 1] |
| 65 | + **pageSize** | **int?**| Results per page. Allowed values 1-100, default is 25. | [optional] [default to 25] |
| 66 | + |
| 67 | +### Return type |
| 68 | + |
| 69 | +[**ListTagsResponse**](ListTagsResponse.md) |
| 70 | + |
| 71 | +### HTTP request headers |
| 72 | + |
| 73 | + - **Content-Type**: Not defined |
| 74 | + - **Accept**: application/json |
| 75 | + |
| 76 | + |
| 77 | +### HTTP response details |
| 78 | +| Status code | Description | Response headers | |
| 79 | +|-------------|-------------|------------------| |
| 80 | +| **200** | Success | * X-RateLimit-Limit - The request limit per minute. <br> * X-RateLimit-Remaining - The number of available requests left for the current time window. <br> * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets. <br> | |
| 81 | +| **429** | Too Many Requests | * X-RateLimit-Limit - The request limit per minute. <br> * X-RateLimit-Remaining - The number of available requests left for the current time window. <br> * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets. <br> | |
| 82 | + |
| 83 | +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
| 84 | + |
0 commit comments