Mindsite API (0.0.0)

Download OpenAPI specification:Download

To be added

Rnr

Ratings and reviews bulk endpoints for rating, review, and review text exports.

Rating Detail Bulk

Rating Bulk API - File Specification

Returns rating data as a downloadable bulk file.

Supported file encodings: csv, ndjson. If no encoding is provided, the API uses csv.

File columns

Column	Type	Description
`product_id`	string	Customer product identifier.
`retailer_name`	string	Retailer where the product is listed.
`product_rating`	float	Average product rating.
`rating_count`	integer	Number of ratings collected for the product.
`session_time`	string (ISO 8601 UTC)	Collection session timestamp.
`crawling_time`	string (ISO 8601 UTC)	Timestamp when the product page was crawled.
`product_url`	string	Product detail page URL.
`mindsite_sku_id`	string	Internal Mindsite SKU identifier.
`mindsite_sku_name`	string	Internal Mindsite SKU name.
`brand`	string	Product brand.
`is_own_product`	boolean	Whether the product belongs to the customer.
`product_barcode`	string	Product barcode.
`tags`	JSON array	Tag objects in `{ "tag_name": string, "tag_value": string }` format.

query Parameters

date	string (Date) Date in YYYY-MM-DD format.
time	integer (Time) Hour in 24 hour format.
encoding	string (Encoding) Default: "csv" Enum: "csv" "ndjson" Example: encoding=ndjson Encoding of the downloaded file. Supported values: csv, ndjson. Use ndjson for JSON line output.

header Parameters

x-api-key

required

string (X-Api-Key)

Responses

Response samples

200
404
422

Content type

application/json

{"product_id": "SKU-001",
"retailer_name": "Retailer A",
"product_rating": 4.6,
"rating_count": 128,
"session_time": "2026-06-30T10:00:00Z",
"crawling_time": "2026-06-30T10:12:08Z",
"product_url": "https://www.example.com/products/sku-001",
"mindsite_sku_id": "MS-1001",
"mindsite_sku_name": "Example Shampoo 500 ml",
"brand": "Example Brand",
"is_own_product": true,
"product_barcode": "8690000000012",
"tags": [{"tag_name": "category",
"tag_value": "hair-care"
}
]
}

Rating Bulk Files

Returns available bulk files for this RnR dataset. Use the listed date, time, and encoding values to request a specific file.

header Parameters

x-api-key

required

string (X-Api-Key)

Responses

Response samples

200
422

Content type

application/json

{"files": [{"file_name": "rating_2026-06-30_10.ndjson",
"date": "2026-06-30",
"time": "10",
"encoding": "ndjson"
},
{"file_name": "rating_2026-06-30_10.csv",
"date": "2026-06-30",
"time": "10",
"encoding": "csv"
}
]
}

Review Detail Bulk

Review Bulk API - File Specification

Returns review metadata and review-level ratings as a downloadable bulk file.

Supported file encodings: csv, ndjson. If no encoding is provided, the API uses csv.

File columns

Column	Type	Description
`product_id`	string	Customer product identifier.
`retailer_name`	string	Retailer where the review was collected.
`review_id`	string	Unique identifier of the review on the retailer.
`review_title`	string	Review title, if available.
`review_rating`	float	Rating submitted with the review.
`review_date`	string (date)	Date shown for the review.
`reviewer_name`	string	Reviewer display name, if available.
`is_verified_purchase`	boolean	Whether the retailer marks the review as verified.
`session_time`	string (ISO 8601 UTC)	Collection session timestamp.
`crawling_time`	string (ISO 8601 UTC)	Timestamp when the review was crawled.
`product_url`	string	Product detail page URL.
`mindsite_sku_id`	string	Internal Mindsite SKU identifier.
`mindsite_sku_name`	string	Internal Mindsite SKU name.
`brand`	string	Product brand.
`tags`	JSON array	Tag objects in `{ "tag_name": string, "tag_value": string }` format.

query Parameters

date	string (Date) Date in YYYY-MM-DD format.
time	integer (Time) Hour in 24 hour format.
encoding	string (Encoding) Default: "csv" Enum: "csv" "ndjson" Example: encoding=ndjson Encoding of the downloaded file. Supported values: csv, ndjson. Use ndjson for JSON line output.

header Parameters

x-api-key

required

string (X-Api-Key)

Responses

Response samples

200
404
422

Content type

application/json

