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.
body
RunCreateRequest

Responses

200
RunCreateResponse
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

200
RunGetResponse
default
Error

RunCreateRequestRunConfig

Properties

tags
string[]
A list of tags with which the action must have in order to be run (optional). If not set, then all actions will run.

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
    Any[]

    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).
    runConfig
    RunCreateRequestRunConfig
    A run configuration to use instead of using a schedule's configuration options (optional).

    RunCreateResponse

    Properties

    id
    string
    The ID of the run that was created.

    RunGetResponse

    Properties

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

    What's next

    Sitemap

    Introduction
    ELT and the modern data stack
    SQLX and Dataform in 5 minutes
    How Dataform works
    Supported warehouses
    Snowflake
    Google BigQuery
    Amazon Redshift
    Azure SQL Data Warehouse
    Postgres
    Example projects and scripts
    Example projects
    Example scripts
    Getting started tutorial
    Getting set up
    Building your data model
    Managing dependencies
    Setting up a schedule
    Data quality tests and documenting datasets
    Committing your changes
    Build your Dataform project
    Publish data tables and views
    SQLX
    Test data quality with assertions
    Declare external datasets with declarations
    Write custom SQL operations
    Configure your project
    Power your code with JavaScript
    Organise your project with tags
    Run unit tests on your queries
    Configure CI/CD
    Dataform web guides
    Tutorials
    Version control
    Git access tokens
    Schedule runs
    Use the REST API
    Best practices using Dataform
    First steps with your Dataform project
    Best practices for managing dataform projects
    Use the Dataform CLI
    Packages
    Create new packages
    Contribute to an existing package
    BigQuery Audit Logs
    Fivetran Logs
    Segment
    Slowly changing dimensions
    Stripe (Fivetran)
    API Reference
    On this page