Skip to main content
API docs by Redocly

Mindsite API (0.0.0)

Download OpenAPI specification:Download

To be added

Price

Price

query Parameters
date
required
string (Date)

Date in YYYY-MM-DD format. Use 9999-12-31 for latest data.

calculation_type
string (Calculation Type)
Default: "AVG"
Enum: "LAST" "MIN_PRICE" "MAX_PRICE" "AVG"

LAST selection configures data with latest crawling time in selected date. MIN_PRICE selection configures data with minimum price in selected date. MAX_PRICE selection configures data with maximum price in selected date. AVG selection configures data with average price in selected date.

page_size
integer (Page Size)
Default: 10
current_page
integer (Current Page)
Default: 1
header Parameters
x-api-key
required
string (X-Api-Key)

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0,
  • "page_size": 0,
  • "current_page": 0,
  • "page_count": 0
}

Price Bulk

📄 Price Bulk API - CSV Format Specification

The Price Bulk API returns pricing data in bulk CSV format.

Column Definitions

Column Name Data Type Description
product_id string Unique identifier for the product.
retailer_name string Name of the retailer where the product is listed.
merchant_name string Name of the merchant offering the product.
product_price float Current price of the product.
unit_price float Price per unit (e.g., per liter, per kg) if applicable.
product_price_2 float Secondary listed price (e.g., from another merchant or time).
product_price_3 float Tertiary listed price, if available.
in_stock boolean (true/false) Indicates whether the product is in stock.
cargo_fee float Shipping or cargo fee for the product.
promotion_text string Promotional text or campaign info shown on the product page.
is_buybox boolean (true/false) Indicates if the product holds the buybox position.
buybox_position integer Rank/position of the product in the buybox.
session_time string (ISO 8601 UTC) ISO 8601 UTC timestamp when the crawling session started.
crawling_time string (ISO 8601 UTC) ISO 8601 UTC timestamp when the data was crawled.
product_url string Full URL of the product detail page.
mindsite_sku_id string Internal SKU ID assigned by Mindsite.
mindsite_sku_name string Internal SKU name used in Mindsite systems.
brand string Brand of the product.
is_own_product boolean (true/false) Indicates if the product belongs to the customer (true) or a competitor (false).
is_power_sku boolean (true/false) Indicates whether the product is considered a key/power SKU.
product_barcode string Barcode of the product (e.g., EAN or UPC).
main_merchants JSON list (string) JSON array of merchant names considered "main merchants".
tags JSON list (object) JSON array of tag objects: { "tag_name": string, "tag_value": string }.
query Parameters
date
string (Date)

Date in YYYY-MM-DD format.

time
integer (Time)

Hour in 24 hour format.

encoding
string (Encoding)
Default: "csv"

Encoding of the file. Supported values: csv, ndjson.

header Parameters
x-api-key
required
string (X-Api-Key)

Responses

Response samples

Content type
application/json
null

Price Bulk Files

header Parameters
x-api-key
required
string (X-Api-Key)

Responses

Response samples

Content type
application/json
{
  • "files": [
    ]
}

Price Competition

path Parameters
customer_page_id
required
integer (Customer Page Id)
query Parameters
start_date
required
string (Start Date)

Start date in format YYYY-MM-DD

end_date
required
string (End Date)

End date in format YYYY-MM-DD

time_dimension
string (EnumTimeDimension)
Default: "DAILY"
Enum: "DAILY" "WEEKLY" "QUARTERLY" "MONTHLY" "YEARLY" "NONE"

Time dimension for the data

price_type
string (EnumPriceType)
Default: "TOTAL"
Enum: "TOTAL" "UNIT"

Price type for the competition. TOTAL or UNIT

header Parameters
x-api-key
required
string (X-Api-Key)

Responses

Response samples

Content type
application/json
{
  • "competitions": [
    ]
}

Visibility

Visibility Scores

query Parameters
visibility_type
required
string (Visibility Type)
Enum: "SEARCH" "CATEGORY"
date
required
string (Date)

Date in YYYY-MM-DD format.

first_n_products
integer (First N Products)
Default: 20

Number of products to be considered.

position_type
string (EnumPositionType)
Default: "OVERALL"
Enum: "ORGANIC" "SPONSORED" "OVERALL"

ORGANIC selection configures data with organic visibility. SPONSORED selection configures data with sponsored visibility. OVERALL selection configures data with overall visibility.

page_size
integer (Page Size)
Default: 10
current_page
integer (Current Page)
Default: 1
header Parameters
x-api-key
required
string (X-Api-Key)

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0,
  • "page_size": 0,
  • "current_page": 0,
  • "page_count": 0
}

Visibility Search By Product

