Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
1 task done
cscrewvala opened this issue Sep 27, 2023 · 0 comments
Open
1 task done

Comments

@cscrewvala
Copy link

Is there an existing issue for this?

  • I have searched the existing issues

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

@github-project-automation github-project-automation bot moved this to 🆕 Ready for Grooming in Commerce - Issues Sep 27, 2023
@dobooth dobooth moved this from 🆕 Ready for Grooming to 🔖 Ready for Development in Commerce - Issues Nov 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 🔖 Ready for Development
Development

No branches or pull requests

1 participant