GET Suggest Available Filter Values

Syntax

The following method returns available values for a given filter alias and platform alias.

Note: This method retrieves all available values for the required filter option within the given platform and returns the names and IDs of these values in the response.

URL

Note: The parameters highlighted in red are placeholders for the mandatory values described below.

https://api.onereporting.aol.com/v4/report-management/filtervalues/suggest/PLATFORM_ALIAS/FILTER_ALIAS?query=SEARCH_QUERY&PARAMETERS
  • PLATFORM_ALIAS -Replace this placeholder with an alias of the platform of your report.
  • FILTER_ALIAS - Replace this placeholder with the required filter alias.
  • SEARCH_QUERY - Replace this placeholder with the required search term or search query.
  • PARAMETERS - Please refer to the following parameters section to apply any additional query parameters to the request.

     

    Parameters

    The following parameters and values can be added to the request.

    Note: Use a question mark '?' to open the query and add a parameter and value. 


    Note: Use the ampersands sign '&' to add multiple parameters and values one after the other within the query string.

     

    Parameter Description Value
    offset

    Enter a numeric value from 0 and up to define how many filter value results will be skipped from the beginning of the result list.

    Note: For example, setting the offset field to 1 will return the results starting with the second one in a raw in the response. 

    offset=number

    offset=1

    limit

    Enter a numeric value from 0 and up to define how many filter value results will be returned in the response.

    Note: For example, setting the offset field to 2 will only return the first two results in the response.

    limit=number

    limit=2

     

 

Example

URL

https://api.onereporting.aol.com/v4/report-management/filtervalues/suggest/O2/publisherCompany?query=advertising&offset=0&limit=30

 

Response

[
{
"id": "5909e67b7cdce053ec937c72",
"value": "Seed Corn Advertising-Seed Corn Advertising"
},
{
"id": "5b4c9d2d17e0e15b44a6e5b7",
"value": "Advertising.com"
},
{
"id": "5909c8d77cdce053ec935e7f",
"value": "Aol - Advertising.com"
},
{
"id": "583eb583134aa11b54d9508d",
"value": "AOL Advertising"
},
{
"id": "5642587467b62318603bce59",
"value": "AOL Advertising"
},
{
"id": "5909e8467cdce053ec937fae",
"value": "Talon Advertising"
}...
]

 

Have more questions? Submit a request