Menu
Alexa Web Information Service
Developer Guide

Description

The CategoryBrowse action and CategoryListings actions together provide a directory service enhanced with Alexa traffic data.

For any given category, the CategoryBrowse action returns a list of sub-categories. Within a particular category you can use the CategoryListings action to get the documents within that category ordered by traffic.

Request Parameters

The CategoryBrowse Action takes the following parameters. Required parameters must be provided for the request to succeed.

Name Description Required
Action

CategoryBrowse

Yes
ResponseGroup

Any valid response group. See the Response Group section below for valid options.

Yes
Path

Valid category path (Top/Arts, Top/Business/Automotive)

Yes
Descriptions

Whether to return descriptions with categories: (True | False)

No

Response Groups

By specifying one or more response groups when making the request, you can retrieve only the information you are interested in.

Response Group Data Returned
Categories

All sub-categories within the specified category path

RelatedCategories

Categories that are related to the specified category path

LanguageCategories

Language categories in which the specified category path is available

LetterBars

"Letter Bars" (A, B, C, etc.) for categories that contain them

Sample Request

The following example shows a query-style request and response

Request

https://awis.amazonaws.com/api?
        Action=CategoryBrowse
        &ResponseGroup=[Valid Response Group]
        &Path=[Top/Arts, Top/Business/Automotive]
        &Descriptions=[True | False]
        

Headers

Authorization: AWS4-HMAC-SHA256 Credential=<IAM_ACCESS_KEY>/20171114/us-west-1/awis/aws4_request, SignedHeaders=host;x-amz-date, Signature=<GENERATED_AUTH_V4_SIGNATURE>
Content-Type: application/xml
X-Amz-Date: 20171114T190104Z
Accept: application/xml
    

Response

<aws:CategoryBrowseResponse xmlns:aws="http://alexa.amazonaws.com/doc/2005-10-05/">
<aws:Response xmlns:aws="http://awis.amazonaws.com/doc/2005-07-11">
<aws:OperationRequest>
<aws:RequestId>cadde770-fe83-483c-9bcc-465a77d4ea0c</aws:RequestId>
</aws:OperationRequest>
<aws:CategoryBrowseResult>
<aws:Alexa>

<aws:CategoryBrowse>

<aws:Categories>
  <aws:Category>
    <aws:Path>Top/Business/Consumer_Goods_and_Services/Electronics/Accessories</aws:Path>
    <aws:Title>Accessories</aws:Title>
    <aws:SubCategoryCount>2</aws:SubCategoryCount>
    <aws:TotalListingCount>186</aws:TotalListingCount>
  </aws:Category>
  <aws:Category>
    <aws:Path>Top/Business/Consumer_Goods_and_Services/Electronics/Audio</aws:Path>
    <aws:Title>Audio</aws:Title>
    <aws:SubCategoryCount>8</aws:SubCategoryCount>
    <aws:TotalListingCount>1135</aws:TotalListingCount>
  </aws:Category>
</aws:Categories>

<aws:LetterBars/>

</aws:CategoryBrowse>
</aws:Alexa>
</aws:CategoryBrowseResult>
<aws:ResponseStatus xmlns:aws="http://alexa.amazonaws.com/doc/2005-10-05/">
<aws:StatusCode>Success</aws:StatusCode>
</aws:ResponseStatus>
</aws:Response>
</aws:CategoryBrowseResponse>