Integrations Gallery

projects

Create a data project

Delete a data project

Retrieve a data project

Update a data project

Create / Replace a data project

Retrieve a data project version

insights

Create an insight

Delete an insight

Retrieve an insight

Update an insight

Replace an insight

Retrieve an insight version

queries

List saved queries

Create a saved query in a specified dataset.

Delete a saved query in a specified dataset.

Update a saved query in a specified dataset.

List saved queries

Create a saved query in a specified project.

Delete a saved query in a specified project.

Update a saved query in a specified project.

Retrieve a saved query

Execute a saved query

Execute a saved query (with parameters)

Retrieve a saved query version

SPARQL query (via GET)

SQL query (via GET)

datasets

Create a dataset

Delete a dataset

Retrieve a dataset

Update a dataset

Create / Replace a dataset

Retrieve a dataset version

Download a dataset

files

Add files from URLs

Sync files (via GET)

Download a file

streams

Append record(s)

Delete all records

Retrieve stream schema

Set / Update stream schema

user

Retrieve user data

List datasets as contributor

List liked (bookmarked) datasets

List datasets as owner

List projects as contributor

List liked (bookmarked) projects

List projects owned

users

Retrieve a user's profile

webhooks

List subscriptions

Unsubscribe from dataset

Retrieve dataset subscription

Subscribe to dataset

Unsubscribe from data project

Retrieve data project subscription

Subscribe to data project

Unsubscribe from account

Retrieve account subscription

Subscribe to account

DOIs

Delete dataset DOI

Create dataset DOI

Delete dataset version DOI

Create dataset version DOI

Models

CreateQueryRequest

Dataset Create Request

Dataset Create Response

Dataset Replace Request

Dataset Summary Response

Dataset Update Request

Dataset or Project Identifier

Digital Object Identifier

Error Message Response

File Create Or Update Request

File Create Request

File Create or Update Batch

File Source Create Or Update Request

File Source Response

File Summary Response

Insight Create Request

Insight Create Response

Insight Replace Request

Insight Summary Response

Insight Update Request

Linked Dataset Create or Update Request

Linked Dataset Summary Response

OAuth Token Reference

Paginated Dataset Results

Paginated Insight Results

Paginated Project Results

Paginated Query Results

Paginated Subscription Results

Project Create Request

Project Create Response

Project Create or Update Request

Project Summary Response

Project Update Request

Query Summary Response

QueryPutRequest

SQL Query Request

SavedQueryExecutionRequest

Stream Schema Update Request

Subscription API URI

Subscription Create Request

Subscription URIs

Success Message Response

User Data Response

User Identifier

Web Authorization

Web Credentials

Powered by Stoplight

File Source Response

object

authorization

object

An authorization type and credentials suitable for use in an HTTP Authorization header.

When used with a File Source this causes the HTTP request to include the following header:

Authorization: <type> <credentials>

The credentials field is write-only. It is omitted by read operations.

credentials

object

A username and password suitable for use with HTTP Basic authentication.

When used with a File Source this causes the HTTP request to include the following header:

Authorization: Basic <base64-encoding-of(user:password)>

The password field is write-only. It is omitted by read operations.

expandArchive

boolean

1 validation

lastSyncFailure

string

Date and time when synchronization last failed.

lastSyncStart

string

Date and time when synchronization last started.

lastSyncSuccess

string

Date and time when synchronization last finished successfully.

method

string

oauthToken

object

A reference to a 3rd-party OAuth 2.0 token stored by data.world.

When creating or updating an OAuth token reference, the token must belong to the user making the update.

requestEntity

string

requestHeaders

object

A map of custom HTTP header name/value pairs to pass with the request.

If a requestEntity string is specified, this must contain a Content-Type header.

syncStatus

string

Synchronization status of the file. This status can be checked periodically after changes are made to the dataset to determine the status of asynchronous syncronization.

NEW: Just created. Not yet synchronized.
INPROGRESS: Currently being synchronized.
LOADED: Successfully synchronized.
SYSTEMERROR: Error state due to synchronization failure.

required

syncSummary

string

Human-readable message detailing status of last failed sync.

url

string

Source URL of file. Must be an http, https, or stream URL.

1 validation