Category Feed | Athena XAI Documentation

The fields of the category feed, which lets Athena XAI index the categories on your website.

Overview

The category feed lets Athena XAI index the categories on your website. Format your data using the fields and the example below.

Fields

Field name	Data type	Description	Requirement
`id`	int	Your category’s unique identifier. Use a unique value for each category. Use the category’s ID where possible.	required
`parent_id`	int	The ID of the parent category your category belongs to. If your category doesn’t have a parent, set this field to “2”.	required
`parent_name`	string	The name of the parent category your category belongs to. If your category doesn’t have a parent, set this field to “Default Category”.	required
`level`	int	The level of your category in the category tree. In the Athena XAI category system, the main category level is “2”, because each platform reserves category level “1” for the Default Category. If the category does not have a level category, you can submit 2.	required
`name`	string	The name of your category.	required
`image`	string	The URL of your category’s image. If the category does not have an image, you can submit null.	required
`url`	string	The URL of your category’s landing page.	required
`path`	string	The full path of your category with all of its parents. Separate the categories in the path with a “>”, as in the example.	required
`category_size`	int	The number of products in your category. All categories should have products. Categories with no products will not be indexed.	optional

Categories with no products will not be indexed.

Example

JSON

[
   {
      "id": "17",
      "parent_id": "12",
      "parent_name": "Tops",
      "level": "4",
      "name": "Tanks",
      "image": null,
      "url": "http://example.local.com/men/tops-men/tanks-men.html",
      "path": "Men > Tops > Tanks",
      "category_size": 12
   },
   {
      "id": "18",
      "parent_id": "13",
      "parent_name": "Bottoms",
      "level": "4",
      "name": "Pants",
      "image": "http://example.local.com/bottoms-category-image.html",
      "url": "http://example.local.com/men/bottoms-men/pants-men.html",
      "path": "Men > Bottoms > Pants",
      "category_size": 12
   },
   {
      "id": "19",
      "parent_id": "0",
      "parent_name": "",
      "level": "0",
      "name": "Shorts",
      "image": null,
      "url": "http://example.local.com/men/bottoms-men/shorts-men.html",
      "path": "Men > Bottoms > Shorts",
      "category_size": 12
   }
]