{"product_id": "SKU-001",
"retailer_name": "Retailer A",
"review_id": "RVW-9001",
"review_title": "Works well",
"review_rating": 5,
"review_date": "2026-06-28",
"reviewer_name": "Example User",
"is_verified_purchase": true,
"session_time": "2026-06-30T10:00:00Z",
"crawling_time": "2026-06-30T10:14:22Z",
"product_url": "https://www.example.com/products/sku-001",
"mindsite_sku_id": "MS-1001",
"mindsite_sku_name": "Example Shampoo 500 ml",
"brand": "Example Brand",
"tags": [{"tag_name": "category",
"tag_value": "hair-care"
}
]
}

Review Bulk Files

Returns available bulk files for this RnR dataset. Use the listed date, time, and encoding values to request a specific file.

header Parameters

x-api-key

required

string (X-Api-Key)

Responses

Response samples

200
422

Content type

application/json

{"files": [{"file_name": "review_2026-06-30_10.ndjson",
"date": "2026-06-30",
"time": "10",
"encoding": "ndjson"
},
{"file_name": "review_2026-06-30_10.csv",
"date": "2026-06-30",
"time": "10",
"encoding": "csv"
}
]
}

Review Text Detail Bulk

Review Text Bulk API - File Specification

Returns review text content as a downloadable bulk file.

Supported file encodings: csv, ndjson. If no encoding is provided, the API uses csv.

File columns

Column	Type	Description
`product_id`	string	Customer product identifier.
`retailer_name`	string	Retailer where the review text was collected.
`review_id`	string	Unique identifier of the review on the retailer.
`review_text`	string	Full review text.
`review_language`	string	Detected or source language code, if available.
`review_date`	string (date)	Date shown for the review.
`session_time`	string (ISO 8601 UTC)	Collection session timestamp.
`crawling_time`	string (ISO 8601 UTC)	Timestamp when the review text was crawled.
`product_url`	string	Product detail page URL.
`mindsite_sku_id`	string	Internal Mindsite SKU identifier.
`mindsite_sku_name`	string	Internal Mindsite SKU name.
`brand`	string	Product brand.
`tags`	JSON array	Tag objects in `{ "tag_name": string, "tag_value": string }` format.

query Parameters

date	string (Date) Date in YYYY-MM-DD format.
time	integer (Time) Hour in 24 hour format.
encoding	string (Encoding) Default: "csv" Enum: "csv" "ndjson" Example: encoding=ndjson Encoding of the downloaded file. Supported values: csv, ndjson. Use ndjson for JSON line output.

header Parameters

x-api-key

required

string (X-Api-Key)

Responses

Response samples

200
404
422

Content type

application/json

{"product_id": "SKU-001",
"retailer_name": "Retailer A",
"review_id": "RVW-9001",
"review_text": "Leaves hair soft after the first wash.",
"review_language": "en",
"review_date": "2026-06-28",
"session_time": "2026-06-30T10:00:00Z",
"crawling_time": "2026-06-30T10:14:22Z",
"product_url": "https://www.example.com/products/sku-001",
"mindsite_sku_id": "MS-1001",
"mindsite_sku_name": "Example Shampoo 500 ml",
"brand": "Example Brand",
"tags": [{"tag_name": "category",
"tag_value": "hair-care"
}
]
}

Review Text Bulk Files

Returns available bulk files for this RnR dataset. Use the listed date, time, and encoding values to request a specific file.

header Parameters

x-api-key

required

string (X-Api-Key)

Responses

Response samples

200
422

Content type

application/json

{"files": [{"file_name": "review_text_2026-06-30_10.ndjson",
"date": "2026-06-30",
"time": "10",
"encoding": "ndjson"
},
{"file_name": "review_text_2026-06-30_10.csv",
"date": "2026-06-30",
"time": "10",
"encoding": "csv"
}
]
}

RSA

Review Sentiment Analysis data in Nexus. The public API exposes RSA through the Review Sentiment Bulk endpoint.

Review Sentiment Bulk

Review Sentiment Bulk API - File Specification

Returns Review Sentiment Analysis (RSA) data as a downloadable bulk file. In the public Nexus API, RSA is exposed through this review sentiment bulk endpoint.

Supported file encodings: csv, ndjson. If no encoding is provided, the API uses csv.

File columns

Column	Type	Description
`product_id`	string	Customer product identifier.
`retailer_name`	string	Retailer where the review was collected.
`review_id`	string	Unique identifier of the review.
`review_text`	string	Full review text used for sentiment analysis.
`sentiment`	string	Overall sentiment label, such as positive, neutral, or negative.
`sentiment_score`	float	Numerical sentiment confidence or score.
`topics`	JSON array	Detected sentiment topics.
`review_date`	string (date)	Date shown for the review.
`session_time`	string (ISO 8601 UTC)	Collection session timestamp.
`product_url`	string	Product detail page URL.
`mindsite_sku_id`	string	Internal Mindsite SKU identifier.
`brand`	string	Product brand.

