Prev		Next

CategoryListings

Description

The CategoryListings action is a directory service based on the Open Directory, www.dmoz.org. For any given category, it returns a list of site listings contained within that category.

Request Parameters

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

Name	Description	Required
`Action`	Set the Action parameter to `CategoryListings` to get a list of sites in the specified category.	Yes
`ResponseGroup`	`Listings` is the only available response group.	Yes
`Path`	Valid category path. Note that top-level categories will not return any listings unless Recursive=yes is specified (see below). Example values are `Top/Arts, Top/Business/Automotive` Note that the value should be URL-encoded. For example, `Path=Top%2FBusiness%2FConsumer_Goods_and_Services%2FElectronics`	Yes
`SortBy`	Indicates how to sort the results returned by this service: ( Popularity \| Title \| AverageReview )	No
`Recursive`	Specify whether to return listings for the current category only, or for the current category plus all subcategories. True \| False	No
`Start`	1-based index of result at which to start. Note: An empty document will be returned if this value exceeds the total number of available results.	No
`Count`	Number of results to return for this request, beginning from specified Start number (maximum 20)	No
`Version`	Pass in the current version number, 2005-07-11, to ensure that requests succeed even if the API changes in future versions.	No
`Descriptions`	boolean indicating whether to return descriptions with categories. True \| False	No

Sample Request

The following example shows a Query-style request and response

Request

http://awis.amazonaws.com?
Action=CategoryListings
&AWSAccessKeyId=[Your AWS Access Key ID]
&Signature=[signature]
&Timestamp=[timestamp used in signature]
&ResponseGroup=Listings
&Path=[Top/Arts, Top/Business/Automotive]
&SortBy=[one of: ( Popularity | Title | AverageReview )]
&Recursive=[True | False]
&Start=[number to start at]
&Count=[Number of results to return]
&Descriptions=[True | False]

Response

<aws:CategoryListingsResponse 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>0bf0a4b0-a441-49e7-9cfe-44b71e0df086</aws:RequestId>
</aws:OperationRequest>
<aws:CategoryListingsResult>
<aws:Alexa>
  
  <aws:CategoryListings>
    <aws:RecursiveCount>1804</aws:RecursiveCount>
    <aws:Count>217</aws:Count>
    <aws:Listings>
      <aws:Listing>
        <aws:DataUrl type="navigable">http://www.sony.com</aws:DataUrl>
        <aws:Title>Sony Electronics</aws:Title>
        <aws:PopularityRank>882</aws:PopularityRank>
      </aws:Listing>
      <aws:Listing>
        <aws:DataUrl type="navigable">http://www.samsung.com/</aws:DataUrl>
        <aws:Title>Samsung Electronics</aws:Title>
        <aws:PopularityRank>899</aws:PopularityRank>
      </aws:Listing>
    </aws:Listings>
  </aws:CategoryListings>
  
</aws:Alexa>
</aws:CategoryListingsResult>
<aws:ResponseStatus xmlns:aws="http://alexa.amazonaws.com/doc/2005-10-05/">
<aws:StatusCode>Success</aws:StatusCode>
</aws:ResponseStatus>
</aws:Response>
</aws:CategoryListingsResponse>