Preferences: Get Filter List

POOL allows for many filters to control what content a user sees, and what content a user can hide. This endpoint returns genre and content filters and whether or not the user has the corresponding content hidden or shown.

Get Filter List Specification

Parameters: Header variables:
  1. userid: integer
  2. token: string
JSON list returned:

Get Filter List Workflow

  1. URL: https://api.promoonly.com/user/filters
  2. Header: Authorization: Bearer Base64(userid:token)
  3. Method: GET
  4. Returned: JSON

    Example JSON Output

    [
        {
            "filter": "Top 40",
            "hide": 0,
            "id": 1
        },
        {
            "filter": "Urban",
            "hide": 0,
            "id": 2
        },
        {
            "filter": "Electronic",
            "hide": 0,
            "id": 3
        },
        {
            "filter": "Dance",
            "hide": 0,
            "id": 4
        },
        {
            "filter": "Latin",
            "hide": 0,
            "id": 5
        },
        {
            "filter": "Country",
            "hide": 0,
            "id": 6
        },
        {
            "filter": "Rock",
            "hide": 0,
            "id": 7
        },
        {
            "filter": "Christian",
            "hide": 0,
            "id": 8
        },
        {
            "filter": "Audio",
            "hide": 0,
            "id": 9
        },
        {
            "filter": "Video",
            "hide": 1,
            "id": 10
        },
        {
            "filter": "HD",
            "hide": 0,
            "id": 11
        },
        {
            "filter": "Content Warnings",
            "hide": 0,
            "id": 12
        },
        {
            "filter": "Only Singles",
            "hide": 0,
            "id": 13
        },
        {
            "filter": "Alternative",
            "hide": 0,
            "id": 14
        },
        {
            "filter": "Specialty Releases",
            "hide": 0,
            "id": 15
        },
        {
            "filter": "Show Explicit Content",
            "hide": 0,
            "id": 16
        },
        {
            "filter": "Show Noteworthy Only",
            "hide": 1,
            "id": 17
        }
    ]

Examples

  1. PHP (using cURL):

    <?php
        $userid = 1;
        $token = "8b26e1e4f3f5e00a888807e605565c47";

        $filters_url = "https://api.promoonly.com/user/filters";

        $ch = curl_init();
        curl_setopt($ch, CURLOPT_URL, $filters_url);
        curl_setopt($ch, CURLOPT_HTTPHEADER, array("Authorization: Bearer ".base64_encode($userid.":".$token)));
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

        $filters_result = curl_exec($ch);
        curl_close($ch);

        $filenaming_obj = json_decode($filenaming_result);
    ?>
  2. Javascript (using jQuery):

    function b64EncodeUnicode(str)
    {
        return btoa(encodeURIComponent(str).replace(/%([0-9A-F]{2})/g,
            function toSolidBytes(match, p1)
            {
                return String.fromCharCode('0x' + p1);
            }));
    }

    var userid = 1;
    var token = "8b26e1e4f3f5e00a888807e605565c47";
    var auth_str = "Bearer " + b64EncodeUnicode(userid + ":" + token);

    $.ajax({
        type: "GET",
        url: "https://api.promoonly.com/user/filters",
        headers: { "Authorization": auth_str },
        dataType: "json",
        success: function (data)
        {
            console.log(data);
        }
    });
  3. Python (using requests):

    #!/usr/bin/env python

    import requests
    import base64
    import urllib

    userid = 1
    token = "8b26e1e4f3f5e00a888807e605565c47"

    b64_key = base64.b64encode("%s:%s" % (userid, token))
    headers = {"Authorization": "Bearer %s" % b64_key}
    filters_url = "https://api.promoonly.com/user/filters"
    result_return = requests.get(filters_url, headers=headers)

    print(result_return.text)