Response
The response for the Best Sellers Rank (BSR) operation is designed to provide deep insights into a product's sales performance and its categorical hierarchy. The system processes live data from Amazon to deliver a clean, structured, and analysis-ready JSON output.
API Response Structure Overview
To ensure consistency and simplify data management, Easyparser responses are organized into four primary objects. Every successful request follows this architecture, which includes both the technical details of the operation and the core data payload:
request_info:Contains the success status of the API call and detailed credit consumption information.request_parameters:Echoes the parameters you sent (such as ASIN and operation type) to confirm what was processed.request_metadata:Provides performance metrics, including timestamps for when the request was created and processed.result:The core section containing the actual product ranking, pricing, and review data.
1. Top Level Meta Fields (Outside of result)
These fields provide essential information about the transaction status, parameters, and processing timing.
request_info (object)
The request_info object provides the technical status of your API call and real-time updates on your credit usage. It is the primary reference for debugging and monitoring your account's consumption limits.
id
String
A unique transaction identifier assigned to the request. This ID is essential for tracking operations and should be provided when contacting support.
success
Boolean
Indicates whether the request was successfully processed by the system.
status_code
Integer
The standard HTTP status code returned for the operation (e.g., 200 for success).
error_details
Array
Contains a list of error messages or codes if the request fails or encounters issues.
credits_used
Integer
The total cumulative number of credits consumed by your account during the current period or session.
credit_used_this_request
Integer
The specific number of credits consumed by this individual operation (BSR typically consumes 1 credit).
credits_remaining
Integer
Your current remaining credit balance available for future requests.
credits_reset_at
String
The timestamp indicating when your credit quota is scheduled to reset (ISO 8601 format).
request_metadata (Object)
The request_metadata object captures performance-related metrics and timestamps throughout the lifecycle of the request. These details help you evaluate system latency and data freshness.
created_at
String
The exact timestamp when the request reached the Easyparser servers.
processed_at
String
The timestamp when the data extraction and processing were completed.
total_time_taken
Float
The total duration of the operation in seconds, from submission to completion.
request_parameters (Object)
The request_parameters object serves as an echo of the input values you provided in your request. This allows for programmatic verification that the correct parameters were used to generate the response.
asin
String
The 10-character Amazon Standard Identification Number used for the query.
type
String
The type of operation that was executed (e.g., BEST_SELLERS_RANK).
2. Core Payload (Inside result)
The result object contains the categorical ranking and product details that are the primary focus of this operation. The data is organized into logical groups such as bestseller, reviews, and media.
product (Object)
This object contains the primary identification and commercial details of the product.
asin
String
The unique 10-character Amazon Standard Identification Number.
"B01DZQT0FG"
title
String
The full, official title of the product as shown on the listing.
"THERMOS Stainless King..."
brand_name
String
The brand or manufacturer associated with the product.
"THERMOS"
price
Float
The current selling price of the product at the time of the request.
26.75
currency
String
The three-letter ISO currency code for the marketplace.
"USD"
link
String
The direct URL to the product’s detail page on Amazon.
"https://www.amazon.com/..."
product.bestseller (Object)
This object contains the core metrics reflecting the product's popularity and standing on Amazon. It provides a real-time snapshot of where the product ranks within its specific category structure.
rank
Integer
The numerical ranking position of the product within the specified category.
422
context_name
String
The display name of the primary Amazon category where the ranking is measured.
"Kitchen & Dining"
sub_category_id
String
The unique browse node identifier for the specific sub-category the product belongs to.
"7907507"
product.media (Object)
The media object provides direct links to the product's visual assets, allowing you to display product images within your own interface.
image_url
String
The URL of the high-resolution primary product image.
"https://m.media-amazon.com/..."
thumb_url
String
The URL of the smaller thumbnail version of the primary image.
"https://m.media-amazon.com/..."
ptoduct.reviews (Object)
rating_value
Float
The numerical average rating score out of 5.
4.5
rating_text
String
The textual representation of the average rating.
"4.5 out of 5 stars"
full_star_count
Integer
The number of fully shaded stars in the rating visual.
4
total_count
Integer
The total number of customer ratings and reviews received.
22545
3. Standalone Result Fields
In addition to the objects above, the root of the result object includes the following geographical identifier:
country_code: The ISO alpha-2 country code of the Amazon marketplace where the data was retrieved (e.g., "US").
Sample JSON Output
Last updated