All URIs are relative to https://localhost/assets-api
| Method | HTTP request | Description |
|---|---|---|
| get_filter_tree | GET /v1/filter/anonymous/filterTree | Retrieve the filter tree for the site. |
| get_filter_tree_for_related_assets | GET /v1/filter/anonymous/filterTree/{assetId}/{configId} | Retrieve the filter tree values for related assets search. |
| get_user_filter_tree | GET /v1/filter/filterTree | Retrieve the filter tree values. |
| get_user_filter_tree_by_id | GET /v1/filter/filterTree/{id} | Retrieve the filter tree values for a specified root filter. |
| get_user_filter_tree_for_related_assets | GET /v1/filter/filterTree/{assetId}/{configId} | Retrieve the filter tree values for related assets search. |
FilterTree get_filter_tree(site_name=site_name, counted=counted, q=q, filter_ids=filter_ids, filter_values=filter_values)
Retrieve the filter tree for the site.
Required Permissions: There are no required permissions for this endpoint. Developer Information: There is no developer information provided for this endpoint.
from __future__ import print_function
import time
import veritone_dmh
from veritone_dmh.rest import ApiException
from pprint import pprint
# Configure API key authorization: ApiKeyQuery
configuration = veritone_dmh.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# create an instance of the API class
api_instance = veritone_dmh.FilterApi(veritone_dmh.ApiClient(configuration))
site_name = 'site_name_example' # str | The site name that we're retrieving the filter tree (optional)
counted = false # bool | Whether or not to get the count for the filter tree (optional) (default to false)
q = '*' # str | The current query text (optional) (default to *)
filter_ids = 'filter_ids_example' # str | Active filter ids, comma separated (optional)
filter_values = 'filter_values_example' # str | Filter values. Comma separated. Must follow format filterId:value (optional)
try:
# Retrieve the filter tree for the site.
api_response = api_instance.get_filter_tree(site_name=site_name, counted=counted, q=q, filter_ids=filter_ids, filter_values=filter_values)
pprint(api_response)
except ApiException as e:
print("Exception when calling FilterApi->get_filter_tree: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| site_name | str | The site name that we're retrieving the filter tree | [optional] |
| counted | bool | Whether or not to get the count for the filter tree | [optional] [default to false] |
| q | str | The current query text | [optional] [default to *] |
| filter_ids | str | Active filter ids, comma separated | [optional] |
| filter_values | str | Filter values. Comma separated. Must follow format filterId:value | [optional] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
FilterTree get_filter_tree_for_related_assets(asset_id, config_id, site_name=site_name, counted=counted, q=q, filter_ids=filter_ids, filter_values=filter_values)
Retrieve the filter tree values for related assets search.
Required Permissions: There are no required permissions for this endpoint. Developer Information: Returns available filter tree values and counts for related assets search. The filter tree objects are defined via configuration.
from __future__ import print_function
import time
import veritone_dmh
from veritone_dmh.rest import ApiException
from pprint import pprint
# Configure API key authorization: ApiKeyQuery
configuration = veritone_dmh.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# create an instance of the API class
api_instance = veritone_dmh.FilterApi(veritone_dmh.ApiClient(configuration))
asset_id = 'asset_id_example' # str | Asset Id to find related assets for
config_id = 'config_id_example' # str | Related Query config Id
site_name = 'site_name_example' # str | The site name that we're retrieving the filter tree (optional)
counted = false # bool | Whether or not to get the count for the filter tree (optional) (default to false)
q = '*' # str | The current query text (optional) (default to *)
filter_ids = 'filter_ids_example' # str | Active filter ids, comma separated (optional)
filter_values = 'filter_values_example' # str | Filter values. Comma separated. Must follow format filterId:value (optional)
try:
# Retrieve the filter tree values for related assets search.
api_response = api_instance.get_filter_tree_for_related_assets(asset_id, config_id, site_name=site_name, counted=counted, q=q, filter_ids=filter_ids, filter_values=filter_values)
pprint(api_response)
except ApiException as e:
print("Exception when calling FilterApi->get_filter_tree_for_related_assets: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| asset_id | str | Asset Id to find related assets for | |
| config_id | str | Related Query config Id | |
| site_name | str | The site name that we're retrieving the filter tree | [optional] |
| counted | bool | Whether or not to get the count for the filter tree | [optional] [default to false] |
| q | str | The current query text | [optional] [default to *] |
| filter_ids | str | Active filter ids, comma separated | [optional] |
| filter_values | str | Filter values. Comma separated. Must follow format filterId:value | [optional] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
FilterTree get_user_filter_tree(counted=counted, q=q, filter_ids=filter_ids, filter_values=filter_values)
Retrieve the filter tree values.
Required Permissions: There are no required permissions for this endpoint. Developer Information: Returns available filter tree values and counts. The filter tree objects are defined via configuration.
from __future__ import print_function
import time
import veritone_dmh
from veritone_dmh.rest import ApiException
from pprint import pprint
# Configure API key authorization: ApiKeyQuery
configuration = veritone_dmh.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# create an instance of the API class
api_instance = veritone_dmh.FilterApi(veritone_dmh.ApiClient(configuration))
counted = false # bool | Whether or not to get the count for the filter tree (optional) (default to false)
q = '*' # str | The current query text (optional) (default to *)
filter_ids = 'filter_ids_example' # str | Active filter ids, comma separated (optional)
filter_values = 'filter_values_example' # str | Filter values. Comma separated. Must follow format filterId:value (optional)
try:
# Retrieve the filter tree values.
api_response = api_instance.get_user_filter_tree(counted=counted, q=q, filter_ids=filter_ids, filter_values=filter_values)
pprint(api_response)
except ApiException as e:
print("Exception when calling FilterApi->get_user_filter_tree: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| counted | bool | Whether or not to get the count for the filter tree | [optional] [default to false] |
| q | str | The current query text | [optional] [default to *] |
| filter_ids | str | Active filter ids, comma separated | [optional] |
| filter_values | str | Filter values. Comma separated. Must follow format filterId:value | [optional] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
FilterTree get_user_filter_tree_by_id(id, counted=counted, q=q, filter_ids=filter_ids, filter_values=filter_values)
Retrieve the filter tree values for a specified root filter.
Required Permissions: There are no required permissions for this endpoint. Developer Information: Returns available filter tree values and counts. The filter tree objects are defined via configuration.
from __future__ import print_function
import time
import veritone_dmh
from veritone_dmh.rest import ApiException
from pprint import pprint
# Configure API key authorization: ApiKeyQuery
configuration = veritone_dmh.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# create an instance of the API class
api_instance = veritone_dmh.FilterApi(veritone_dmh.ApiClient(configuration))
id = 789 # int | Root filter id
counted = false # bool | Whether or not to get the count for the filter tree (optional) (default to false)
q = '*' # str | The current query text (optional) (default to *)
filter_ids = 'filter_ids_example' # str | Active filter ids, comma separated (optional)
filter_values = 'filter_values_example' # str | Filter values. Comma separated. Must follow format filterId:value (optional)
try:
# Retrieve the filter tree values for a specified root filter.
api_response = api_instance.get_user_filter_tree_by_id(id, counted=counted, q=q, filter_ids=filter_ids, filter_values=filter_values)
pprint(api_response)
except ApiException as e:
print("Exception when calling FilterApi->get_user_filter_tree_by_id: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | Root filter id | |
| counted | bool | Whether or not to get the count for the filter tree | [optional] [default to false] |
| q | str | The current query text | [optional] [default to *] |
| filter_ids | str | Active filter ids, comma separated | [optional] |
| filter_values | str | Filter values. Comma separated. Must follow format filterId:value | [optional] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
FilterTree get_user_filter_tree_for_related_assets(asset_id, config_id, counted=counted, q=q, filter_ids=filter_ids, filter_values=filter_values)
Retrieve the filter tree values for related assets search.
Required Permissions: There are no required permissions for this endpoint. Developer Information: Returns available filter tree values and counts for related assets search. The filter tree objects are defined via configuration.
from __future__ import print_function
import time
import veritone_dmh
from veritone_dmh.rest import ApiException
from pprint import pprint
# Configure API key authorization: ApiKeyQuery
configuration = veritone_dmh.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# create an instance of the API class
api_instance = veritone_dmh.FilterApi(veritone_dmh.ApiClient(configuration))
asset_id = 'asset_id_example' # str | Asset Id to find related assets for
config_id = 'config_id_example' # str | Related Query config Id
counted = false # bool | Whether or not to get the count for the filter tree (optional) (default to false)
q = '*' # str | The current query text (optional) (default to *)
filter_ids = 'filter_ids_example' # str | Active filter ids, comma separated (optional)
filter_values = 'filter_values_example' # str | Filter values. Comma separated. Must follow format filterId:value (optional)
try:
# Retrieve the filter tree values for related assets search.
api_response = api_instance.get_user_filter_tree_for_related_assets(asset_id, config_id, counted=counted, q=q, filter_ids=filter_ids, filter_values=filter_values)
pprint(api_response)
except ApiException as e:
print("Exception when calling FilterApi->get_user_filter_tree_for_related_assets: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| asset_id | str | Asset Id to find related assets for | |
| config_id | str | Related Query config Id | |
| counted | bool | Whether or not to get the count for the filter tree | [optional] [default to false] |
| q | str | The current query text | [optional] [default to *] |
| filter_ids | str | Active filter ids, comma separated | [optional] |
| filter_values | str | Filter values. Comma separated. Must follow format filterId:value | [optional] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]