amzn / selling-partner-api-models

This repository contains OpenAPI models for developers to use when developing software to call Selling Partner APIs.
Apache License 2.0
580 stars 730 forks source link

Getting Page Sales and Traffic reports using Reports API #1230

Closed yiweixia closed 1 year ago

yiweixia commented 3 years ago

If I go to Seller Central, under Reports I can go:

Reports -> Business Reports -> By ASIN -> Detail Page Sales and Traffic

which takes me to a page where I can download a CSV which details page views by ASIN. I can't seem to find a similar report using the SP API. Please correct me if I'm mistaken, but it seems like the reports offered by the Reports API don't line up with the reports shown on the Seller Central dashboard.

I've checked a few of the inventory reports/performance reports, but those don't contain the info I'm looking for.

If these reports are currently available via the API, could we document the mapping of SC reports <-> API call better?

If it's not, could you make them available?

yiweixia commented 3 years ago

@ShivikaK @rugved1991 Any idea if this is a planned feature?

We'd like to offer an aggregated dashboard to the brands we work with, and having them manually download these reports from seller central and re-upload to our site for multiple ASINs is a painful process we want to avoid.

bigearIsSoNice commented 3 years ago

SP-API doent support 'the detail page sales and traffic report' ? SO BAD !

tspicer commented 3 years ago

The is a highly requested set of data for sellers and vendors. +1 for it to be added to the API

RushaliChanneled commented 3 years ago

Manually downloading these reports every time is not the ideal way. This data should be available via the API

54Ezreal commented 3 years ago

I also need this report, but don't found right type

54Ezreal commented 3 years ago

If I go to Seller Central, under Reports I can go:

Reports -> Business Reports -> By ASIN -> Detail Page Sales and Traffic

which takes me to a page where I can download a CSV which details page views by ASIN. I can't seem to find a similar report using the SP API. Please correct me if I'm mistaken, but it seems like the reports offered by the Reports API don't line up with the reports shown on the Seller Central dashboard.

I've checked a few of the inventory reports/performance reports, but those don't contain the info I'm looking for.

If these reports are currently available via the API, could we document the mapping of SC reports <-> API call better?

If it's not, could you make them available?

Have you solved this problem ?

PG408 commented 3 years ago

The is a highly requested,

cccaimingjian commented 3 years ago

+1

steven-so commented 2 years ago

@yiweixia @HuUncle

Has anyone found a way to get this information from the sp-api?

I'm trying to figure out a way to get sessions, units ordered, sales, and such, by sku for specific dates. Is there any way to do that from the SP-API, or an alternative good solution? Thank you.

tspicer commented 2 years ago

@steven-so , at the moment this is not available via the MWS or SP-API. Also, it is not clear exactly where this type of information, if it is released, will land. For example, I have seen a trend where this type of business level reporting/metrics are showing up more on the Amazon Ads side of the house. IMHO, I don't care if it is SP-API, Ads API or some other API but a different team at Amazon, it is important performance level data.

steven-so commented 2 years ago

@tspicer Thanks for your reply. That is unfortunate.

fractalakash commented 2 years ago

@yiweixia Any updates whether we can download details sales and traffic data by ASIN via API ?

ciocca-dev commented 2 years ago

+1

durimjusaj commented 2 years ago

+1

weickdev commented 2 years ago

+1

jimmy-ross-xapix commented 2 years ago

+1

JeromeXapix commented 2 years ago

+1

finnmeier23 commented 2 years ago

+1

JacobFunnel commented 2 years ago

+1

phil-kramer commented 2 years ago

+1

kzpreneur17 commented 2 years ago

+1

Javadebi commented 2 years ago

+1

david-mcbacon commented 2 years ago

+1

yigal-mish commented 2 years ago

+1

ewitmer commented 2 years ago

+1

cccaimingjian commented 2 years ago

This report looks like coming soon, developer-docs website has "Sales and Traffic Business Report" already. But I got an error "message": "Access to the resource is forbidden" when I try to get it. Here is the docs link, if you can get this report , please let us know. https://developer-docs.amazon.com/sp-api/docs/report-type-values#seller-retail-analytics-reports

ShivikaK commented 2 years ago

Hello @cccaimingjian

Thank you for sharing this concern. The report type is under Brand Analytics role which is also now available for all developers.

  1. Please review your developer profile in Seller Central to select this role.
  2. Then Edit your app to add this role to your application and re-authorize the app.

Once you complete the two steps, you should be able to make a successful request for this report.

If error persists, please open a support case with us to get additional assistance.

Thanks, Shivika Khare Selling Partner API Developer Support

stefnats commented 2 years ago

Hi @ShivikaK Thanks for the new report type. Just want to say thanks for all the effort the Developers have put into this API. I have the feeling that in MWS times there was little effort to make the devs happier, but this turned around. Yes, the API is a bit difficult to get into and not battlefield tested for years, but I feel like it's getting there.

