| The Promotions API is only available to those with a Market Share subscription. |
Building your API Link
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/promos_csv?X-API-KEY=API_KEY_GOES_HERE&period=DATE_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:
4 weeks to date rolling:
https://marketshareapi.ascentialedge.com/users/USER_UUID_GOES_HERE/reports/v2/promos_csv?X-API-KEY=API_KEY_GOES_HERE&period=toDate4Week
Custom date range:
https://marketshareapi.ascentialedge.com/users/USER_UUID_GOES_HERE/reports/v2/promos_csv?X-API-KEY=API_KEY_GOES_HERE&period=custom&start_date=2020-05-15&end_date=2021-04-26
|
Note: The date range you add to the URL is case sensitive. 'toDate4Week' will return data, 'todate4week' will not. |
What's Included in the Export
The Promotions API will provide you with the following information data:
-
ASIN
-
Name
-
Manufacturer
-
Brand
-
Product Classifications
-
Promotion Title
-
Promotion Type
-
Start Date
-
End Date
-
Discount Amount
-
Promotion Link
Connecting Your API Link to Excel, Tableau, Looker, etc.
For assistance leveraging or connecting your Promotions API link to any of your tools, speak with your internal IT department on feasibility & guidance .
Comments
0 comments
Please sign in to leave a comment.