Data Kiosk API FAQ

Frequently asked questions about Data Kiosk

How is Data Kiosk different from the Reports API?

Select to expand the answer.

Some features of Data Kiosk that differentiate it from the Reports API include:

Detailed, interactive documentation: All data set schemas and data field definitions within Data Kiosk are publicly available. Data Kiosk also provides an interactive Schema Explorer complete with documentation and a query builder, which allows you to build custom queries to request custom reports.
Domain-based datasets: Data Kiosk uses GraphQL, which allows dynamic report generation and advanced filtering and querying capabilities. You no longer have to call multiple reports, slice, and reconstruct them to create the schema that suits your needs.
Schema updates: Data Kiosk uses GraphQL for a schema-first approach, which allows for continuous evolution of interfaces and safe data field updates. In this way, report schemas can be updated without breaking your integration.
Reporting format: Data Kiosk provides all results in JSONL (JSON Lines) format, reducing the complexity of parsing.
Pagination: Data Kiosk provides a nextToken that can be used in subsequent requests to retrieve the next page of data when size limits are exceeded.
Security: Data Kiosk request visibility is limited to requests submitted by a given application, ensuring the security of selling partner data.

In addition to this, Data Kiosk only allows one request per query / selling partner / application combination. If there is already a pending request for a given query / selling partner / application combination, the createQuery request will fail.

Will the Reports API be deprecated?

Select to expand the answer.

Yes.

Data Kiosk has all the functionality that the Reports API currently has and more. Reports within the Reports API will be deprecated after they are onboarded to Data Kiosk. You can find up-to-date deprecation dates in the SP-API deprecations table. Eventually, Data Kiosk will be the standard reporting platform for selling partner data.

What data can I get in Data Kiosk?

Select to expand the answer.

Data Kiosk currently hosts the following data:

Seller Sales and Traffic
Vendor Analytics
Economics

For more details on the available datasets, refer to the schema explorer.

How does Data Kiosk keep selling partner data secure?

Select to expand the answer.

Each field available with Data Kiosk requires a certain role. Data Kiosk determines whether the requester has the required role(s) for each field in the query upon query creation. This authorization paradigm is much more granular than the Reports API. Additionally, queries are only visible to the requester.

How do I get started with Data Kiosk?

Select to expand the answer.

Go to the Data Kiosk user guide to get started with Data Kiosk.

What roles are required to access Data Kiosk?

Select to expand the answer.

Data Kiosk follows the standard role assignment and approval guidelines for all Selling Partner APIs. To find details of Selling Partner API roles and the approval process, refer to Roles in the Selling Partner API.

Where is Data Kiosk available?

Select to expand the answer.

Data Kiosk is available globally in all SP-API Regions, including NA, EU, and FE.

How can I stay informed about new dataset launches in Data Kiosk?

Select to expand the answer.

You can find details of all the datasets available in Data Kiosk in the Data Kiosk Schema Explorer. Be on the lookout for new dataset launch announcements in your inbox as well as on the Selling Partner API announcements page.

Can I request that certain data be available through Data Kiosk?

Select to expand the answer.

Yes. You can submit your feedback on GitHub by opening an issue with the Data Request label.

Updated about 1 month ago