/dropdownfilters#
Returns available filter parameters and values for drop down menus.
Endpoint#
POST |
https://hyperion.api.synmax.com/v4/dropdownfilters |
Request Examples#
from synmax.hyperion.v4 import HyperionApiClient
hyperion_client = HyperionApiClient(access_token=access_token)
# Method name:
hyperion_client.dropdown_filters
curl -X POST "https://hyperion.api.synmax.com/v4/dropdownfilters" \
-H "Content-Type: application/json" \
-H "Access-Key: $API_TOKEN" \
-d '{}'
Parameters#
Query#
Parameter |
Type |
Description |
Example |
|---|---|---|---|
filter_type |
string |
— |
county |
search_term |
string |
— |
harris |
target_function |
string |
— |
shorttermforecast |
Response#
Parameter |
Type |
Description |
Example |
|---|---|---|---|
filter_type |
string |
— |
— |
id |
integer |
— |
— |
target_function |
string |
— |
— |
value |
string |
— |
— |