Get Taxonomy

Prev Next

GET /taxonomy - Get Active and Previous Taxonomies

Use this API to fetch the currently active version of your Yahoo taxonomy or to get a list of previously uploaded taxonomies. Table below lists URIs supported for querying taxonomies:

URI

Description

GET /taxonomy

Use this API to fetch the currently active version of your Taxonomy. It returns an application/json response identical to the data part of a POST /taxonomy call.

GET /taxonomy/meta

Gets the metadata corresponding to last uploaded taxonomy.

GET /v1/taxonomy/show_fees

Gets the taxonomy, including fees associated with any applicable Bring Your Own Rate (BYOR) segments. If it is not a BYOR segment, this call just returns the regular taxonomy.

Example - Get Active Taxonomy

Request

GET /v1/taxonomy HTTP/1.1 Host: datax.yahooapis.com

Response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8 [
{
"id" : "YR1194",
"name" : "Baby Products", "type" : "SEGMENT"
}
]

Example - List previous taxonomies

Request

GET /v1/taxonomy/meta?history=true&limit=2 HTTP/1.1 Host:
datax.yahooapis.com

Response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8 [{
        "resourceType" : "datax-taxonomy",
        "resourceId" : "130815T013759Z662599033",
        "createTime" : "2013-14-05T17:47:32Z",
        "description" : "YaRetail Pilot Taxonomy", "links" :
        [{
                "rel"   : "self",
                "href" : "https://datax.yahooapis.com/v1/link/s/ozQ8sfj7EJV-"
        },{
                "rel"   : "describes",
                "href" : "https://datax.yahooapis.com/v1/link/rw5fasr4akhaQ-"
        }],
        "status" : {
                "state" : "PROCESSING",
                "lastUpdateTime" : "2013-14-05T17:47:32Z"
                }
        },
        {
        "resourceType" : "datax-taxonomy",
        "resourceId" : "130715T013759Z212573056",
        "createTime" : "2013-14-05T17:47:32Z",
        "description" : "YaRetail Pilot Taxonomy",

        "links" : [{
                "rel"   : "self",
                "href" : "https://datax.yahooapis.com/v1/link/s/IzzB5VWqTS073wGYDuuMc-"
        },{
                "rel"   : "describes",
                "href" : "https://datax.yahooapis.com/v1/link/zdx6gB7PAyCbRrs2aa-"
        }],
        "status" : {
                "state" : "ERROR",
                "lastUpdateTime" : "2013-14-05T17:47:31Z",
                "errors" : [{
                        "code" : "DATAX-1001",
                        "message" : "Input Taxonomy failed schema validation"
                }]
        }
}]

Example - Get BYOR Show Fees Taxonomy

Request

GET /v1/taxonomy?show_fees=true HTTP/1.1 Host: datax.yahooapis.com

Response

{
  "id": "custom_node_1",
  "name": "Custom",
  "subTaxonomy": [
    {
      "id": "brand_b_node",
      "name": "Brand B",
      "users": {
        "include": [
          "200",
          "300"
        ],
        "exclude": []
      },
      "subTaxonomy": [
        {
          "id": "segment_b1",
          "name": "Brand B Product 1 Buyers",
          "type": "SEGMENT",
          "users": {
            "include": [
              "100",
              "200"
            ],
            "exclude": []
          },
          "segmentFees": [
            {
              "fee": 1.5,
              "mediaType": "display"
            },
            {
              "fee": 2.36,
              "mediaType": "video"
            },
            {
              "fee": 3.0,
              "mediaType": "audio"
            },
            {
              "fee": 3.0,
              "mediaType": "connectedTv"
            }
          ],
          "gdpr_mode": "oath_is_processor"
        },
        {
          "id": "segment_b2",
          "name": "Brand B Product 2 Buyers",
          "type": "SEGMENT",
          "users": {
            "include": [
              "300"
            ],
            "exclude": []
          },
          "segmentFees": [
            {
              "fee": 1.6,
              "mediaType": "display"
            },
            {
              "fee": 2.1,
              "mediaType": "video"
            },
            {
              "fee": 2.7,
              "mediaType": "audio"
            },
            {
              "fee": 2.7,
              "mediaType": "connectedTv"
            }
          ],
          "gdpr_mode": "oath_is_processor"
        }
      ],
      "gdpr_mode": "oath_is_processor"
    }
  ],
  "gdpr_mode": "oath_is_processor"
}