projects

Create a data project

post

Retrieve a data project

get

Create / Replace a data project

put

Update a data project

patch

Delete a data project

Retrieve a data project version

insights

Retrieve an insight version

queries

Retrieve a saved query

get

Execute a saved query

get

Execute a saved query (with parameters)

post

Retrieve a saved query version

get

SPARQL query (via GET)

datasets

Create / Replace a dataset

Retrieve a dataset version

files

streams

Retrieve stream schema

get

Set / Update stream schema

patch

user

Retrieve user data

get

List datasets as contributor

get

List liked (bookmarked) datasets

get

List datasets as owner

get

List projects as contributor

get

List liked (bookmarked) projects

get

List projects owned

get

users

Retrieve a user's profile

get

webhooks

List subscriptions

get

Retrieve dataset subscription

get

Subscribe to dataset

put

Unsubscribe from dataset

delete

Retrieve data project subscription

get

Subscribe to data project

put

Unsubscribe from data project

delete

Retrieve account subscription

get

Subscribe to account

put

Unsubscribe from account

DOIs

Create dataset version DOI

put

Delete dataset version DOI

delete

Models

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 Body

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

SQL Query Request

SavedQueryExecutionRequest

Stream Schema

Stream Schema Update Request

Subscription

Subscription API URI

Subscription Create Request

Subscription URIs

Success Message Response

patch

/insights/{projectOwner}/{projectId}/{id}

authorization: oauth2

Update an insight. Note that only elements included in the request will be updated. All omitted elements will remain untouched.

3 Path Parameters

Request Body

1 Example

Schema

object

body

object

Defines the body of an insight. Must contain one, and only one of: imageUrl, embedUrl or markdownBody (deprecated).

embedUrl

string

oEmbed URL.

1 validation

imageUrl

string

Image URL

1 validation

markdownBody

string

Markdown (deprecated)

dataSourceLinks

array[string]

One or more permalinks to the data sources used to generate this insight. Allows others to access the data originally used to produce the insight.

format: uri

description

string

Insight description.

maxLength: 25000

sourceLink

string

Permalink to source code or platform this insight was generated with. Allows others to replicate the steps originally used to produce the insight.

format: uri

thumbnail

string

format: uri

title

string

Insight title.

maxLength: 128

minLength: 1

Responses

OK The request has succeeded.

1 Example

Schema

object

message

string

Send a Test Request

Path Params

3 path params not set

projectOwner

projectId

$$.env

1 variable not set

oauth_access_token