Web API Reference

The Dataform Web API is currently in Beta, and breaking changes are likely to happen.

ApiService_RunCreatePOST

api.dataform.co/v1/project/{projectId}/run

Initiates new dataform runs within the project, and returns the ID of any created runs. Once created, new runs can be monitored by polling the RunGet API.

Parameters

projectId
string
The ID of the project for which you want to create a run. This does not need to be provided in the body of the request, only the path.

Responses

default
Error

ApiService_RunGetGET

api.dataform.co/v1/project/{projectId}/run/{runId}

Returns information about a specific run.

Parameters

projectId
string
The ID of the project that the run belongs to.
runId
string
The ID of the run.

Responses

default
Error

RunGetResponseExecutionStatus

The execution status of a run.
  • UNKNOWN
  • RUNNING
  • SUCCESSFUL
  • FAILED
  • CANCELLED
  • TIMED_OUT
  • Any

    Properties

    typeUrl
    string
    value
    string

    Error

    Properties

    error
    string
    code
    integer
    message
    string
    details

    RunCreateRequest

    Properties

    projectId
    string
    The ID of the project for which you want to create a run. This does not need to be provided in the body of the request, only the path.
    environmentName
    string
    The name of the environment in the `environments.json` file to pull project configuration options from (optional).
    scheduleName
    string
    The name of the schedule in the `schedules.json` file to pull run configuration options from (optional).

    RunCreateResponse

    Properties

    id
    string
    The ID of the run that was created.

    RunGetResponse

    Properties

    id
    string
    The ID of the run.
    status
    runLogUrl
    string
    A link to the logs UI containing more details about the run.

    What's next

    Sitemap