Skip to main content

Get status of a submitted query

GET 
/query/:queryId/status

Check the status of a previously-submitted query.

Queries are processed asynchronously, so may take some time to complete depending on system demand and query complexity. You should check the status of your query regularly until it reaches a final state (FINISHED or FAILED).

Status information for a query (identified by :queryId) can only be accessed by the user who originally submitted it.

Required scope(s): [data.chf:query, data.indices:query]

Request​

Path Parameters

    queryId stringrequired

    Unique identifier of the query.

    Example: 4DDC21D9-E30C-458A-80E2-642CA3238541

Responses​

Success - latest status for the specified query.

Schema
    queryId string

    Unique identifier of the query.

    status string

    Possible values: [SUBMITTED, IN_PROGRESS, RUNNING, COMPLETED, FAILED, CANCELLED]

    Current status of the query.

    requestedAt date-time

    Timestamp denoting when query was submitted.

    totalRecordCount integer

    Total number of records available in the result (only available when status is FINISHED).

    updatedAt date-time

    Timestamp denoting when query status was last updated.

    expiresAt date-time

    Timestamp denoting when query results will expire (only available when status is FINISHED).

    error string

    Details of the error if query failed (only available when status is FAILED).

Loading...