AdobeDocs / commerce-services

Source of the Commerce Services developer guide
https://developer.adobe.com/commerce/services/
Other
2 stars 10 forks source link

Provide Overview comments about Raw Data Exports vs Figure exports #68

Open cscrewvala opened 11 months ago

cscrewvala commented 11 months ago

Is there an existing issue for this?

Which topic?

https://developer.adobe.com/commerce/services/reporting/export-api/#raw-data-exports

What's wrong with the content?

Raw Data exports are only available as zip compressed CSV files, where as Report exports (Figure or Chart) are available as CSV files or direct JSON objects. A few extra lines of explanation would be beneficial on the page to advise the basic outline of operations and to set expectations, as has been included on many other pages in Adobe documentation. Appreciate it might repeat some material already on the page but it helps tie it together and direct the user to the relevant section for their purpose.

What changes do you propose?

You might update the info box beneath Raw Data Exports to say a little more: “ Raw Data Exports are zip-compressed CSV file containing the whole raw data of a specified data warehouse table, that can be generated via the Manage Data > Raw Data Exports tool in MBI, or via the Create a Raw Data Export of a Table API call (though note that Raw Data Exports created via API will not be listed in the Raw Data Exports section of MBI, only the export created via the MBI application itself). The Raw Data Export zip file can then be exported via the Get A Specific Export API call, using the Export ID.

In order to return data directly in JSON format, you can instead stage the required data in a Report, then export the Report data using the Figure ID (or Chart ID for Charts created via the cohort report builder) using the relevant API calls listed below, in which you can specify to export in JSON format. ”

Anything else that can help to cover this?

No response