Taxonomic API Methods

Methods that let you view the Audience Manager common taxonomy. This optional classification scheme organizes traits into industry standard categories.

NOTE

You cannot create new taxonomic categories or classify traits with these methods. To classify a trait, specify the appropriate categoryId with a trait create or update method.

Return a Specific Taxonomy

A GET method that returns details about the specified taxonomic category.

Request

GET https://api.demdex.com/v1/taxonomies/0/<categoryId>

Response

A successful response returns 200 OK and the category for the specified ID. An unsuccessful request returns 404 No Content if the ID does not exist.

{
    "crUID": 158,
    "name": "Arts & Entertainment",
    "upUID": 158,
    "description": "Arts & Entertainment",
    "categoryID": 1,
    "parentCategoryID": 0
}

Return all Taxonomic Categories

A GET method that returns a list of the top-level categories in an array.

Request

GET https://api.demdex.com/v1/taxonomies/0/

Response

Truncated for brevity.

[
    {
        "crUID": 158,
        "name": "Arts & Entertainment",
        "upUID": 158,
        "description": "Arts & Entertainment",
        "categoryID": 1,
        "parentCategoryID": 0
    },
    {
        "crUID": 158,
        "name": "Automotive",
        "upUID": 158,
        "description": "Automotive",
        "categoryID": 2,
        "parentCategoryID": 0
    },
    {
        "crUID": 158,
        "name": "Business",
        "upUID": 158,
        "description": "Business",
        "categoryID": 3,
        "parentCategoryID": 0
    }
]

Return Taxonomic Sub-Categories

A GET method that returns sub-categories for the specified parent category in an array.

Request

GET https://api.demdex.com/v1/taxonomies/0/<categoryId>/childCategories/

Response

A successful response returns 200 OK and the category for the specified ID. An unsuccessful request returns 404 No Content if the ID does not exist. Truncated for brevity.

[
    {
        "crUID": 158,
        "name": "Books & Literature",
        "upUID": 158,
        "description": "Books & Literature",
        "categoryID": 25,
        "parentCategoryID": 1
    },
    {
        "crUID": 158,
        "name": "Celebrity Fan/Gossip",
        "upUID": 158,
        "description": "Celebrity Fan/Gossip",
        "categoryID": 49,
        "parentCategoryID": 1
    },
    {
        "crUID": 158,
        "name": "Fine Art",
        "upUID": 158,
        "description": "Fine Art",
        "categoryID": 72,
        "parentCategoryID": 1
    }
]