query Parameters

date	string (Date) Date in YYYY-MM-DD format.
time	integer (Time) Hour in 24 hour format.
encoding	string (Encoding) Default: "csv" Enum: "csv" "ndjson" Example: encoding=ndjson Encoding of the downloaded file. Supported values: csv, ndjson. Use ndjson for JSON line output.

header Parameters

x-api-key

required

string (X-Api-Key)

Responses

Response samples

200
404
422

Content type

application/json

{"product_id": "SKU-001",
"retailer_name": "Retailer A",
"review_id": "RVW-9001",
"review_text": "Leaves hair soft after the first wash.",
"sentiment": "positive",
"sentiment_score": 0.94,
"topics": ["performance",
"texture"
],
"review_date": "2026-06-28",
"session_time": "2026-06-30T10:00:00Z",
"product_url": "https://www.example.com/products/sku-001",
"mindsite_sku_id": "MS-1001",
"brand": "Example Brand"
}

Scorecard

Scorecard raw analytics endpoint.

Scorecard

Returns raw scorecard rows for the selected date range. If scorecard_title is not provided, the first available scorecard is returned.

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.
scorecard_title	string (Scorecard Title.) Scorecard Title.

header Parameters

x-api-key

required

string (X-Api-Key)

Responses

Response samples

200
422

Content type

application/json

[{"retailer": "Retailer A",
"brand": "Example Brand",
"mindsite_sku_id": "MS-1001",
"mindsite_sku_name": "Example Shampoo 500 ml",
"average_rating": 4.6,
"review_count": 128,
"start_date": "2026-06-01",
"end_date": "2026-06-30"
}
]

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

200
422

Content type

application/json

