Data Kiosk API

You use the Data Kiosk API to submit GraphQL queries for data from a variety of schemas to help selling partners manage their businesses.

Data Kiosk currently hosts Seller Sales and Traffic Data. Find details of the dataset in the schema explorer.

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

Release notes

• January 29, 2025
• December 18, 2024
• September 25, 2024
• June 19, 2024

To learn more about the terms that are used in this guide, refer to Terminology.

Key features

• Data Kiosk can return a data document or an error document in the response of the getQuery operation. It can also return no document in the case that the query was successful but no data was returned.
  • The data document contains the output in JSONL format when a successful request is processed with DONE processing status.
  • The error document is in JSON format and contains the error message for an unsuccessful request with FATAL processing status.
• A processingStatus of DONE with no errorDocumentId or dataDocumentId in the response of the getQuery operation means that the request completed with no data or that there is no data for the given date range. Retry the request with different parameters.
• The Data Kiosk API does not support query scheduling.
• The Data Kiosk API does not support query backlogging. Data Kiosk limits the number of concurrent non-terminal queries per selling partner and per GraphQL query.

⭐

Tip

To request new data availability, you can submit your feedback on GitHub by opening an issue with the Data Request label.

You can find details of all the datasets available in Data Kiosk in the Data Kiosk Schema Explorer. New dataset launch announcements are posted to the Selling Partner API announcements page.

Data Kiosk API versus Reports API

Some features of Data Kiosk that differentiate it from Reports 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.

📘

Note

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.

Use cases

The following use case examples are available for the Easy Ship API:

• Request and filter data with a GraphQL query: Create and confirm a query request and get the information required to retrieve the result.
• Verify that query processing is complete: Monitor and verify the query processing status.

Roles

Each field available with Data Kiosk requires a certain role. Data Kiosk determines whether the requester has the required roles 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.

Data Kiosk follows the standard role assignment and approval guidelines for all Selling Partner APIs.

cancelQuery

Attribute	Value
Regions	NA, EU, FE
Required roles (need at least one)	Brand Analytics

createQuery

Attribute	Value
Regions	NA, EU, FE
Required roles (need at least one)	Brand Analytics

getDocument

Attribute	Value
Regions	NA, EU, FE
Required roles (need at least one)	Brand Analytics

getQueries

Attribute	Value
Regions	NA, EU, FE
Required roles (need at least one)	Brand Analytics

getQuery

Attribute	Value
Regions	NA, EU, FE
Required roles (need at least one)	Brand Analytics