nassuf commented 2 years ago

Hello @ShivikaK Thanks for informations ! I unfortunately cant found the "Brand Analytics" role in the europe seller central.

Is there anything to do to get this role ?

ShivikaK commented 2 years ago

Hello @nassuf

Did you review your developer profile here?

  1. In the Partner Network menu, click Develop Apps.
  2. Click the Your Developer Profile link.
  3. The Brand Analytics role needs to be selected in the profile and the profile needs to be saved.
  4. Once the role is added to your profile, you can then edit the app and select the role for the app.
  5. Make sure to re-authorize the app after saving the app changes.

Please let me know if issue persists.

Thanks, Shivika Khare Selling Partner API Developer Support

callumb123 commented 2 years ago

@ShivikaK How long does it normally take to get approval at each stage? I updated my developer profile to add the new Brand Analytics role around 11 days ago and haven't had any update (case ID: 7691521102). I'm just aware if we wait weeks for this approval we might need to wait weeks again when we edit our app.

tspicer commented 2 years ago

hey @callumb123 , we just got approved and it took a few weeks. I assume they are backed up.

ShotaTakahashiPro commented 2 years ago

Hey guys! Our developer profile got approved for the Brand Analytics role but the report returns empty data. Could you help me to figure out the issue? Thank you!

// Source Code ... await sellingPartner.callAPI({ operation:'createReport', body:{ reportType:'GET_SALES_AND_TRAFFIC_REPORT', marketplaceIds:marketplace_ids, dataEndTime:'2022-03-31T00:00:00+00:00', dataStartTime:'2022-03-01T00:00:00+00:00', reportOptions: {dateGranularity:"MONTH", asinGranularity:"CHILD"} } }); ... let res_reports = await sellingPartner.callAPI({ operation:'getReports', query:{ reportTypes:'GET_SALES_AND_TRAFFIC_REPORT', MarketplaceIds:marketplace_ids, dataEndTime:'2022-03-31T00:00:00+00:00', dataStartTime:'2022-03-01T00:00:00+00:00', reportOptions: {dateGranularity:"MONTH", asinGranularity:"CHILD"} } });

// Console log ... [{"reportType":"GET_SALES_AND_TRAFFIC_REPORT","processingEndTime":"2022-04-08T02:13:36+00:00","processingStatus":"DONE","marketplaceIds":["APJ6JRA9NG5V4"],"reportDocumentId":"amzn1.spdoc.1.3.2fb0e3ef-492f-48d4-8094-9f3630750364.T2NZQ8AYL0BMHH.44900","reportId":"177022019090","dataEndTime":"2022-03-31T00:00:00+00:00","createdTime":"2022-04-08T02:13:23+00:00","processingStartTime":"2022-04-08T02:13:27+00:00","dataStartTime":"2022-03-01T00:00:00+00:00"}] ... []

shirushi-dev commented 2 years ago

from Japan

