### GET /api/v1/products/{Asin}/offers Source: https://api.smartscout.com/swagger/api/swagger.json Retrieves the current offers for a specific product identified by its ASIN. ```APIDOC ## GET /api/v1/products/{Asin}/offers ### Description Retrieves the current offers for a specific product identified by its ASIN. ### Method GET ### Endpoint /api/v1/products/{Asin}/offers ### Parameters #### Path Parameters - **Asin** (string) - Required - The ASIN of the product. #### Query Parameters - **marketplace** (string) - Required - The marketplace code (US, UK, IT, DE, CA, MX, FR, ES, IN, AU, JP, AE). - **page[id]** (string) - Optional - Page identifier. - **page[size]** (integer) - Optional - Number of items per page. - **sort[by]** (string) - Optional - Field to sort by. - **sort[order]** (string) - Optional - Sort order (asc, desc). ### Response #### Success Response (200) - **Response** (object) - Returns a paged search response containing product offers. ``` -------------------------------- ### GET /api/v1/sales/estimate Source: https://api.smartscout.com/index.html Get sales estimates for products. ```APIDOC ## GET /api/v1/sales/estimate ### Description Retrieves estimated sales data. ### Method GET ### Endpoint /api/v1/sales/estimate ``` -------------------------------- ### GET /api/v1/products/{Asin}/history/offers Source: https://api.smartscout.com/swagger/api/swagger.json Retrieves the historical offer data for a specific product identified by its ASIN. ```APIDOC ## GET /api/v1/products/{Asin}/history/offers ### Description Retrieves the historical offer data for a specific product identified by its ASIN. ### Method GET ### Endpoint /api/v1/products/{Asin}/history/offers ### Parameters #### Path Parameters - **Asin** (string) - Required - The ASIN of the product. #### Query Parameters - **marketplace** (string) - Required - The marketplace code (US, UK, IT, DE, CA, MX, FR, ES, IN, AU, JP, AE). - **page[id]** (string) - Optional - Page identifier. - **page[size]** (integer) - Optional - Number of items per page. - **sort[by]** (string) - Optional - Field to sort by. - **sort[order]** (string) - Optional - Sort order (asc, desc). ### Response #### Success Response (200) - **Response** (object) - Returns the offer history response. ``` -------------------------------- ### GET /Subcategories/{SubcategoryId} Source: https://api.smartscout.com/swagger/api/swagger.json Retrieves subcategory details based on the provided SubcategoryId and marketplace. ```APIDOC ## GET /Subcategories/{SubcategoryId} ### Description Retrieves a paged list of subcategories associated with the specified SubcategoryId. ### Method GET ### Endpoint /Subcategories/{SubcategoryId} ### Parameters #### Path Parameters - **SubcategoryId** (integer) - Required - The unique identifier of the subcategory. #### Query Parameters - **marketplace** (string) - Required - The marketplace code (e.g., US, UK, IT, DE, CA, MX, FR, ES, IN, AU, JP, AE). - **page[id]** (string) - Optional - The page identifier for pagination. - **page[size]** (integer) - Optional - The number of items per page. - **sort[by]** (string) - Optional - The field to sort by. - **sort[order]** (string) - Optional - The sort order (asc or desc). ### Response #### Success Response (200) - **Response** (object) - Returns a paged search response containing subcategory data. ``` -------------------------------- ### GET /api/v1/products/{Asin}/history Source: https://api.smartscout.com/index.html Retrieve historical data for a specific product identified by its ASIN. ```APIDOC ## GET /api/v1/products/{Asin}/history ### Description Fetches the historical performance data for a given Amazon product. ### Method GET ### Endpoint /api/v1/products/{Asin}/history ### Parameters #### Path Parameters - **Asin** (string) - Required - The Amazon Standard Identification Number of the product. ``` -------------------------------- ### GET /api/v1/sellers/{AmazonSellerId}/offers Source: https://api.smartscout.com/swagger/api/swagger.json Retrieves a paginated list of offers for a specific Amazon seller. ```APIDOC ## GET /api/v1/sellers/{AmazonSellerId}/offers ### Description Retrieves a paginated list of offers associated with a specific Amazon seller. ### Method GET ### Endpoint /api/v1/sellers/{AmazonSellerId}/offers ### Parameters #### Path Parameters - **AmazonSellerId** (string) - Required - The unique identifier of the Amazon seller. #### Query Parameters - **X-Api-Key** (string) - Required - Your API key for authentication. - **marketplace** (string) - Required - The Amazon marketplace identifier (e.g., US, UK, DE). - **page[id]** (string) - Optional - The ID of the page to retrieve. - **page[size]** (integer) - Optional - The number of items per page. - **sort[by]** (string) - Optional - The field to sort the results by. - **sort[order]** (string) - Optional - The order of sorting ('asc' or 'desc'). ### Response #### Success Response (200) - **data** (array) - A list of seller offers. - **links** (object) - Pagination links. - **meta** (object) - Metadata about the response. #### Response Example ```json { "data": [ { "asin": "B0EXAMPLEASIN", "sellerId": "AMAZONSELLERID", "price": { "amount": 19.99, "currency": "USD" }, "quantity": 100, "condition": "New" } ], "links": { "next": "/api/v1/sellers/AMAZONSELLERID/offers?page[id]=nextPageId" }, "meta": { "totalCount": 1000, "currentPage": 1, "pageSize": 10 } } ``` ``` -------------------------------- ### GET /api/v2/brands/sellers Source: https://api.smartscout.com/swagger/api/swagger.json Retrieves brand coverage information for sellers in a specific marketplace. ```APIDOC ## GET /api/v2/brands/sellers ### Description Retrieves brand coverage data for sellers based on the provided brand name and marketplace. ### Method GET ### Endpoint /api/v2/brands/sellers ### Parameters #### Header Parameters - **X-Api-Key** (string) - Required - API authentication key #### Query Parameters - **brandName** (string) - Optional - The name of the brand to search - **marketplace** (string) - Required - The marketplace code (US, UK, IT, DE, CA, MX, FR, ES, IN, AU, JP, AE) - **page[id]** (integer) - Optional - Page number - **page[size]** (integer) - Optional - Number of items per page - **sort[by]** (string) - Optional - Field to sort by - **sort[order]** (string) - Optional - Sort order (asc, desc) ### Response #### Success Response (200) - **Response** (object) - Returns a PagedSearchResponse containing Bb.Pub.BrandCoverage data. ``` -------------------------------- ### GET /api/v1/ad-spy/sponsored-products Source: https://api.smartscout.com/swagger/api/swagger.json Retrieves sponsored products based on search terms, brand names, and marketplace filters. ```APIDOC ## GET /api/v1/ad-spy/sponsored-products ### Description Retrieves a paged list of sponsored products based on provided search criteria. ### Method GET ### Endpoint /api/v1/ad-spy/sponsored-products ### Parameters #### Header Parameters - **X-Api-Key** (string) - Required - API authentication key #### Query Parameters - **searchTermValue** (string) - Optional - Search term to filter products - **brandName** (string) - Optional - Brand name to filter products - **marketplace** (string) - Required - Marketplace code (US, UK, IT, DE, CA, MX, FR, ES, IN, AU, JP, AE) - **page[id]** (integer) - Optional - Page identifier - **page[size]** (integer) - Optional - Number of items per page - **sort[by]** (string) - Optional - Field to sort by - **sort[order]** (string) - Optional - Sort order (asc, desc) ### Response #### Success Response (200) - **Response** (object) - Returns a PagedSearchResponse containing BrandSearchTerm objects. ``` -------------------------------- ### GET /api/v1/geobuybox Source: https://api.smartscout.com/swagger/api/swagger.json Retrieves GeoBuyBox data based on marketplace and optional filtering parameters. ```APIDOC ## GET /api/v1/geobuybox ### Description Retrieves GeoBuyBox information for a specified marketplace. ### Method GET ### Endpoint /api/v1/geobuybox ### Parameters #### Header Parameters - **X-Api-Key** (string) - Required - API authentication key #### Query Parameters - **requestId** (string) - Optional - UUID for the request - **marketplace** (string) - Required - Marketplace code (US, UK, IT, DE, CA, MX, FR, ES, IN, AU, JP, AE) - **page[id]** (string) - Optional - Page identifier - **page[size]** (string) - Optional - Number of items per page - **sort[by]** (string) - Optional - Field to sort by - **sort[order]** (string) - Optional - Sort order (asc, desc) ### Response #### Success Response (200) - **Result** (Bb.Pub.GetGeoBuyBoxResult) - Success response object ``` -------------------------------- ### Get Brand Scope Source: https://api.smartscout.com/swagger/api/swagger.json Retrieves overall brand scope information. Supports date range filtering. ```APIDOC ## POST /api/brands/scope ### Description Retrieves overall brand scope information. Supports date range filtering. ### Method POST ### Endpoint /api/brands/scope ### Request Body - **brandName** (string) - Optional - The name of the brand. - **subcategoryId** (integer) - Optional - The ID of the subcategory. - **startDate** (string) - Optional - The start date for the scope (ISO 8601 format). - **endDate** (string) - Optional - The end date for the scope (ISO 8601 format). ### Request Example { "brandName": "ExampleBrand", "subcategoryId": 123, "startDate": "2023-01-01T00:00:00Z", "endDate": "2023-12-31T23:59:59Z" } ### Response #### Success Response (200) - **scopeData** (object) - An object containing scope information. - **metric1** (number) - Description of metric 1. - **metric2** (number) - Description of metric 2. #### Response Example { "scopeData": { "metric1": 100, "metric2": 50 } } ``` -------------------------------- ### GET /api/v2/brands/market-share Source: https://api.smartscout.com/swagger/api/swagger.json Retrieves market share data for a specific brand within a given marketplace. Requires an API key. ```APIDOC ## GET /api/v2/brands/market-share ### Description Retrieves market share data for a specific brand within a given marketplace. Requires an API key. ### Method GET ### Endpoint /api/v2/brands/market-share ### Parameters #### Header Parameters - **X-Api-Key** (string) - Required - API key for authentication. #### Query Parameters - **brandName** (string) - Optional - The name of the brand to get market share for. - **marketplace** (string) - Required - The marketplace. Allowed values: US, UK, IT, DE, CA, MX, FR, ES, IN, AU, JP, AE. - **page[id]** (string) - Optional - Identifier for the page. - **page[size]** (string) - Optional - Number of items per page. - **sort[by]** (string) - Optional - Field to sort by. - **sort[order]** (string) - Optional - Order of sorting. Allowed values: asc, desc. ### Response #### Success Response (200) - **schema** (object) - The response schema is defined by `Bb.Pub.PagedSearchResponse` containing market share data. #### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### GET /api/v1/sellers/{AmazonSellerId}/brands Source: https://api.smartscout.com/swagger/api/swagger.json Retrieves a paginated list of brands covered by a specific Amazon seller. ```APIDOC ## GET /api/v1/sellers/{AmazonSellerId}/brands ### Description Retrieves a paginated list of brands for which the specified Amazon seller has coverage. ### Method GET ### Endpoint /api/v1/sellers/{AmazonSellerId}/brands ### Parameters #### Path Parameters - **AmazonSellerId** (string) - Required - The unique identifier of the Amazon seller. #### Query Parameters - **X-Api-Key** (string) - Required - Your API key for authentication. - **marketplace** (string) - Required - The Amazon marketplace identifier (e.g., US, UK, DE). - **page[id]** (string) - Optional - The ID of the page to retrieve. - **page[size]** (integer) - Optional - The number of items per page. - **sort[by]** (string) - Optional - The field to sort the results by. - **sort[order]** (string) - Optional - The order of sorting ('asc' or 'desc'). ### Response #### Success Response (200) - **data** (array) - A list of brand coverage details. - **links** (object) - Pagination links. - **meta** (object) - Metadata about the response. #### Response Example ```json { "data": [ { "brandName": "ExampleBrand", "coveragePercentage": 95.5, "asinCount": 500 } ], "links": { "next": "/api/v1/sellers/AMAZONSELLERID/brands?page[id]=nextPageId" }, "meta": { "totalCount": 100, "currentPage": 1, "pageSize": 10 } } ``` ``` -------------------------------- ### Get Brand Scope Top Products Source: https://api.smartscout.com/swagger/api/swagger.json Retrieves top products for a brand based on specified criteria. Supports date range filtering. ```APIDOC ## POST /api/brands/scope/top-products ### Description Retrieves top products for a brand based on specified criteria. Supports date range filtering. ### Method POST ### Endpoint /api/brands/scope/top-products ### Request Body - **brandName** (string) - Optional - The name of the brand. - **topBy** (string) - Optional - The metric to rank products by (e.g., 'sales', 'views'). - **top** (integer) - Optional - The number of top products to return. - **subcategoryId** (integer) - Optional - The ID of the subcategory. - **startDate** (string) - Optional - The start date for the scope (ISO 8601 format). - **endDate** (string) - Optional - The end date for the scope (ISO 8601 format). ### Request Example { "brandName": "ExampleBrand", "topBy": "sales", "top": 10, "subcategoryId": 123, "startDate": "2023-01-01T00:00:00Z", "endDate": "2023-12-31T23:59:59Z" } ### Response #### Success Response (200) - **topProducts** (array) - An array of top product objects. - **productId** (string) - The ID of the product. - **productName** (string) - The name of the product. - **rank** (integer) - The rank of the product. - **score** (number) - The score based on the 'topBy' metric. #### Response Example { "topProducts": [ { "productId": "prod_abc", "productName": "Awesome Gadget", "rank": 1, "score": 95.5 } ] } ``` -------------------------------- ### POST /api/v1/search-terms/relevant-search-terms/{Asin} Source: https://api.smartscout.com/swagger/api/swagger.json Retrieves a list of relevant search terms for a given product ASIN. ```APIDOC ## POST /api/v1/search-terms/relevant-search-terms/{Asin} ### Description Retrieves relevant search terms associated with a specific product ASIN. ### Method POST ### Endpoint /api/v1/search-terms/relevant-search-terms/{Asin} ### Parameters #### Path Parameters - **Asin** (string) - Required - The product ASIN to retrieve search terms for. #### Query Parameters - **marketplace** (string) - Required - The marketplace code (e.g., US, UK, IT, DE, CA, MX, FR, ES, IN, AU, JP, AE). - **page[id]** (string) - Optional - Page identifier. - **page[size]** (integer) - Optional - Number of items per page. - **sort[by]** (string) - Optional - Field to sort by. - **sort[order]** (string) - Optional - Sort order (asc or desc). #### Request Headers - **X-Api-Key** (string) - Required - API authentication key. ### Response #### Success Response (200) - **Response** (object) - Returns a paged search response containing relevant search terms. ``` -------------------------------- ### GET /api/v1/sellers/{AmazonSellerId}/history Source: https://api.smartscout.com/swagger/api/swagger.json Retrieves the historical data for a specific Amazon seller. ```APIDOC ## GET /api/v1/sellers/{AmazonSellerId}/history ### Description Retrieves historical data for a specific Amazon seller, including parameters for pagination and sorting. ### Method GET ### Endpoint /api/v1/sellers/{AmazonSellerId}/history ### Parameters #### Path Parameters - **AmazonSellerId** (string) - Required - The unique identifier for the Amazon Seller. #### Query Parameters - **marketplace** (string) - Required - The Amazon marketplace identifier (e.g., US, UK, DE). - **page[id]** (string) - Optional - The ID of the page to retrieve. - **page[size]** (string) - Optional - The number of items per page. - **sort[by]** (string) - Optional - The field to sort the results by. - **sort[order]** (string) - Optional - The order of sorting (asc or desc). #### Headers - **X-Api-Key** (string) - Required - Your Smartscout API key. ### Response #### Success Response (200) - **Bb.Pub.PagedSearchResponse`1[[Bb.Pub.SellerHistory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]** (object) - Contains a paginated list of seller history items. #### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### GetRelevantProductsRequest Source: https://api.smartscout.com/swagger/api/swagger.json Schema for retrieving relevant products based on parent ASIN and metrics. ```APIDOC ## POST /GetRelevantProducts ### Description Retrieves a list of relevant products based on a parent ASIN and specified filtering criteria. ### Request Body - **parentAsin** (string) - Optional - The parent ASIN to search for. - **relevancyScore** (Bb.Core.RangeDecimal) - Optional - Filter by relevancy score range. - **commonSearchTerms** (Bb.Core.RangeInt) - Optional - Filter by common search terms range. ``` -------------------------------- ### POST /api/v1/products/{Asin}/history/scope Source: https://api.smartscout.com/swagger/api/swagger.json Sets or updates the scope for retrieving product history. ```APIDOC ## POST /api/v1/products/{Asin}/history/scope ### Description Sets or updates the scope for retrieving product history. This endpoint allows specifying criteria for the product history data to be fetched. ### Method POST ### Endpoint /api/v1/products/{Asin}/history/scope ### Parameters #### Header Parameters - **X-Api-Key** (string) - Required - API key for authentication. #### Path Parameters - **Asin** (string) - Required - The Amazon Standard Identification Number of the product. #### Query Parameters - **marketplace** (string) - Required - The marketplace identifier (e.g., US, UK, IT, DE, CA, MX, FR, ES, IN, AU, JP, AE). - **page[id]** (string) - Optional - The ID for pagination. - **page[size]** (string) - Optional - The number of items per page for pagination. - **sort[by]** (string) - Optional - The field to sort the results by. - **sort[order]** (string) - Optional - The order of sorting (asc or desc). #### Request Body - **startDate** (string) - Optional - The start date for the history scope (ISO 8601 format). - **endDate** (string) - Optional - The end date for the history scope (ISO 8601 format). ### Request Example { "startDate": "2023-01-01T00:00:00Z", "endDate": "2023-12-31T23:59:59Z" } ### Response #### Success Response (200) - **message** (string) - A confirmation message indicating the scope has been updated. #### Response Example { "message": "Product history scope updated successfully." } ``` -------------------------------- ### Get Subcategory Scope Source: https://api.smartscout.com/swagger/api/swagger.json Retrieves the scope of a subcategory, allowing filtering by marketplace and sorting options. ```APIDOC ## POST /api/v1/subcategories/{SubcategoryId}/scope/by-brands ### Description Retrieves the scope of a subcategory, allowing filtering by marketplace and sorting options. ### Method POST ### Endpoint /api/v1/subcategories/{SubcategoryId}/scope/by-brands ### Parameters #### Path Parameters - **SubcategoryId** (string) - Required - The ID of the subcategory. #### Query Parameters - **marketplace** (string) - Required - The marketplace to filter by. Allowed values: US, UK, IT, DE, CA, MX, FR, ES, IN, AU, JP, AE. - **page[id]** (string) - Optional - The ID of the page for pagination. - **page[size]** (string) - Optional - The number of items per page. - **sort[by]** (string) - Optional - The field to sort by. - **sort[order]** (string) - Optional - The order of sorting. Allowed values: asc, desc. #### Request Body - **(object)** - Required - The request body schema is defined by Bb.Pub.GetSubcategoryScopeByBrandsRequest. ### Request Example ```json { "example": "request body" } ``` ### Response #### Success Response (200) - **(object)** - Description - The response contains a paged list of subcategory scope information. #### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### POST /api/v1/search-terms/relevant-products/{Asin} Source: https://api.smartscout.com/swagger/api/swagger.json Retrieves products relevant to a specific ASIN based on search term data. ```APIDOC ## POST /api/v1/search-terms/relevant-products/{Asin} ### Description Retrieves a list of products relevant to the specified ASIN. ### Method POST ### Endpoint /api/v1/search-terms/relevant-products/{Asin} ### Parameters #### Path Parameters - **Asin** (string) - Required - The ASIN to look up #### Header Parameters - **X-Api-Key** (string) - Required - API authentication key #### Query Parameters - **marketplace** (string) - Required - Marketplace code (US, UK, IT, DE, CA, MX, FR, ES, IN, AU, JP, AE) - **page[id]** (integer) - Optional - Page identifier - **page[size]** (integer) - Optional - Number of items per page - **sort[by]** (string) - Optional - Field to sort by - **sort[order]** (string) - Optional - Sort order (asc, desc) ### Request Body - **Bb.Pub.GetRelevantProductsRequest** (object) - Required - Request payload containing relevant product criteria ``` -------------------------------- ### Data Models Overview Source: https://api.smartscout.com/swagger/api/swagger.json This section details the structure of various data models available through the SmartScout API. These models represent different aspects of product performance, seller data, and market insights. ```APIDOC ## Data Models ### Bb.Pub.CustomSegment Represents a custom segment with its ID, name, data type, and creation date. - **id** (string) - Nullable - The unique identifier for the custom segment. - **name** (string) - Nullable - The name of the custom segment. - **dataType** (Bb.CollectionRootDataTypeId) - The data type associated with the segment. - **createdDate** (string, format: date-time) - The date and time when the custom segment was created. ### Bb.Pub.DailyRank Represents the daily ranking information for a product or keyword. - **date** (string, format: date-time) - The date for which the rank is recorded. - **avgRank** (number, format: double) - Nullable - The average rank on the given date. ### Bb.Pub.EstimatedUnitSalesHistory Represents the historical estimated unit sales. - **date** (string, format: date-time) - The date of the sales estimate. - **sales** (number, format: float) - Nullable - The estimated number of units sold. - **coverage** (integer, format: int32) - Nullable - The coverage percentage for the sales estimate. ### Bb.Pub.GeoBuyBoxModel Represents the Buy Box information for a specific geographic location. - **state** (string) - Nullable - The state or region. - **price** (number, format: double) - Nullable - The price of the product. - **isPrime** (boolean) - Nullable - Indicates if the offer is eligible for Prime. - **freeShippingDays** (integer, format: int32) - Nullable - The number of days for free shipping. - **fastestShippingDays** (integer, format: int32) - Nullable - The number of days for the fastest shipping option. - **amazonSellerId** (string) - Nullable - The Seller ID of the Amazon seller. - **sellerName** (string) - Nullable - The name of the seller. - **zipCode** (string) - Nullable - The zip code of the location. ### Bb.Pub.GeoBuyBoxProductModel Represents Buy Box information aggregated for a product across different geographic locations. - **asin** (string) - Nullable - The ASIN of the product. - **buyBoxes** (array) - Nullable - A list of Bb.Pub.GeoBuyBoxModel objects representing Buy Box details for different locations. ### Bb.Pub.GetBrandCoverageByBrandHistoryRequest Request object for retrieving brand coverage history by brand name. - **brandName** (string) - Nullable - The name of the brand. - **startDate** (string, format: date-time) - Nullable - The start date for the history period. - **endDate** (string, format: date-time) - Nullable - The end date for the history period. ### Bb.Pub.GetBrandCoverageBySellerHistoryRequest Request object for retrieving brand coverage history by seller. - **sellerId** (string) - Nullable - The ID of the seller. - **startDate** (string, format: date-time) - Nullable - The start date for the history period. - **endDate** (string, format: date-time) - Nullable - The end date for the history period. ### Example Metrics Data Structure This structure represents various performance metrics, potentially related to advertising or sales. - **topGroupWinRate** (number, format: double) - Nullable - Win rate for top groups. - **topSpotWinRate** (number, format: double) - Nullable - Win rate for top spots. - **sponsoredBrandSpend** (number, format: double) - Nullable - Spend on Sponsored Brands. - **sponsoredVideoSpend** (number, format: double) - Nullable - Spend on Sponsored Videos. - **topSpotSpend** (number, format: double) - Nullable - Spend on top spots. - **topGroupSpend** (number, format: double) - Nullable - Spend on top groups. - **totalAdSpend** (number, format: double) - Nullable - Total advertising spend. - **searchTermValue** (string) - Nullable - The value of the search term. - **estimateSearches** (integer, format: int32) - Estimated number of searches. ``` -------------------------------- ### Relevant Products API Source: https://api.smartscout.com/swagger/api/swagger.json Retrieves a paginated list of relevant products. ```APIDOC ## GET /websites/api_smartscout/products/relevant ### Description Retrieves a paginated list of relevant products. ### Method GET ### Endpoint /websites/api_smartscout/products/relevant ### Query Parameters - **page** (integer) - Optional - The page number to retrieve. - **pageSize** (integer) - Optional - The number of items per page. ### Response #### Success Response (200) - **dataCount** (integer) - The total number of data items. - **paging** (object) - Pagination information. - **data** (array) - An array of relevant product objects. #### Response Example ```json { "dataCount": 100, "paging": { "nextPage": "/websites/api_smartscout/products/relevant?page=2&pageSize=10", "prevPage": null }, "data": [ { "productId": "456", "name": "Related Product A" } ] } ``` ``` -------------------------------- ### GET /api/v2/brands/ad-spy Source: https://api.smartscout.com/swagger/api/swagger.json Retrieves ad-spy search term data for a specific brand in a given marketplace. ```APIDOC ## GET /api/v2/brands/ad-spy ### Description Retrieves ad-spy search term insights for a brand within a specified marketplace. ### Method GET ### Endpoint /api/v2/brands/ad-spy ### Parameters #### Header Parameters - **X-Api-Key** (string) - Required - API authentication key #### Query Parameters - **brandName** (string) - Optional - The name of the brand to search - **marketplace** (string) - Required - The marketplace code (US, UK, IT, DE, CA, MX, FR, ES, IN, AU, JP, AE) - **page[id]** (integer) - Optional - Page number - **page[size]** (integer) - Optional - Number of items per page - **sort[by]** (string) - Optional - Field to sort by - **sort[order]** (string) - Optional - Sort order (asc, desc) ### Response #### Success Response (200) - **Response** (object) - Returns a PagedSearchResponse containing Bb.Pub.BrandSearchTerm data. ``` -------------------------------- ### WeeklyOfferHistory Data Structure Source: https://api.smartscout.com/swagger/api/swagger.json Details the weekly offer history for a product, including sales control and buy box information. ```APIDOC ## Bb.WeeklyOfferHistory ### Description Provides a history of weekly offer data for a product, including sales and buy box control percentages. ### Properties - **endOfWeek** (string, date-time) - The end date of the week for this offer history record. - **sellerId** (string, nullable) - The identifier of the seller. - **isFba** (boolean) - Indicates if the offer is fulfilled by Amazon (FBA). - **avgPrice** (number, double, nullable) - The average selling price during the week. - **buyBoxControlPct** (number, double) - The percentage of time the seller controlled the buy box. - **salesControlPct** (number, double) - The percentage of time the seller controlled sales. - **sales** (integer, int32, nullable) - The total number of units sold during the week. - **revenue** (number, double, nullable) - The total revenue generated during the week. ``` -------------------------------- ### Marketplace Identifiers Source: https://api.smartscout.com/swagger/api/swagger.json Enumerates the supported marketplace identifiers for SmartScout. ```APIDOC ## Bb.Shared.MarketplaceId ### Description An enumeration of supported marketplace identifiers. ### Enum Values - NotSet - US - UK - IT - DE - CA - MX - FR - ES - IN - AU - JP - AE ``` -------------------------------- ### POST /api/v2/brands/history/scope/top-products Source: https://api.smartscout.com/swagger/api/swagger.json Retrieves the top products within a brand's scope history. Requires an API key and specifies the marketplace. ```APIDOC ## POST /api/v2/brands/history/scope/top-products ### Description Retrieves the top products within a brand's scope history. Requires an API key and specifies the marketplace. ### Method POST ### Endpoint /api/v2/brands/history/scope/top-products ### Parameters #### Header Parameters - **X-Api-Key** (string) - Required - API key for authentication. #### Query Parameters - **marketplace** (string) - Required - The marketplace identifier (e.g., US, UK, IT, DE, CA, MX, FR, ES, IN, AU, JP, AE). - **page[id]** (string) - Optional - The ID of the page for pagination. - **page[size]** (string) - Optional - The number of items per page. - **sort[by]** (string) - Optional - The field to sort by. - **sort[order]** (string) - Optional - The order of sorting (asc, desc). ### Request Body - **schema** (object) - Required - The request body schema is defined by `#/components/schemas/Bb.Pub.GetBrandScopeBySubcategoriesRequest` (Note: This seems to be a placeholder, actual schema might differ based on context). ### Response #### Success Response (200) - **schema** (object) - Description - The response schema refers to `#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.BrandScope, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]] (Note: This seems to be a placeholder, actual schema might differ based on context). ``` -------------------------------- ### GET /api/v1/brands/{BrandName}/ad-spy Source: https://api.smartscout.com/swagger/api/swagger.json Retrieves ad spy data for a specific brand. This endpoint is deprecated. ```APIDOC ## GET /api/v1/brands/{BrandName}/ad-spy ### Description Retrieves ad spy data for a specific brand. This endpoint is deprecated. ### Method GET ### Endpoint /api/v1/brands/{BrandName}/ad-spy ### Parameters #### Header Parameters - **X-Api-Key** (string) - Required - API key for authentication. #### Path Parameters - **BrandName** (string) - Required - The name of the brand to retrieve ad spy data for. #### Query Parameters - **marketplace** (string) - Required - The marketplace identifier (e.g., US, UK, DE). - **page[id]** (string) - Optional - The ID of the page for pagination. - **page[size]** (string) - Optional - The number of items per page. - **sort[by]** (string) - Optional - The field to sort by. - **sort[order]** (string) - Optional - The order of sorting (asc or desc). ### Response #### Success Response (200) - **data** (object) - Contains the ad spy data. - **links** (object) - Pagination links. - **meta** (object) - Metadata about the response. ``` -------------------------------- ### POST /api/v1/products/search Source: https://api.smartscout.com/swagger/api/swagger.json Searches for products based on provided criteria and marketplace. ```APIDOC ## POST /api/v1/products/search ### Description Performs a product search operation using a request body for criteria and query parameters for pagination and sorting. ### Method POST ### Endpoint /api/v1/products/search ### Parameters #### Header Parameters - **X-Api-Key** (string) - Required - API authentication key #### Query Parameters - **marketplace** (string) - Required - Marketplace code (US, UK, IT, DE, CA, MX, FR, ES, IN, AU, JP, AE) - **page[id]** (string) - Optional - Page identifier - **page[size]** (string) - Optional - Number of items per page - **sort[by]** (string) - Optional - Field to sort by - **sort[order]** (string) - Optional - Sort order (asc, desc) #### Request Body - **body** (Bb.Pub.SearchProductsRequest) - Required - Search criteria object ### Response #### Success Response (200) - **Result** (Bb.Pub.PagedSearchResponse) - Paged list of products ``` -------------------------------- ### Data Models Overview Source: https://api.smartscout.com/swagger/api/swagger.json Definitions of various data models used in the SmartScout API for product analytics and search requests. ```APIDOC ## Data Models ### ProductSalesRankHistory - **date** (string, date-time) - **asin** (string, nullable) - **salesRank** (integer, int32, nullable) ### RelevantProduct - **asin** (string, nullable) - **brand** (string, nullable) - **commonSearchTerms** (integer, int32) - **relevancyScore** (number, double) ### RelevantSearchTerm - **searchTerm** (string, nullable) - **estimateSearches** (integer, int32) - **relevancy** (number, double) - **intent** (string, nullable) ### RequestGeoBuyBoxRequest - **asins** (array of strings, nullable) ### RequestGeoBuyBoxResponse - **requestId** (string, uuid) - **usage** (Bb.BuyBoxMapUsageModel) - **error** (string, nullable) ### SalesEstimate - **estimated30DaySalesVelocity** (integer, int32, nullable) ### ScopeHistory - **date** (string, date-time) - **buyBoxPrice** (number, float, nullable) - **sales** (number, float, nullable) - **revenue** (number, double, nullable) - **numberOfSellers** (integer, int32, nullable) - **salesRank** (integer, int32, nullable) - **subcategoryRank** (integer, int32, nullable) - **rating** (number, float, nullable) - **reviews** (integer, int32, nullable) ``` -------------------------------- ### Get Brand Sales History Source: https://api.smartscout.com/swagger/api/swagger.json Retrieves overall brand sales history. Supports date range filtering. ```APIDOC ## POST /api/brands/sales ### Description Retrieves overall brand sales history. Supports date range filtering. ### Method POST ### Endpoint /api/brands/sales ### Request Body - **subcategoryId** (integer) - Optional - The ID of the subcategory. - **startDate** (string) - Optional - The start date for the sales history (ISO 8601 format). - **endDate** (string) - Optional - The end date for the sales history (ISO 8601 format). ### Request Example { "subcategoryId": 123, "startDate": "2023-01-01T00:00:00Z", "endDate": "2023-12-31T23:59:59Z" } ### Response #### Success Response (200) - **salesData** (array) - An array of sales data objects. - **date** (string) - The date of the sales record. - **sales** (number) - The sales amount for the given date. #### Response Example { "salesData": [ { "date": "2023-01-01T00:00:00Z", "sales": 1500.50 } ] } ``` -------------------------------- ### Get Brand Scope by Subcategories Source: https://api.smartscout.com/swagger/api/swagger.json Retrieves brand scope information filtered by subcategory. Supports date range filtering. ```APIDOC ## POST /api/brands/scope/subcategories ### Description Retrieves brand scope information filtered by subcategory. Supports date range filtering. ### Method POST ### Endpoint /api/brands/scope/subcategories ### Request Body - **brandName** (string) - Optional - The name of the brand. - **subcategoryId** (integer) - Optional - The ID of the subcategory. - **startDate** (string) - Optional - The start date for the scope (ISO 8601 format). - **endDate** (string) - Optional - The end date for the scope (ISO 8601 format). ### Request Example { "brandName": "ExampleBrand", "subcategoryId": 123, "startDate": "2023-01-01T00:00:00Z", "endDate": "2023-12-31T23:59:59Z" } ### Response #### Success Response (200) - **scopeData** (object) - An object containing scope information. - **metric1** (number) - Description of metric 1. - **metric2** (number) - Description of metric 2. #### Response Example { "scopeData": { "metric1": 100, "metric2": 50 } } ``` -------------------------------- ### Schemas Overview Source: https://api.smartscout.com/index.html This section lists the available data schemas used throughout the SmartScout API. These schemas define the structure of data objects for various entities like brands, products, sales history, and more. ```APIDOC ## Schemas This API utilizes the following data schemas: - BuyBoxMapUsageModel - CollectionRootDataTypeId - Condition - DateFilter - ListFilter`1 - RangeDecimal - RangeFilter - RangeInt - TextFilter - Brand - BrandCoverage - BrandCoverageByBrandHistory - BrandSalesHistory - BrandScope - BrandScopeBySubcategory - BrandSearchTerm - CustomSegment - DailyRank - EstimatedUnitSalesHistory - GeoBuyBoxModel - GeoBuyBoxProductModel - GetBrandCoverageByBrandHistoryRequest - GetBrandCoverageBySellerHistoryRequest - GetBrandSalesHistoryBySubcategoriesRequest - GetBrandSalesHistoryBySubcategoriesV2Request - GetBrandSalesHistoryRequest - GetBrandSalesHistoryV2Request - GetBrandScopeBySubcategoriesRequest - GetBrandScopeRequest - GetBrandScopeTopProductsRequest - GetBrandTopProductsSalesHistoryRequest - GetBrandTopProductsSalesHistoryV2Request - GetBrandTopProductsSalesRankHistoryRequest - GetBrandTopProductsSalesRankHistoryV2Request - GetGeoBuyBoxResult - GetOfferHistoryResponse - GetOrganicRanksRequest - GetProductHistoryScopeRequest - GetRelevantProductsRequest - GetRelevantSearchTermsRequest - GetSearchTermHistoryRequest - GetSubcategoryBrandsRequest - GetSubcategorySalesHistoryByBrandsRequest - GetSubcategorySalesHistoryRequest - GetSubcategoryScopeByBrandsRequest - GetSubcategoryScopeRequest - GetSubcategoryScopeTopProductsRequest - GetSubcategoryTopProductsSalesHistoryRequest - GetSubcategoryTopProductsSalesRankHistoryRequest - PagedSearchResponse[Brand] - PagedSearchResponse[BrandCoverage] - PagedSearchResponse[BrandCoverageByBrandHistory] - PagedSearchResponse[BrandSalesHistory] - PagedSearchResponse[BrandScope] - PagedSearchResponse[BrandScopeBySubcategory] - PagedSearchResponse[BrandSearchTerm] - PagedSearchResponse[CustomSegment] - PagedSearchResponse[EstimatedUnitSalesHistory] - PagedSearchResponse[Product] - PagedSearchResponse[ProductHistory] - PagedSearchResponse[ProductOffer] - PagedSearchResponse[ProductSalesHistory] - PagedSearchResponse[ProductSalesRankHistory] - PagedSearchResponse[RelevantProduct] - PagedSearchResponse[RelevantSearchTerm] - PagedSearchResponse[ScopeHistory] - PagedSearchResponse[SearchTerm] - PagedSearchResponse[SearchTermBrand] - PagedSearchResponse[SearchTermHistory] - PagedSearchResponse[SearchTermProductRank] - PagedSearchResponse[Seller] - PagedSearchResponse[SellerHistory] - PagedSearchResponse[SellerOffer] - PagedSearchResponse[Subcategory] - PagedSearchResponse[SubcategoryBrand] - PagedSearchResponse[SubcategorySalesHistory] - PagedSearchResponse[SubcategoryScope] - PagedSearchResponse[SubcategoryScopeByBrand] - PagedSearchResponse[TopProductScope] - Paging - Product - ProductHistory - ProductOffer - ProductSalesHistory - ProductSalesRankHistory - RelevantProduct - RelevantSearchTerm - RequestGeoBuyBoxRequest - RequestGeoBuyBoxResponse - SalesEstimate - ScopeHistory - SearchBrandsRequest - SearchBrandsV2Request - SearchCustomSegmentsRequest - SearchProductsRequest - SearchSearchTermsRequest - SearchSellersRequest - SearchSubcategoriesRequest - SearchTerm - SearchTermBrand - SearchTermHistory - SearchTermProductRank - Seller - SellerHistory - SellerOffer - Subcategory - SubcategoryBrand - SubcategorySalesHistory - SubcategoryScope - SubcategoryScopeByBrand - TopProductScope - MarketplaceId - WeeklyOfferHistory ```