| The 3rd Party API is only available to those with a Market Share subscription. |
Building Your Request
Below is the default request URL. Exchange the bolded fields for their requirements - details on where to find or how to format the required fields is available below.
-
https://marketshareapi.ascentialedge.com/users/USER_UUID_GOES_HERE/reports/v2/3p_csv?period=toDate4Week&own_data=TRUE_OR_FALSE&X-API-KEY=API_KEY_GOES_HERE
The above includes a parameter for including own or competitive data (&own_data=). In this field, you will need to enter true or false. Some example scenarios include:
-
You want to pull own 3p data:
https://marketshareapi.ascentialedge.com/users/USER_UUID_GOES_HERE/reports/v2/3p_csv?period=toDate4Week&own_data=true&X-API-KEY=API_KEY_GOES_HERE
-
You want to pull only competitive 3p data:
https://marketshareapi.ascentialedge.com/users/USER_UUID_GOES_HERE/reports/v2/3p_csv?period=toDate4Week&own_data=false&X-API-KEY=API_KEY_GOES_HERE
-
You want a standard 3p combined own/comp data set, exclude the parameter:
https://marketshareapi.ascentialedge.com/users/USER_UUID_GOES_HERE/reports/v2/3p_csv?period=toDate4Week&X-API-KEY=API_KEY_GOES_HERE
Get your UUID (Unique User Id) & API Key
Set a Date Range
The supported time periods are outlined below, this includes instructions for setting a custom time frame. Enter the text from the "What to include in your API link" after the =
|
Desired Timeframe: |
What to include in your API link after = |
|
Current Month |
month |
|
Current Quarter |
quarter |
|
Year to Date |
year |
|
4 Weeks to date rolling |
toDate4Week |
|
13 Weeks to date rolling |
toDate13Week |
|
26 Weeks to date rolling |
toDate26Week |
|
52 Weeks to date rolling |
toDate52Week |
|
13 Months to date rolling |
toDate13 |
|
25 Months to date rolling |
toDate25 |
|
Custom date range |
custom&start_date =YYYY-MM-DD&end_date=YYYY-MM-DD |
Examples:
|
Note: The date range you add to the URL is case sensitive. 'toDate4Week' will return data, 'todate4week' will not. |
4 weeks to date rolling: https://marketshareapi.ascentialedge.com/users/USER_UUID_GOES_HERE/reports/v2/3p_csv?X-API-KEY=API_KEY_GOES_HERE&period=toDate4Week
Custom date range:
https://marketshareapi.ascentialedge.com/users/USER_UUID_GOES_HERE/reports/v2/3p_csv?X-API-KEY=API_KEY_GOES_HERE&period=custom&start_date=2020-05-15&end_date=2021-04-26
What's Included in the Export
-
ASIN
-
Name
-
Manufacturer
-
Brand
-
Product Classifications
-
Merchant
-
3P Sales
-
3P Units
-
% Merchant Buy Box
Comments
0 comments
Please sign in to leave a comment.