Filter for item listing quality metrics

You can look at item-level listing quality details with the Item Listing Quality Details API. Refer to the API throttling guide to understand the usage limitations for this API.

To view a detailed description for all Listing Quality metrics, go to the Content and Discoverability section in this Marketplace Learn article.

To view your seller’s Listing Quality score in Seller Center, go to the Listing Quality Dashboard under Analytics > Growth Opportunities.

There are two ways to filter for an item’s specific listing quality metric that you want:

• Filter fields: You can use filters with operators to specify category/product type or select a range of values to return.
• Query fields: You can use the query parameter to specify either of three fields: SKU, title, or item ID.

Option 1: Use filter field with operators

You can use filters in the request body to return the specific metrics that you want to see for your items.

You can request an item’s score returned as percent value for these metrics using filters: content discoverability, quality, offer, ratings, and reviews. You can also filter for items that have issues, are a specific product type, are within a category, or that are WFS-eligible.

Filter Operators

You need to specify the attribute to filter the responses returned and an operator (either “equals” or “between”).

📘

Note: To see the complete list of filters available, with descriptions, see filters in the Request Body Schema section of the Item Listing Quality Details API Reference.

Filter Example: ProductType and post-purchase issues

To filter item details by Product Type and return all items with post-purchase issues, you can use the filters: viewPostPurchaseItems and productType.

This request will return all the items with post-purchase issues for a specific product type:

{   "filters": [     {       "field": "**viewPostPurchaseItems**",       "op": "equals", "values": [0]     },     {       "field": "**productType**",       "op": "equals",       "values": ["Music"]     }   ]

📘

NOTE: To see a response sample, see Response Samples in the Item Listing Quality Details API Reference.

Option 2: Use query parameter with fields: SKU, title, condition, and item ID

You can limit your search for item-level listing quality details by: Item Title, SKU, condition, or Item ID with query fields: sku, title, condition, or itemId.

To specify the query parameter, you need to include the field and value in the body of the request.

Example Request Body: filter for item ID

For example, to query by item ID, specify field name itemId and Value(s) in the request body:

"query": {     "field": "**itemId**",     "value": "916854860"   }

Similarly, you can specify the SKU, title, or condition fields and provide the value.

You can also search multiple items, SKUs, or conditions with comma-separated value(s).

Example Request body: filter for multiple item ID

For example, to query by multiple item ID, specify the field name itemId and Value(s) in the request body:

"query": {
"field": ïtemId",
"value": "916854860,916854862,916854862,916854863"
}

📘

NOTE:

1. Multiple value is supported for item ID or SKU ID only, with a max supported limit of 200.
2. For a response sample, go to Response Samples in the Item Listing Quality Details API Reference.

Limit number of item details to return

To limit the number of items that return listing quality details, you can specify the limit query parameter to only return a specific number of items in the response. By default, if no limit is specified and limit value can never be negative, the API returns 200 items per page.

Use nextCursor to return next set of 200 items

Use the nextCursor query parameter to indicate pagination between each 200 items returned (the default limit). An initial API call response contains a nextCursor value.

Example: nextCursor returned in initial response

"nextCursor": "AoIFQCVXCj1wo9c/ATA3MTY0MyMTE4QTc2RTA5",

Specify this value in a subsequent request to return the next 200 items:

/v3/insights/item/listingQuality/items?nextCursor=ATA3MTY0MyMTE4QTc2RTA5

To get items 201-400, make a subsequent API call and specify the nextCursor value to start the list to be returned.

Recommendations

• To fetch all items in your catalog, use the cursor along with a query parameter with the 200 limit.
• An item can be categorized by category or product type. To access this mention the category name or product type along with a limit of 200 to get as many items.
• Avoid accessing API’s one at time with itemId, sku, or title fields to get multiple items. Use the category, product type with a limit of 200 to get multiple items specific to the category, product type.