getQueries

get https://sellingpartnerapi-na.amazon.com/dataKiosk/2023-11-15/queries

Returns details for the Data Kiosk queries that match the specified filters. See the createQuery operation for details about query retention.

Usage Plan:

Rate (requests per second)	Burst
0.0222	10

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

Query Params

processingStatuses

array of strings

length ≥ 1

A list of processing statuses used to filter queries.

Show Details

CANCELLED	The query was cancelled before it began processing.
DONE	The query has completed processing.
FATAL	The query was aborted due to a fatal error.
IN_PROGRESS	The query is being processed.
IN_QUEUE	The query has not yet started processing. It may be waiting for another `IN_PROGRESS` query.

processingStatuses

pageSize

integer

1 to 100

Defaults to 10

The maximum number of queries to return in a single call.

createdSince

date-time

The earliest query creation date and time for queries to include in the response, in ISO 8601 date time format. The default is 90 days ago.

createdUntil

date-time

The latest query creation date and time for queries to include in the response, in ISO 8601 date time format. The default is the time of the getQueries request.

paginationToken

string

A token to fetch a certain page of results when there are multiple pages of results available. The value of this token is fetched from the pagination.nextToken field returned in the GetQueriesResponse object. All other parameters must be provided with the same values that were provided with the request that generated this token, with the exception of pageSize which can be modified between calls to getQueries. In the absence of this token value, getQueries returns the first page of results.

200

Success.

Response body

object

queries

array of objects

required

A list of queries.

queries*

object

queryId

string

required

The query identifier. This identifier is unique only in combination with a selling partner account ID.

query

string

required

The submitted query.

createdTime

date-time

required

The date and time when the query was created, in ISO 8601 date time format.

processingStatus

string

required

The processing status of the query.

CANCELLED DONE FATAL IN_PROGRESS IN_QUEUE

Show Details

CANCELLED	The query was cancelled before it began processing.
DONE	The query has completed processing.
FATAL	The query was aborted due to a fatal error.
IN_PROGRESS	The query is being processed.
IN_QUEUE	The query has not yet started processing. It may be waiting for another `IN_PROGRESS` query.

processingStartTime

date-time

The date and time when the query processing started, in ISO 8601 date time format.

processingEndTime

date-time

The date and time when the query processing completed, in ISO 8601 date time format.

dataDocumentId

string

The data document identifier. This identifier is only present when there is data available as a result of the query. This identifier is unique only in combination with a selling partner account ID. Pass this identifier into the getDocument operation to get the information required to retrieve the data document's contents.

errorDocumentId

string

The error document identifier. This identifier is only present when an error occurs during query processing. This identifier is unique only in combination with a selling partner account ID. Pass this identifier into the getDocument operation to get the information required to retrieve the error document's contents.

pagination

object

When a query produces results that are not included in the data document, pagination occurs. This means the results are divided into pages. To retrieve the next page, you must pass a CreateQuerySpecification object with paginationToken set to this object's nextToken and with query set to this object's query in the subsequent createQuery request. When there are no more pages to fetch, the nextToken field will be absent.

pagination

object

When a request has results that are not included in this response, pagination occurs. This means the results are divided into pages. To retrieve the next page, you must pass the nextToken as the paginationToken query parameter in the subsequent getQueries request. All other parameters must be provided with the same values that were provided with the request that generated this token, with the exception of pageSize which can be modified between calls to getQueries. When there are no more pages to fetch, the nextToken field will be absent.

nextToken

string

A token that can be used to fetch the next page of results.

Headers

object

x-amzn-RateLimit-Limit

string

Your rate limit (requests per second) for this operation.

x-amzn-RequestId

string

Unique request reference identifier.

400

Request has missing or invalid parameters and cannot be parsed.

403

Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.

404

The resource specified does not exist.

413

The request size exceeded the maximum accepted size.

415

The request payload is in an unsupported format.

429

The frequency of requests was greater than allowed.

500

An unexpected condition occurred that prevented the server from fulfilling the request.

503

Temporary overloading or maintenance of the server.

xxxxxxxxxx
 
{
  "queries": [
    {
      "queryId": "string",
      "query": "string",
      "createdTime": "2025-04-02T20:12:28.112Z",
      "processingStatus": "CANCELLED",
      "processingStartTime": "2025-04-02T20:12:28.112Z",
      "processingEndTime": "2025-04-02T20:12:28.112Z",
      "dataDocumentId": "string",
      "errorDocumentId": "string",
      "pagination": {
        "nextToken": "string"
      }
    }
  ],
  "pagination": {
    "nextToken": "string"
  }
}

200Success.

400Request has missing or invalid parameters and cannot be parsed.

403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.

404The resource specified does not exist.

413The request size exceeded the maximum accepted size.

415The request payload is in an unsupported format.

429The frequency of requests was greater than allowed.

500An unexpected condition occurred that prevented the server from fulfilling the request.

503Temporary overloading or maintenance of the server.