Use the REST API

Learn how to Dataform web REST API.

Dataform Web can be controlled through a REST API. This is currently a paid feature, if you'd like to get set up please reach out to our team on Intercom on the bottom right of the page.

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

Authorization

Calls to the Dataform Web API are authenticated using API tokens. These can be created from the Dataform project's settings page.

When calling the API, you can pass your API token in an Authorization header, using a bearer token format.

For example, with curl these headers can be provided as follows:

1
curl -H "Authorization: Bearer 5235783003799552|s+N8gAs72qbi90pFEv7yW/KBImTshRdBoVKjjFA7lD0=|1" https://api.dataform.co/v1/project/1234/run/5678

Creating runs

Runs can be created by making a POST call to the RunCreate method.

For detailed documentation on supported parameters, see the RunCreate reference documentation.

For example, to create a run for the project ID 1234 and to trigger a specific schedule name:

1
curl -H "Authorization: Bearer 5235783003799552|s+N8gAs72qbi90pFEv7yW/KBImTshRdBoVKjjFA7lD0=|1" -X POST -d '{ "scheduleName": "some_schedule" }' https://api.dataform.co/v1/project/1234/run

This will return a RunGetResponse, that includes the created run's ID:

1
2
3
{
  "id": "1029591293203"
}

Getting run information

After creating a run, the status of the run can be checked with the RunGet method.

This should be a GET request to the appropriate path, for example for project ID 1234 and a run ID 5678 :

1
curl -H "Authorization: Bearer 5235783003799552|s+N8gAs72qbi90pFEv7yW/KBImTshRdBoVKjjFA7lD0=|1" https://api.dataform.co/v1/project/1234/run/5678

This will return a RunGetResponse such as:

1
2
3
4
5
{
  "id": "5678",
  "status": "RUNNING",
  "runLogUrl": "https://app.dataform.co/#/1234/run/5678"
}

What's next

Tutorials

Tutorials for getting start with Dataform web.

Version control

Learn how to use version control in Dataform Web.

Git access tokens

Learn how to use Git access tokens for connecting to git providers.

Schedule runs

Learn how to schedule runs and view logs

Web API Reference