query Parameters
start_date
required
string (Start Date)

Start Date in YYYY-MM-DD format.

end_date
required
string (End Date)

End Date in YYYY-MM-DD format.

position_type
string (EnumPositionType)
Default: "OVERALL"
Enum: "ORGANIC" "SPONSORED" "OVERALL"

ORGANIC selection configures data with organic visibility. SPONSORED selection configures data with sponsored visibility. OVERALL selection configures data with overall visibility.

page_size
integer (Page Size)
Default: 10
current_page
integer (Current Page)
Default: 1
header Parameters
x-api-key
required
string (X-Api-Key)

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0,
  • "page_size": 0,
  • "current_page": 0,
  • "page_count": 0,
  • "start_date": "2019-08-24",
  • "end_date": "2019-08-24"
}

Visibility Listings

query Parameters
visibility_type
required
string (Visibility Type)
Enum: "SEARCH" "CATEGORY"
visibility_source_id
required
integer (Visibility Source Id)
retailer_code
required
string (Retailer Code)
date
required
string (Date)

Date in YYYY-MM-DD format.

first_n_products
integer (First N Products)
Default: 20

Number of products to be considered.

position_type
string (EnumPositionType)
Default: "OVERALL"
Enum: "ORGANIC" "SPONSORED" "OVERALL"

ORGANIC selection configures data with organic visibility. SPONSORED selection configures data with sponsored visibility. OVERALL selection configures data with overall visibility.

header Parameters
x-api-key
required
string (X-Api-Key)

Responses

Response samples

Content type
application/json
{
  • "visibility_source_name": "string",
  • "visibility_source_url": "string",
  • "searched_brand": "string",
  • "searched_brand_group": "string",
  • "is_own_brand": true,
  • "listings": [
    ]
}

E Retail Media

E Retail Media

query Parameters
date
required
string (Date)

Date in YYYY-MM-DD format.

first_n_e_retail_media
integer (First N E Retail Media)
Default: 20

Number of e-retail media to be considered.

relevance
string (Relevance)
Default: "RELEVANT"
Enum: "RELEVANT" "ALL"

RELEVANT selection filters banners with own or competitor products. ALL selection brings all banners.

page_size
integer (Page Size)
Default: 10
current_page
integer (Current Page)
Default: 1
header Parameters
x-api-key
required
string (X-Api-Key)

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0,
  • "page_size": 0,
  • "current_page": 0,
  • "page_count": 0
}

Content

Content Detail Bulk

query Parameters
date
string (Date)

Date in YYYY-MM-DD format.

time
integer (Time)

Hour in 24 hour format.

encoding
string (Encoding)
Default: "csv"

Encoding of the file. Supported values: csv, ndjson.

header Parameters
x-api-key
required
string (X-Api-Key)

Responses

Response samples

Content type
application/json
null

Price Bulk Files

header Parameters
x-api-key
required
string (X-Api-Key)

Responses

Response samples

Content type
application/json
{
  • "files": [
    ]
}

Rnr

Rating Detail Bulk

query Parameters
date
string (Date)

Date in YYYY-MM-DD format.

time
integer (Time)

Hour in 24 hour format.

encoding
string (Encoding)
Default: "csv"

Encoding of the file. Supported values: csv, ndjson.

header Parameters
x-api-key
required
string (X-Api-Key)

Responses

Response samples

Content type
application/json
null

Rating Bulk Files

header Parameters
x-api-key
required
string (X-Api-Key)

Responses

Response samples

Content type
application/json
{
  • "files": [
    ]
}

Review Detail Bulk

query Parameters
date
string (Date)

Date in YYYY-MM-DD format.

time
integer (Time)

Hour in 24 hour format.

encoding
string (Encoding)
Default: "csv"

Encoding of the file. Supported values: csv, ndjson.

header Parameters
x-api-key
required
string (X-Api-Key)

Responses

Response samples

Content type
application/json
null

Review Bulk Files

header Parameters
x-api-key
required
string (X-Api-Key)

Responses

Response samples

Content type
application/json
{
  • "files": [
    ]
}

Review Text Detail Bulk

query Parameters
date
string (Date)

Date in YYYY-MM-DD format.

time
integer (Time)

Hour in 24 hour format.

encoding
string (Encoding)
Default: "csv"

Encoding of the file. Supported values: csv, ndjson.

header Parameters
x-api-key
required
string (X-Api-Key)

Responses

Response samples

Content type
application/json
null

Review Text Bulk Files

header Parameters
x-api-key
required
string (X-Api-Key)

Responses

Response samples

Content type
application/json
{
  • "files": [
    ]
}

Healthcheck

Responses

Response samples

Content type
application/json
null