Skip to main content
GET
Read Materialized Query Status

Authorizations

Authorization
string
header
required

Use the Authorization header with the value 'Bearer ' to authenticate. Partner API Keys have full access; Project API Keys are limited to their project scope. Learn more: https://docs.peaka.com/api-reference/authentication

Path Parameters

projectId
string
required

ID of the Project

queryId
string
required

ID of the Query

Response

200 - application/json

Materialized query status

Status and schedule information for a materialized query

queryId
string

ID of the query

Example:

"709922802836177297"

queryName
string

Name of the query

Example:

"samplequery"

scheduleSettings
object | null

Schedule configuration of a materialized query. Provide EITHER an interval schedule (type=interval with repeatDuration) OR a cron schedule (type=cron with cronExpression and optional timezone). Use type=none for no schedule. The fields that do not apply to the chosen type are omitted.

Example:
nextExecutionStartTime
string | null

Next scheduled execution start time (ISO 8601). Null when the schedule type is 'none' or cannot be computed.

Example:

"2025-01-15T16:00:00Z"

status
string

Status of the most recent refresh

Example:

"COMPLETED"

lastExecutionStartTime
string | null

Start time of the last refresh (ISO 8601)

Example:

"2025-01-15T10:00:00Z"

lastUpdateTime
string | null

Time the status was last updated (ISO 8601)

Example:

"2025-01-15T10:05:00Z"