[403] { "errors": [ { "code": "Unauthorized", "message": "Access to the resource is forbidden", "details": "" } ]

kenyonduan commented 2 years ago

@ShivikaK

Hi ShivikaK

I saw this sentence in the document: Note: If you have a published hybrid SP-API application you must relist your application before reauthorization.

Does this mean that my application needs to be re-approved? and will I be able to access the Sp-API during the approval period?

philmccarty commented 2 years ago

I understand that users will need to re-authorize if they authorised the traditional way, but do they also need to re-authorize if this was a hybrid app that they migrated from?

PG408 commented 2 years ago

from Japan

[403] { "errors": [ { "code": "Unauthorized", "message": "Access to the resource is forbidden", "details": "" } ]

Have u solve this problem? @shirushi-dev

shirushi-dev commented 2 years ago

@PG408 NO... I keep getting authentication errors.

PG408 commented 2 years ago

We just solve this problem, you can add a new app, and use it call api, remember cleack the brand ✓ for your developer profile and app profile both.

From 减法


From: shirushi-dev @.> Sent: Tuesday, July 26, 2022 11:59:13 AM To: amzn/selling-partner-api-docs @.> Cc: PG408 @.>; Mention @.> Subject: Re: [amzn/selling-partner-api-docs] Getting Page Sales and Traffic reports using Reports API (#614)

@PG408https://nam12.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2FPG408&data=05%7C01%7C%7C3b8d519d00554611318408da6ebb345b%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C637944047553535017%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=sevdPz0CudLx8FR7DPO8QBbSNLD9j5jVjOr4ScaYuSU%3D&reserved=0 NO... I keep getting authentication errors.

— Reply to this email directly, view it on GitHubhttps://nam12.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Famzn%2Fselling-partner-api-docs%2Fissues%2F614%23issuecomment-1194969836&data=05%7C01%7C%7C3b8d519d00554611318408da6ebb345b%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C637944047553535017%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=t9ImIBUqUeo8Q8p3PN90nsu3TgT%2FpXf2NniV%2BLLDANw%3D&reserved=0, or unsubscribehttps://nam12.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fnotifications%2Funsubscribe-auth%2FAE2FYCRB2FATVE5JCVBHGU3VV5PBDANCNFSM43CIXMCQ&data=05%7C01%7C%7C3b8d519d00554611318408da6ebb345b%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C637944047553535017%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=lj1lMilag3sMuPskE09dSsDGurS2DMcO2NYhVptaoJE%3D&reserved=0. You are receiving this because you were mentioned.Message ID: @.***>

shirushi-dev commented 2 years ago

@PG408 I found the Brand Analysis section under "Edit App." Until now, it was not there. I ✅ed it. Thanks. I will report back.

mrvaita commented 2 years ago

Hello, I have a question about getting Traffic reports. According to the documentation it should be possible to pass multiple marketplaceIds to the request specified as < string > array. However, submitting multiple marketplaceIds with struncture [marketplaceId1, marketplaceId2, ...] produces the following error:

"errors": [                                                                                                                                                                                         
    {                                                                                                                                                                                                 
      "code": "InvalidInput",                                                                                                                                                                         
      "message": "Report rejected for this client. Multiple marketplaces were provided for this report type that can only be applied to one marketplace at a time. Please retry with only one marketplace per request.",                                                                                                                                                                                    
      "details": ""                                                                                                                                                                                   
    }                                                                                                                                                                                                 
  ]

This is not mentioned in the reportType description. Therefore, I would like to ask whether someone can confirm that it is not possible to submit requests for GET_SALES_AND_TRAFFIC_REPORT reports with multiple marketplaceIds. Thank you very much in advance for your time and help.

kingsun-he commented 1 year ago

We just solve this problem, you can add a new app, and use it call api, remember cleack the brand ✓ for your developer profile and app profile both. From 减法 ____ From: shirushi-dev @.> Sent: Tuesday, July 26, 2022 11:59:13 AM To: amzn/selling-partner-api-docs @.> Cc: PG408 @.>; Mention @.> Subject: Re: [amzn/selling-partner-api-docs] Getting Page Sales and Traffic reports using Reports API (#614) @PG408https://nam12.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2FPG408&data=05%7C01%7C%7C3b8d519d00554611318408da6ebb345b%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C637944047553535017%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=sevdPz0CudLx8FR7DPO8QBbSNLD9j5jVjOr4ScaYuSU%3D&reserved=0 NO... I keep getting authentication errors. — Reply to this email directly, view it on GitHubhttps://nam12.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Famzn%2Fselling-partner-api-docs%2Fissues%2F614%23issuecomment-1194969836&data=05%7C01%7C%7C3b8d519d00554611318408da6ebb345b%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C637944047553535017%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=t9ImIBUqUeo8Q8p3PN90nsu3TgT%2FpXf2NniV%2BLLDANw%3D&reserved=0, or unsubscribehttps://nam12.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fnotifications%2Funsubscribe-auth%2FAE2FYCRB2FATVE5JCVBHGU3VV5PBDANCNFSM43CIXMCQ&data=05%7C01%7C%7C3b8d519d00554611318408da6ebb345b%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C637944047553535017%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=lj1lMilag3sMuPskE09dSsDGurS2DMcO2NYhVptaoJE%3D&reserved=0. You are receiving this because you were mentioned.Message ID: @.***>

After half an hour after I re-authorized, it works. We have to be patient. We don't need to create a new app.

RestricePlanoax commented 1 year ago

Hello @cccaimingjian

Thank you for sharing this concern. The report type is under Brand Analytics role which is also now available for all developers.

  1. Please review your developer profile in Seller Central to select this role.
  2. Then Edit your app to add this role to your application and re-authorize the app.

Once you complete the two steps, you should be able to make a successful request for this report.

If error persists, please open a support case with us to get additional assistance.

Thanks, Shivika Khare Selling Partner API Developer Support

@ShivikaK

Hi @ShivikaK , I am unable to access seller central "GET_SALES_AND_TRAFFIC_REPORT" report , because of this error

{ "errors": [ { "code": "InvalidInput", "message": "Report type 44900 does not support account ID of type class com.amazon.partner.account.id.VendorGroupId.", "details": "" } ] }

can you please help here, your help will be very very much appreciated.

rugved1991 commented 1 year ago

Closing this thread as this report type is now publicly available to use. Please open a new issue using the templates if you have any other questions.

Best, Rugved Solutions Architect, SP API

ElyeM commented 1 year ago

kenyonduan Does this mean that my application needs to be re-approved? and will I be able to access the Sp-API during the approval period?

@kenyonduan Have you found an answer to this?

Were you able to use SP-API after adding this role before it was re approved?