Skip to main content
POST
Run a materialized view refresh now

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

dataset_id
integer
required

Unique identifier for a dataset.

Body

application/json
type
enum<string>
required

full will skip progress tracking and run the materialized view from scratch, incremental will use the progress tracking.

Available options:
full,
incremental
execution_cluster
object
compute_pool_id
string<uuid>

The ID of the compute pool to use for this refresh. The compute pool must be active, belong to your company, and be associated with the target data plane. If not specified, falls back to the compute pool configured on the refresh schedule (if any).

Response

The refresh job. It has the same shape as the job POST /nql/run returns for a CREATE MATERIALIZED VIEW statement.

A job that builds a materialized view.

id
string<uuid>
required

Unique identifier for the job.

company_id
integer<int64>
required

Company that ran the job.

Example:

345

created_at
string<date-time>
required

The timestamp representing when the job was created.

failures
object[]
required

causes of job failure

idempotency_key
string
required

The unique ID associated with the job.

request_source
object
required

Who asked for the job. Discriminated by type: api_user for a job requested through the API on behalf of a user, process for one enqueued by a Narrative process.

Example:
state
enum<string>
required

Where a job is in its lifecycle.

  • pending — enqueued and waiting to be picked up.
  • scheduled — claimed by an executor but not yet started.
  • running — being executed.
  • pending_cancellation — cancellation has been requested and the data plane has yet to stop the work.
  • completed, cancelled, failed — terminal states.
Available options:
pending,
scheduled,
running,
pending_cancellation,
completed,
cancelled,
failed
updated_at
string<date-time>
required

The timestamp representing when the job was updated.

input
object
required

The dataset being created and the query that fills it.

completed_at
string<date-time> | null

When the job finished, or null while it is still pending or running.

result
object

The dataset and snapshot the job produced, or the failure that ended it. Null while the job is pending or running.