Data Kiosk Use Case Guide

POST https://sellingpartnerapi-na.amazon.com/dataKiosk/2023-11-15/queries
{
  "query": "{analytics_salesAndTraffic_2023_11_15{salesAndTrafficByDate(startDate:\"2023-01-01\" endDate:\"2023-10-31\" aggregateBy:DAY marketplaceIds:[\"ATVPDKIKX0DER\"]){endDate marketplaceId startDate traffic{averageOfferCount browserPageViews averageParentItems browserPageViewsB2B browserSessions}sales{averageSalesPerOrderItem{amount currencyCode}averageSalesPerOrderItemB2B{amount currencyCode}averageSellingPrice{amount currencyCode}claimsGranted refundRate unitsOrderedB2B unitsRefunded unitsShipped}}}}"
}

POST https://sellingpartnerapi-na.amazon.com/dataKiosk/2023-11-15/queries
{
  "query": "{analytics_salesAndTraffic_2023_11_15{salesAndTrafficByAsin(startDate:\"2023-01-01\" endDate:\"2023-10-31\" aggregateBy:PARENT marketplaceIds:[\"ATVPDKIKX0DER\"]){childAsin endDate marketplaceId parentAsin sales{orderedProductSales{amount currencyCode}totalOrderItems totalOrderItemsB2B}sku startDate traffic{browserPageViews browserPageViewsB2B browserPageViewsPercentage browserPageViewsPercentageB2B browserSessionPercentage unitSessionPercentageB2B unitSessionPercentage}}}}"
}

{
  "queryId": "012345678901"
}

GET https://sellingpartnerapi-na.amazon.com/dataKiosk/2023-11-15/documents/DOC-b8b0-4226-b4b9-0ee058ea5760

{
  "documentId": "DOC-b8b0-4226-b4b9-0ee058ea5760",
  "documentUrl": "https://d34o8swod1owfl.cloudfront.net/SampleResult%2BKey%3DSample%2BINITVEC%3D58+fa+bf+a7+08+11+95+0f+c1+a8+c6+e0+d5+6f+ae+c8"
}

// DownloadExample.java
// This example is for use with the Selling Partner API for Data Kiosk, Version: 2023-11-15

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.nio.charset.StandardCharsets;

import com.squareup.okhttp.OkHttpClient;
import com.squareup.okhttp.Request;
import com.squareup.okhttp.Response;
import com.squareup.okhttp.ResponseBody;

/**
 * Example that downloads a Data Kiosk document.
 */
public class DownloadExample {

    public static void main(String[] args) {
        String url = "<URL from the getDocument response>";

        DownloadExample obj = new DownloadExample();
        try {
            obj.download(url);
        } catch (IOException e) {
            // Handle exceptions here.
            e.printStackTrace();
        }
    }

    /**
     * Download the document from the given Amazon Simple Storage Service (Amazon S3) URL.
     *
     * @param url the signed Amazon S3 URL to retrieve the document from.
     * @throws IOException when there is an error reading the response.
     */
    public void download(String url) throws IOException {
        OkHttpClient httpclient = new OkHttpClient();
        Request request = new Request.Builder()
                .url(url)
                .get()
                .build();

        Response response = httpclient.newCall(request).execute();
        if (!response.isSuccessful()) {
            System.out.printf("Call to download content was unsuccessful with response code: %d and message: %s%n",
                    response.code(), response.message());
            return;
        }

        try (ResponseBody responseBody = response.body();
              InputStream inputStream = responseBody.byteStream();
              // Note: If the Data Kiosk document is compressed, the 'Content-Encoding' header will indicate the
              // compression algorithm. Most HTTP clients are capable of automatically decompressing downloaded files
              // based on the 'Content-Encoding' header.
              // More Information: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding
              //
              // The OkHttp client will automatically set the "Accept-Encoding" header and respect the
              // "Content-Encoding" header, so it is not required to unzip the stream.
              // For clients which do not automatically decompress, wrapping the stream in a GZIP stream may be
              // required, for example:
              // InputStream unzippedInputStream = new GZIPInputStream(inputStream);
              InputStreamReader inputStreamReader = new InputStreamReader(inputStream, StandardCharsets.UTF_8);
              BufferedReader reader = new BufferedReader(inputStreamReader)) {
            String line;
            while ((line = reader.readLine()) != null) {
                // Process line by line.
                System.out.println(line);
            }
        }
    }
}