{"items": [{"csku_id": "string",
"product_title": "string",
"barcode": "string",
"brand_name": "string",
"is_own_brand": true,
"tags": [{"tag_name": "string",
"tag_value": "string"
}
],
"retailer": "string",
"retailer_country": "string",
"product_id": "string",
"merchant_name": "string",
"url": "string",
"is_psku": true,
"is_main_merchant": true,
"currency": "string",
"availability": 1,
"buybox_position": 0,
"price": 0,
"price_2": 0,
"discount_amount": 0,
"cargo_fee": 0,
"promotion_text": "string",
"crawling_time": "2019-08-24T14:15:22Z",
"date": "2019-08-24"
}
],
"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

200
422

Content type

application/json

null

Price Bulk Files

header Parameters

x-api-key

required

string (X-Api-Key)

Responses

Response samples

200
422

Content type

application/json

{"files": [{"file_name": "string",
"date": "2019-08-24",
"time": "string",
"encoding": "string"
}
]
}

Price Bulk Hourly

📄 Price Hourly Bulk API - CSV Format Specification

The Price Hourly Bulk API returns hourly pricing snapshots 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 listed price of the product.
`product_price_2`	float	Listed price without discount, if available.
`product_price_with_promo`	float	Promotional price associated with `product_price`, if available.
`product_price_2_with_promo`	float	Promotional price associated with `product_price_2`, 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 or position of the product in the buybox.
`session_time`	string (ISO 8601 UTC)	ISO 8601 UTC timestamp when the hourly snapshot was collected.
`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 or power SKU.
`product_barcode`	string	Barcode of the product (for example 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

200
422

Content type

application/json

null

Price Bulk Hourly Files

header Parameters

x-api-key

required

string (X-Api-Key)

Responses

Response samples

200
422

Content type

application/json

{"files": [{"file_name": "string",
"date": "2019-08-24",
"time": "string",
"encoding": "string"
}
]
}

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

200
422

Content type

application/json

{"competitions": [{"competition_id": "5ee56a00-3041-4e70-b8e4-5d8b7d4bc11c",
"base": {"product": {"brand_name": "string",
"is_customer_brand": true,
"barcode": "string",
"csku_title": "string",
"csku_id": "string",
"tags": [{"tag_name": "string",
"tag_value": "string"
}
],
"product_image_url": "string",
"product_url": "string",
"product_id": "string"
},
"group_type": "STATIC_GROUP",
"name": "string",
"number_of_products": 0,
"retailer": "string",
"merchant_type": "BUYBOX"
},
"benchmark": {"product": {"brand_name": "string",
"is_customer_brand": true,
"barcode": "string",
"csku_title": "string",
"csku_id": "string",
"tags": [{"tag_name": "string",
"tag_value": "string"
}
],
"product_image_url": "string",
"product_url": "string",
"product_id": "string"
},
"group_type": "STATIC_GROUP",
"name": "string",
"number_of_products": 0,
"retailer": "string",
"merchant_type": "BUYBOX"
},
"coloring_levels": {"target_min": 0,
"target_max": 0,
"margin": 0
},
"date_buckets": [{"start_date": "2019-08-24",
"end_date": "2019-08-24",
"data": [{"standard": {"rrp_index": 0,
"rrp_positivity": "POSITIVE",
"rsp_index": 0,
"rsp_positivity": "POSITIVE",
"rrp_depth_of_promotion": 0,
"rsp_depth_of_promotion": 0,
"base": {"status": "NO_DATA",
"rrp_value": "POSITIVE",
"rsp_value": "POSITIVE"
},
"benchmark": {"status": "NO_DATA",
"rrp_value": "POSITIVE",
"rsp_value": "POSITIVE"
}
},
"with_oos": {"rrp_index": 0,
"rrp_positivity": "POSITIVE",
"rsp_index": 0,
"rsp_positivity": "POSITIVE",
"rrp_depth_of_promotion": 0,
"rsp_depth_of_promotion": 0,
"base": {"status": "NO_DATA",
"rrp_value": "POSITIVE",
"rsp_value": "POSITIVE"
},
"benchmark": {"status": "NO_DATA",
"rrp_value": "POSITIVE",
"rsp_value": "POSITIVE"
}
},
"base": 0,
"base_2": 0,
"base_min_info": {"is_min_price": true,
"min_merchant": "string",
"is_min_price_2": true,
"min_merchant_2": "string"
},
"base_status": "NO_DATA",
"benchmark": 0,
"benchmark_2": 0,
"benchmark_min_info": {"is_min_price": true,
"min_merchant": "string",
"is_min_price_2": true,
"min_merchant_2": "string"
},
"benchmark_status": "NO_DATA",
"index": 0,
"rsp_index": 0,
"rrp_index": 0,
"positivity": "POSITIVE",
"rsp_positivity": "POSITIVE",
"rrp_positivity": "POSITIVE",
"depth_of_promotion": 0
}
]
}
]
}
]
}

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

200
422

Content type

application/json

{"items": [{"visibility_source_name": "string",
"visibility_source_id": 0,
"representative_name": "string",
"is_power_visibility_source": true,
"searched_brand": "string",
"searched_brand_group": "string",
"is_own_brand": true,
"retailer_scores": [{"retailer_name": "string",
"retailer_code": "string",
"retailer_country": "string",
"own_product_count": 0,
"total_product_count": 0,
"score": 1,
"target": 0,
"is_target_met": true
}
]
}
],
"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

200
422

Content type

application/json

{"items": [{"search_product_id": 0,
"barcode": "string",
"brand_name": "string",
"retailer_name": "string",
"retailer_code": "string",
"product_id": "string",
"csku_title": "string",
"is_customer_brand": true,
"is_psku": true,
"product_keywords": [{"search_keyword_id": 0,
"search_keyword_name": "string",
"position": 0,
"combined_position": 0,
"page_no": 0,
"target": 0,
"is_on_target": true,
"is_no_data": true
}
]
}
],
"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

200
422

Content type

application/json

{"visibility_source_name": "string",
"visibility_source_url": "string",
"searched_brand": "string",
"searched_brand_group": "string",
"is_own_brand": true,
"listings": [{"product_id": "string",
"product_title": "string",
"product_url": "string",
"product_image_url": "string",
"brand_name": "string",
"merchant_name": "string",
"merchant_score": 0,
"is_searched_brand": true,
"is_sponsored": true,
"position": 0,
"combined_position": 0,
"page_no": 0,
"max_product_count_in_page": 0,
"product_count_in_page": 0,
"crawling_time": "2019-08-24T14:15:22Z"
}
]
}

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

200
422

Content type

application/json

{"items": [{"retailer_name": "string",
"page_type": "string",
"page_name": "string",
"page_url": "string",
"page_preview_image_url": "string",
"e_retail_media_position": 0,
"e_retail_media_url": "string",
"own_label_count": 0,
"competitor_label_count": 0,
"own_labels": [{"category": "string",
"subcategory": "string",
"brand": "string"
}
],
"competitor_labels": [{"category": "string",
"subcategory": "string",
"brand": "string"
}
],
"e_retail_media_types": ["string"
]
}
],
"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

200
422

Content type

application/json

null

Price Bulk Files

header Parameters

x-api-key

required

string (X-Api-Key)

Responses

Response samples

200
422

Content type

application/json

{"files": [{"file_name": "string",
"date": "2019-08-24",
"time": "string",
"encoding": "string"
}
]
}

Healthcheck

Responses

Response samples

200

Content type

application/json

null