HomeDocumentationCode SamplesAPI ReferenceAnnouncementsModelsRelease NotesFAQGitHubVideos
Developer HubAPI StatusSupport
API Reference
Developer HubAPI StatusSupport
Start typing to search…

getQuery

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

Returns query details for the query specified by the queryId parameter. See the createQuery operation for details about query retention.

Usage Plan:

Rate (requests per second)Burst
2.015

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.

Path Params
string
required

The query identifier.

Responses

Response body
object
string
required

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

string
required

The submitted query.

date-time
required

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

string
required

The processing status of the query.

CANCELLED DONE FATAL IN_PROGRESS IN_QUEUE

Show Details
CANCELLEDThe query was cancelled before it began processing.
DONEThe query has completed processing.
FATALThe query was aborted due to a fatal error.
IN_PROGRESSThe query is being processed.
IN_QUEUEThe query has not yet started processing. It may be waiting for another `IN_PROGRESS` query.
date-time

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

date-time

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

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.

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.

string

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

Headers
object
string

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

string

Unique request reference identifier.

Updated 3 months ago

Did this page help you?
Language

Updated 3 months ago

Did this page help you?