Datasets
Datasets are modules of data that can be published to workspaces. Datasets are visualised in the Matatika app following the Chart.js specifications.
Objects
Dataset
Path | JSON Type | Format | Description |
---|---|---|---|
id |
string |
Version 4 UUID | The dataset ID |
published |
string |
ISO 8601 timestamp | The instant the dataset was published |
alias |
string |
The dataset alias | |
workspaceId |
string |
Version 4 UUID | The workspace ID of the published dataset |
source |
string |
The channel ID where the dataset was initially published to | |
title |
string |
The dataset title | |
description |
string |
The dataset description (may contain markdown) | |
questions |
string |
The dataset questions | |
rawData |
string |
JSON | The dataset raw data |
visualisation |
string |
JSON | The dataset visualisation metadata. More Info |
metadata |
string |
JSON | The dataset metadata. More Info |
query |
string |
SQL statement | The dataset query. More Info |
likeCount |
number |
Unsigned integer | The number of likes the dataset has received |
likedByProfiles |
object[] |
Array of Member s |
The members that have liked the dataset |
commentCount |
number |
Unsigned integer | The number of comments the dataset has received |
viewCount |
number |
Unsigned integer | The number of views the dataset has received |
created |
string |
ISO 8601 timestamp | The instant the dataset was create |
score |
number |
Decimal | The dataset score used to determine its position in the workspace Feed |
{
"id" : "8551bcf8-5a80-4e85-95d5-7766d59730c6",
"published" : "2025-06-19T10:13:38.036888",
"alias" : "sit-generated-dataset",
"workspaceId" : "4e00cf80-23b9-41e5-a53f-2f5b4b7e3151",
"source" : "@sit+prod",
"title" : "SIT-Generated Dataset [2025-06-19T11:13:37.982233]",
"description" : "This dataset was created during a SIT run.",
"descriptionContentType" : "text/plain",
"questions" : "What questions might this dataset help answer?",
"query" : "SELECT * FROM table_name;",
"likeCount" : 0,
"likedByProfiles" : [ ],
"commentCount" : 0,
"viewCount" : 0,
"created" : "2025-06-19T10:13:38.036887",
"score" : 1.0,
"_links" : {
"self" : {
"href" : "https://app.matatika.com/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6"
},
"delete dataset" : {
"href" : "https://app.matatika.com/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6",
"type" : "DELETE"
},
"edit dataset" : {
"href" : "https://app.matatika.com/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6",
"type" : "PATCH"
},
"data" : {
"href" : "https://app.matatika.com/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6/data",
"type" : "GET"
},
"source" : {
"href" : "https://app.matatika.com/api/channels/3b40397d-c8d1-4314-8d02-40b0ff20ac15",
"type" : "GET"
},
"new comment" : {
"href" : "https://app.matatika.com/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6/comments",
"type" : "POST"
},
"add like" : {
"href" : "https://app.matatika.com/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6/like",
"type" : "PUT"
},
"add view" : {
"href" : "https://app.matatika.com/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6/view",
"type" : "PUT"
},
"new alert" : {
"href" : "https://app.matatika.com/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6/alerts"
},
"add subscription" : {
"href" : "https://app.matatika.com/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6/subscriptions"
},
"new message" : {
"href" : "https://app.matatika.com/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6/messages"
}
},
"_embedded" : {
"source" : {
"name" : "@sit+prod",
"description" : "[email protected] Channel"
}
}
}
Dataset Message
Path | JSON Type | Format | Description |
---|---|---|---|
id |
string |
Version 4 UUID | The dataset message ID (shared with the resulting notification) |
recipientId |
string |
The recipient profile ID | |
message |
string |
The dataset message content | |
datasetId |
string |
Version 4 UUID | The message subject dataset ID |
{
"id" : "b45e29ae-1be5-41b1-8d09-6d258d39f6b8",
"recipientId" : "auth0|5eb0327cbfd7490bff55feeb",
"message" : "SIT-generated dataset message [2025-06-19T11:13:39.072119]",
"datasetId" : "8551bcf8-5a80-4e85-95d5-7766d59730c6",
"_links" : {
"notification" : {
"href" : "https://app.matatika.com/api/notifications/b45e29ae-1be5-41b1-8d09-6d258d39f6b8"
}
}
}
Requests
- View all datasets in a workspace
- View all liked datasets in a workspace
- View datasets by channel
- View a dataset
- View a dataset in a workspace
- View the data of a dataset
- Publish a dataset to a workspace
- Edit a dataset
- Record a view of a dataset
- Record a like of a dataset
- Remove a like from a dataset
- Initialise a new dataset message
- Create or update a dataset message
- Delete a dataset
See Also
- View all comments on a dataset
- Search for datasets in a workspace by free text
- Search for datasets in a workspace by channel name
- Search for datasets in a workspace by tag name
- Subscribe to a dataset
View all datasets in a workspace
GET
/api/workspaces/{workspace-id}/datasets
Returns all datasets in the workspace {workspace-id}
.
Prerequisites
- The user must be a member of the workspace
{workspace-id}
Request
Example Snippets
cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.matatika.com:443/api/workspaces/4e00cf80-23b9-41e5-a53f-2f5b4b7e3151/datasets' -i -X GET \
-H 'Accept: application/json, application/javascript, text/javascript, text/json'
Python (requests
)
import requests
url = "https://app.matatika.com:443/api/workspaces/4e00cf80-23b9-41e5-a53f-2f5b4b7e3151/datasets"
headers = {
'Authorization': ACCESS_TOKEN
}
response = requests.request("GET", url, headers=headers)
print(response.text.encode('utf8'))
Response
200 OK
Dataset collection with HAL links.
{
"_embedded" : {
"datasets" : [ {
"id" : "af00e99f-766a-42d0-b623-1240f74df1a1",
"published" : "2025-06-19T10:13:39.452545",
"workspaceId" : "4e00cf80-23b9-41e5-a53f-2f5b4b7e3151",
"source" : "@sit+prod",
"title" : "SIT-Generated Dataset [2025-06-19T11:13:37.982233]",
"description" : "This dataset was created during a SIT run.",
"descriptionContentType" : "text/plain",
"questions" : "What questions might this dataset help answer?",
"query" : "SELECT * FROM table_name;",
"likeCount" : 0,
"likedByProfiles" : [ ],
"commentCount" : 0,
"viewCount" : 0,
"created" : "2025-06-19T10:13:39.452544",
"score" : 1.0,
"_links" : {
"self" : {
"href" : "https://app.matatika.com/api/datasets/af00e99f-766a-42d0-b623-1240f74df1a1"
},
"delete dataset" : {
"href" : "https://app.matatika.com/api/datasets/af00e99f-766a-42d0-b623-1240f74df1a1",
"type" : "DELETE"
},
"edit dataset" : {
"href" : "https://app.matatika.com/api/datasets/af00e99f-766a-42d0-b623-1240f74df1a1",
"type" : "PATCH"
},
"data" : {
"href" : "https://app.matatika.com/api/datasets/af00e99f-766a-42d0-b623-1240f74df1a1/data",
"type" : "GET"
},
"source" : {
"href" : "https://app.matatika.com/api/channels/3b40397d-c8d1-4314-8d02-40b0ff20ac15",
"type" : "GET"
},
"new comment" : {
"href" : "https://app.matatika.com/api/datasets/af00e99f-766a-42d0-b623-1240f74df1a1/comments",
"type" : "POST"
},
"add like" : {
"href" : "https://app.matatika.com/api/datasets/af00e99f-766a-42d0-b623-1240f74df1a1/like",
"type" : "PUT"
},
"add view" : {
"href" : "https://app.matatika.com/api/datasets/af00e99f-766a-42d0-b623-1240f74df1a1/view",
"type" : "PUT"
},
"new alert" : {
"href" : "https://app.matatika.com/api/datasets/af00e99f-766a-42d0-b623-1240f74df1a1/alerts"
},
"add subscription" : {
"href" : "https://app.matatika.com/api/datasets/af00e99f-766a-42d0-b623-1240f74df1a1/subscriptions"
},
"new message" : {
"href" : "https://app.matatika.com/api/datasets/af00e99f-766a-42d0-b623-1240f74df1a1/messages"
}
},
"_embedded" : {
"source" : {
"name" : "@sit+prod",
"description" : "[email protected] Channel",
"picture" : "https://s.gravatar.com/avatar/8f4ad8fa0793181b761d030196e62053?s=480&r=pg&d=https%3A%2F%2Fcdn.auth0.com%2Favatars%2Fsu.png"
}
}
}, {
"id" : "e2f3c525-55df-41ed-aba6-89c9d4b3584d",
"published" : "2025-06-19T10:13:47.438049",
"workspaceId" : "4e00cf80-23b9-41e5-a53f-2f5b4b7e3151",
"source" : "@sit+prod",
"title" : "SIT-Generated Dataset [2025-06-19T11:13:37.982233]",
"description" : "This dataset was created during a SIT run.",
"descriptionContentType" : "text/plain",
"questions" : "What questions might this dataset help answer?",
"query" : "SELECT * FROM table_name;",
"likeCount" : 0,
"likedByProfiles" : [ ],
"commentCount" : 0,
"viewCount" : 0,
"created" : "2025-06-19T10:13:47.438048",
"score" : 1.0,
"_links" : {
"self" : {
"href" : "https://app.matatika.com/api/datasets/e2f3c525-55df-41ed-aba6-89c9d4b3584d"
},
"delete dataset" : {
"href" : "https://app.matatika.com/api/datasets/e2f3c525-55df-41ed-aba6-89c9d4b3584d",
"type" : "DELETE"
},
"edit dataset" : {
"href" : "https://app.matatika.com/api/datasets/e2f3c525-55df-41ed-aba6-89c9d4b3584d",
"type" : "PATCH"
},
"data" : {
"href" : "https://app.matatika.com/api/datasets/e2f3c525-55df-41ed-aba6-89c9d4b3584d/data",
"type" : "GET"
},
"source" : {
"href" : "https://app.matatika.com/api/channels/3b40397d-c8d1-4314-8d02-40b0ff20ac15",
"type" : "GET"
},
"new comment" : {
"href" : "https://app.matatika.com/api/datasets/e2f3c525-55df-41ed-aba6-89c9d4b3584d/comments",
"type" : "POST"
},
"add like" : {
"href" : "https://app.matatika.com/api/datasets/e2f3c525-55df-41ed-aba6-89c9d4b3584d/like",
"type" : "PUT"
},
"add view" : {
"href" : "https://app.matatika.com/api/datasets/e2f3c525-55df-41ed-aba6-89c9d4b3584d/view",
"type" : "PUT"
},
"new alert" : {
"href" : "https://app.matatika.com/api/datasets/e2f3c525-55df-41ed-aba6-89c9d4b3584d/alerts"
},
"add subscription" : {
"href" : "https://app.matatika.com/api/datasets/e2f3c525-55df-41ed-aba6-89c9d4b3584d/subscriptions"
},
"new message" : {
"href" : "https://app.matatika.com/api/datasets/e2f3c525-55df-41ed-aba6-89c9d4b3584d/messages"
}
},
"_embedded" : {
"source" : {
"name" : "@sit+prod",
"description" : "[email protected] Channel",
"picture" : "https://s.gravatar.com/avatar/8f4ad8fa0793181b761d030196e62053?s=480&r=pg&d=https%3A%2F%2Fcdn.auth0.com%2Favatars%2Fsu.png"
}
}
}, {
"id" : "b6f205aa-4c22-4ad6-bbf6-51a120356446",
"published" : "2025-06-19T10:13:47.511873",
"workspaceId" : "4e00cf80-23b9-41e5-a53f-2f5b4b7e3151",
"source" : "@sit+prod",
"title" : "SIT-Generated Dataset [2025-06-19T11:13:37.982233]",
"description" : "This dataset was created during a SIT run.",
"descriptionContentType" : "text/plain",
"questions" : "What questions might this dataset help answer?",
"query" : "SELECT * FROM table_name;",
"likeCount" : 0,
"likedByProfiles" : [ ],
"commentCount" : 0,
"viewCount" : 0,
"created" : "2025-06-19T10:13:47.511872",
"score" : 1.0,
"_links" : {
"self" : {
"href" : "https://app.matatika.com/api/datasets/b6f205aa-4c22-4ad6-bbf6-51a120356446"
},
"delete dataset" : {
"href" : "https://app.matatika.com/api/datasets/b6f205aa-4c22-4ad6-bbf6-51a120356446",
"type" : "DELETE"
},
"edit dataset" : {
"href" : "https://app.matatika.com/api/datasets/b6f205aa-4c22-4ad6-bbf6-51a120356446",
"type" : "PATCH"
},
"data" : {
"href" : "https://app.matatika.com/api/datasets/b6f205aa-4c22-4ad6-bbf6-51a120356446/data",
"type" : "GET"
},
"source" : {
"href" : "https://app.matatika.com/api/channels/3b40397d-c8d1-4314-8d02-40b0ff20ac15",
"type" : "GET"
},
"new comment" : {
"href" : "https://app.matatika.com/api/datasets/b6f205aa-4c22-4ad6-bbf6-51a120356446/comments",
"type" : "POST"
},
"add like" : {
"href" : "https://app.matatika.com/api/datasets/b6f205aa-4c22-4ad6-bbf6-51a120356446/like",
"type" : "PUT"
},
"add view" : {
"href" : "https://app.matatika.com/api/datasets/b6f205aa-4c22-4ad6-bbf6-51a120356446/view",
"type" : "PUT"
},
"new alert" : {
"href" : "https://app.matatika.com/api/datasets/b6f205aa-4c22-4ad6-bbf6-51a120356446/alerts"
},
"add subscription" : {
"href" : "https://app.matatika.com/api/datasets/b6f205aa-4c22-4ad6-bbf6-51a120356446/subscriptions"
},
"new message" : {
"href" : "https://app.matatika.com/api/datasets/b6f205aa-4c22-4ad6-bbf6-51a120356446/messages"
}
},
"_embedded" : {
"source" : {
"name" : "@sit+prod",
"description" : "[email protected] Channel",
"picture" : "https://s.gravatar.com/avatar/8f4ad8fa0793181b761d030196e62053?s=480&r=pg&d=https%3A%2F%2Fcdn.auth0.com%2Favatars%2Fsu.png"
}
}
} ]
},
"_links" : {
"self" : {
"href" : "https://app.matatika.com/api/workspaces/4e00cf80-23b9-41e5-a53f-2f5b4b7e3151/datasets?page=0&size=20"
}
},
"page" : {
"size" : 20,
"totalElements" : 3,
"totalPages" : 1,
"number" : 0
}
}
View all liked datasets in a workspace
GET
/api/workspaces/{workspace-id}/liked
Returns all datasets in the workspace {workspace-id}
liked by the authenticated profile.
Prerequisites
- The user must be a member of the workspace
{workspace-id}
Request
Example Snippets
cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.matatika.com:443/api/workspaces/4e00cf80-23b9-41e5-a53f-2f5b4b7e3151/liked' -i -X GET \
-H 'Accept: application/json, application/javascript, text/javascript, text/json'
Python (requests
)
import requests
url = "https://app.matatika.com:443/api/workspaces/4e00cf80-23b9-41e5-a53f-2f5b4b7e3151/liked"
headers = {
'Authorization': ACCESS_TOKEN
}
response = requests.request("GET", url, headers=headers)
print(response.text.encode('utf8'))
Response
200 OK
Dataset collection with HAL links.
{
"_embedded" : {
"datasets" : [ {
"id" : "8551bcf8-5a80-4e85-95d5-7766d59730c6",
"published" : "2025-06-19T10:13:38.33375",
"alias" : "sit-generated-dataset",
"workspaceId" : "4e00cf80-23b9-41e5-a53f-2f5b4b7e3151",
"source" : "@sit+prod",
"title" : "SIT-Generated Dataset [2025-06-19T11:13:38.282549]",
"description" : "This dataset was edited during a SIT run.",
"descriptionContentType" : "text/plain",
"questions" : "What questions might this dataset help answer?",
"query" : "SELECT * FROM table_name;",
"likeCount" : 1,
"likedByProfiles" : [ {
"id" : "auth0|5eb0327cbfd7490bff55feeb",
"name" : "[email protected]",
"handle" : "@sit+prod"
} ],
"commentCount" : 0,
"viewCount" : 1,
"created" : "2025-06-19T10:13:38.036887",
"score" : 1.0,
"_links" : {
"self" : {
"href" : "https://app.matatika.com/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6"
},
"delete dataset" : {
"href" : "https://app.matatika.com/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6",
"type" : "DELETE"
},
"edit dataset" : {
"href" : "https://app.matatika.com/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6",
"type" : "PATCH"
},
"data" : {
"href" : "https://app.matatika.com/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6/data",
"type" : "GET"
},
"source" : {
"href" : "https://app.matatika.com/api/channels/3b40397d-c8d1-4314-8d02-40b0ff20ac15",
"type" : "GET"
},
"new comment" : {
"href" : "https://app.matatika.com/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6/comments",
"type" : "POST"
},
"remove like" : {
"href" : "https://app.matatika.com/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6/like",
"type" : "DELETE"
},
"add view" : {
"href" : "https://app.matatika.com/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6/view",
"type" : "PUT"
},
"new alert" : {
"href" : "https://app.matatika.com/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6/alerts"
},
"add subscription" : {
"href" : "https://app.matatika.com/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6/subscriptions"
},
"new message" : {
"href" : "https://app.matatika.com/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6/messages"
}
},
"_embedded" : {
"source" : {
"name" : "@sit+prod",
"description" : "[email protected] Channel"
}
}
} ]
},
"_links" : {
"self" : {
"href" : "https://app.matatika.com/api/workspaces/4e00cf80-23b9-41e5-a53f-2f5b4b7e3151/liked?page=0&size=20"
}
},
"page" : {
"size" : 20,
"totalElements" : 1,
"totalPages" : 1,
"number" : 0
}
}
View datasets by channel
GET
/api/channels/{channel-id}/datasets
Returns datasets by the channel {channel-id}
.
Prerequisites
- Channel
{channel-id}
must exist
Request
Example Snippets
cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.matatika.com:443/api/channels/3b40397d-c8d1-4314-8d02-40b0ff20ac15/datasets' -i -X GET \
-H 'Accept: application/json, application/javascript, text/javascript, text/json'
Python (requests
)
import requests
url = "https://app.matatika.com:443/api/channels/3b40397d-c8d1-4314-8d02-40b0ff20ac15/datasets"
headers = {
'Authorization': ACCESS_TOKEN
}
response = requests.request("GET", url, headers=headers)
print(response.text.encode('utf8'))
Response
200 OK
Dataset collection with HAL links.
{
"_embedded" : {
"datasets" : [ {
"id" : "af00e99f-766a-42d0-b623-1240f74df1a1",
"published" : "2025-06-19T10:13:39.452545",
"workspaceId" : "4e00cf80-23b9-41e5-a53f-2f5b4b7e3151",
"source" : "@sit+prod",
"title" : "SIT-Generated Dataset [2025-06-19T11:13:37.982233]",
"description" : "This dataset was created during a SIT run.",
"descriptionContentType" : "text/plain",
"questions" : "What questions might this dataset help answer?",
"query" : "SELECT * FROM table_name;",
"likeCount" : 0,
"likedByProfiles" : [ ],
"commentCount" : 0,
"viewCount" : 0,
"created" : "2025-06-19T10:13:39.452544",
"score" : 1.0,
"_links" : {
"self" : {
"href" : "https://app.matatika.com/api/datasets/af00e99f-766a-42d0-b623-1240f74df1a1"
},
"delete dataset" : {
"href" : "https://app.matatika.com/api/datasets/af00e99f-766a-42d0-b623-1240f74df1a1",
"type" : "DELETE"
},
"edit dataset" : {
"href" : "https://app.matatika.com/api/datasets/af00e99f-766a-42d0-b623-1240f74df1a1",
"type" : "PATCH"
},
"data" : {
"href" : "https://app.matatika.com/api/datasets/af00e99f-766a-42d0-b623-1240f74df1a1/data",
"type" : "GET"
},
"source" : {
"href" : "https://app.matatika.com/api/channels/3b40397d-c8d1-4314-8d02-40b0ff20ac15",
"type" : "GET"
},
"new comment" : {
"href" : "https://app.matatika.com/api/datasets/af00e99f-766a-42d0-b623-1240f74df1a1/comments",
"type" : "POST"
},
"add like" : {
"href" : "https://app.matatika.com/api/datasets/af00e99f-766a-42d0-b623-1240f74df1a1/like",
"type" : "PUT"
},
"add view" : {
"href" : "https://app.matatika.com/api/datasets/af00e99f-766a-42d0-b623-1240f74df1a1/view",
"type" : "PUT"
},
"new alert" : {
"href" : "https://app.matatika.com/api/datasets/af00e99f-766a-42d0-b623-1240f74df1a1/alerts"
},
"add subscription" : {
"href" : "https://app.matatika.com/api/datasets/af00e99f-766a-42d0-b623-1240f74df1a1/subscriptions"
},
"new message" : {
"href" : "https://app.matatika.com/api/datasets/af00e99f-766a-42d0-b623-1240f74df1a1/messages"
}
},
"_embedded" : {
"source" : {
"name" : "@sit+prod",
"description" : "[email protected] Channel",
"picture" : "https://s.gravatar.com/avatar/8f4ad8fa0793181b761d030196e62053?s=480&r=pg&d=https%3A%2F%2Fcdn.auth0.com%2Favatars%2Fsu.png"
}
}
}, {
"id" : "e2f3c525-55df-41ed-aba6-89c9d4b3584d",
"published" : "2025-06-19T10:13:47.438049",
"workspaceId" : "4e00cf80-23b9-41e5-a53f-2f5b4b7e3151",
"source" : "@sit+prod",
"title" : "SIT-Generated Dataset [2025-06-19T11:13:37.982233]",
"description" : "This dataset was created during a SIT run.",
"descriptionContentType" : "text/plain",
"questions" : "What questions might this dataset help answer?",
"query" : "SELECT * FROM table_name;",
"likeCount" : 0,
"likedByProfiles" : [ ],
"commentCount" : 0,
"viewCount" : 0,
"created" : "2025-06-19T10:13:47.438048",
"score" : 1.0,
"_links" : {
"self" : {
"href" : "https://app.matatika.com/api/datasets/e2f3c525-55df-41ed-aba6-89c9d4b3584d"
},
"delete dataset" : {
"href" : "https://app.matatika.com/api/datasets/e2f3c525-55df-41ed-aba6-89c9d4b3584d",
"type" : "DELETE"
},
"edit dataset" : {
"href" : "https://app.matatika.com/api/datasets/e2f3c525-55df-41ed-aba6-89c9d4b3584d",
"type" : "PATCH"
},
"data" : {
"href" : "https://app.matatika.com/api/datasets/e2f3c525-55df-41ed-aba6-89c9d4b3584d/data",
"type" : "GET"
},
"source" : {
"href" : "https://app.matatika.com/api/channels/3b40397d-c8d1-4314-8d02-40b0ff20ac15",
"type" : "GET"
},
"new comment" : {
"href" : "https://app.matatika.com/api/datasets/e2f3c525-55df-41ed-aba6-89c9d4b3584d/comments",
"type" : "POST"
},
"add like" : {
"href" : "https://app.matatika.com/api/datasets/e2f3c525-55df-41ed-aba6-89c9d4b3584d/like",
"type" : "PUT"
},
"add view" : {
"href" : "https://app.matatika.com/api/datasets/e2f3c525-55df-41ed-aba6-89c9d4b3584d/view",
"type" : "PUT"
},
"new alert" : {
"href" : "https://app.matatika.com/api/datasets/e2f3c525-55df-41ed-aba6-89c9d4b3584d/alerts"
},
"add subscription" : {
"href" : "https://app.matatika.com/api/datasets/e2f3c525-55df-41ed-aba6-89c9d4b3584d/subscriptions"
},
"new message" : {
"href" : "https://app.matatika.com/api/datasets/e2f3c525-55df-41ed-aba6-89c9d4b3584d/messages"
}
},
"_embedded" : {
"source" : {
"name" : "@sit+prod",
"description" : "[email protected] Channel",
"picture" : "https://s.gravatar.com/avatar/8f4ad8fa0793181b761d030196e62053?s=480&r=pg&d=https%3A%2F%2Fcdn.auth0.com%2Favatars%2Fsu.png"
}
}
}, {
"id" : "b6f205aa-4c22-4ad6-bbf6-51a120356446",
"published" : "2025-06-19T10:13:47.511873",
"workspaceId" : "4e00cf80-23b9-41e5-a53f-2f5b4b7e3151",
"source" : "@sit+prod",
"title" : "SIT-Generated Dataset [2025-06-19T11:13:37.982233]",
"description" : "This dataset was created during a SIT run.",
"descriptionContentType" : "text/plain",
"questions" : "What questions might this dataset help answer?",
"query" : "SELECT * FROM table_name;",
"likeCount" : 0,
"likedByProfiles" : [ ],
"commentCount" : 0,
"viewCount" : 0,
"created" : "2025-06-19T10:13:47.511872",
"score" : 1.0,
"_links" : {
"self" : {
"href" : "https://app.matatika.com/api/datasets/b6f205aa-4c22-4ad6-bbf6-51a120356446"
},
"delete dataset" : {
"href" : "https://app.matatika.com/api/datasets/b6f205aa-4c22-4ad6-bbf6-51a120356446",
"type" : "DELETE"
},
"edit dataset" : {
"href" : "https://app.matatika.com/api/datasets/b6f205aa-4c22-4ad6-bbf6-51a120356446",
"type" : "PATCH"
},
"data" : {
"href" : "https://app.matatika.com/api/datasets/b6f205aa-4c22-4ad6-bbf6-51a120356446/data",
"type" : "GET"
},
"source" : {
"href" : "https://app.matatika.com/api/channels/3b40397d-c8d1-4314-8d02-40b0ff20ac15",
"type" : "GET"
},
"new comment" : {
"href" : "https://app.matatika.com/api/datasets/b6f205aa-4c22-4ad6-bbf6-51a120356446/comments",
"type" : "POST"
},
"add like" : {
"href" : "https://app.matatika.com/api/datasets/b6f205aa-4c22-4ad6-bbf6-51a120356446/like",
"type" : "PUT"
},
"add view" : {
"href" : "https://app.matatika.com/api/datasets/b6f205aa-4c22-4ad6-bbf6-51a120356446/view",
"type" : "PUT"
},
"new alert" : {
"href" : "https://app.matatika.com/api/datasets/b6f205aa-4c22-4ad6-bbf6-51a120356446/alerts"
},
"add subscription" : {
"href" : "https://app.matatika.com/api/datasets/b6f205aa-4c22-4ad6-bbf6-51a120356446/subscriptions"
},
"new message" : {
"href" : "https://app.matatika.com/api/datasets/b6f205aa-4c22-4ad6-bbf6-51a120356446/messages"
}
},
"_embedded" : {
"source" : {
"name" : "@sit+prod",
"description" : "[email protected] Channel",
"picture" : "https://s.gravatar.com/avatar/8f4ad8fa0793181b761d030196e62053?s=480&r=pg&d=https%3A%2F%2Fcdn.auth0.com%2Favatars%2Fsu.png"
}
}
} ]
},
"_links" : {
"self" : {
"href" : "https://app.matatika.com/api/channels/3b40397d-c8d1-4314-8d02-40b0ff20ac15/datasets?page=0&size=20"
}
},
"page" : {
"size" : 20,
"totalElements" : 3,
"totalPages" : 1,
"number" : 0
}
}
View a dataset
GET
/api/datasets/{dataset-id}
Returns the dataset {dataset-id}
.
Prerequisites
- Dataset
{dataset-id}
must exist
Request
Example Snippets
cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.matatika.com:443/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6' -i -X GET \
-H 'Accept: application/json, application/javascript, text/javascript, text/json'
Python (requests
)
import requests
url = "https://app.matatika.com:443/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6"
headers = {
'Authorization': ACCESS_TOKEN
}
response = requests.request("GET", url, headers=headers)
print(response.text.encode('utf8'))
Response
200 OK
Dataset with HAL links.
{
"id" : "8551bcf8-5a80-4e85-95d5-7766d59730c6",
"published" : "2025-06-19T10:13:38.036888",
"alias" : "sit-generated-dataset",
"workspaceId" : "4e00cf80-23b9-41e5-a53f-2f5b4b7e3151",
"source" : "@sit+prod",
"title" : "SIT-Generated Dataset [2025-06-19T11:13:37.982233]",
"description" : "This dataset was created during a SIT run.",
"descriptionContentType" : "text/plain",
"questions" : "What questions might this dataset help answer?",
"query" : "SELECT * FROM table_name;",
"likeCount" : 0,
"likedByProfiles" : [ ],
"commentCount" : 0,
"viewCount" : 0,
"created" : "2025-06-19T10:13:38.036887",
"score" : 1.0,
"_links" : {
"self" : {
"href" : "https://app.matatika.com/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6"
},
"delete dataset" : {
"href" : "https://app.matatika.com/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6",
"type" : "DELETE"
},
"edit dataset" : {
"href" : "https://app.matatika.com/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6",
"type" : "PATCH"
},
"data" : {
"href" : "https://app.matatika.com/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6/data",
"type" : "GET"
},
"source" : {
"href" : "https://app.matatika.com/api/channels/3b40397d-c8d1-4314-8d02-40b0ff20ac15",
"type" : "GET"
},
"new comment" : {
"href" : "https://app.matatika.com/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6/comments",
"type" : "POST"
},
"add like" : {
"href" : "https://app.matatika.com/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6/like",
"type" : "PUT"
},
"add view" : {
"href" : "https://app.matatika.com/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6/view",
"type" : "PUT"
},
"new alert" : {
"href" : "https://app.matatika.com/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6/alerts"
},
"add subscription" : {
"href" : "https://app.matatika.com/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6/subscriptions"
},
"new message" : {
"href" : "https://app.matatika.com/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6/messages"
}
},
"_embedded" : {
"source" : {
"name" : "@sit+prod",
"description" : "[email protected] Channel"
}
}
}
View a dataset in a workspace
GET
/api/workspaces/{workspace-id}/datasets/{dataset-id-or-alias}
Returns the dataset {dataset-id-or-alias}
in the workspace {workspace-id}
.
Prerequisites
- The user must be a member of the workspace
{workspace-id}
- Dataset
{dataset-id-or-alias}
must exist within the workspace{workspace-id}
Request
Example Snippets
cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.matatika.com:443/api/workspaces/4e00cf80-23b9-41e5-a53f-2f5b4b7e3151/datasets/sit-generated-dataset' -i -X GET \
-H 'Accept: application/json, application/javascript, text/javascript, text/json'
Python (requests
)
import requests
url = "https://app.matatika.com:443/api/workspaces/4e00cf80-23b9-41e5-a53f-2f5b4b7e3151/datasets/sit-generated-dataset"
headers = {
'Authorization': ACCESS_TOKEN
}
response = requests.request("GET", url, headers=headers)
print(response.text.encode('utf8'))
Response
200 OK
Dataset with HAL links.
{
"id" : "8551bcf8-5a80-4e85-95d5-7766d59730c6",
"published" : "2025-06-19T10:13:38.036888",
"alias" : "sit-generated-dataset",
"workspaceId" : "4e00cf80-23b9-41e5-a53f-2f5b4b7e3151",
"source" : "@sit+prod",
"title" : "SIT-Generated Dataset [2025-06-19T11:13:37.982233]",
"description" : "This dataset was created during a SIT run.",
"descriptionContentType" : "text/plain",
"questions" : "What questions might this dataset help answer?",
"query" : "SELECT * FROM table_name;",
"likeCount" : 0,
"likedByProfiles" : [ ],
"commentCount" : 0,
"viewCount" : 0,
"created" : "2025-06-19T10:13:38.036887",
"score" : 1.0,
"_links" : {
"self" : {
"href" : "https://app.matatika.com/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6"
},
"delete dataset" : {
"href" : "https://app.matatika.com/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6",
"type" : "DELETE"
},
"edit dataset" : {
"href" : "https://app.matatika.com/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6",
"type" : "PATCH"
},
"data" : {
"href" : "https://app.matatika.com/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6/data",
"type" : "GET"
},
"source" : {
"href" : "https://app.matatika.com/api/channels/3b40397d-c8d1-4314-8d02-40b0ff20ac15",
"type" : "GET"
},
"new comment" : {
"href" : "https://app.matatika.com/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6/comments",
"type" : "POST"
},
"add like" : {
"href" : "https://app.matatika.com/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6/like",
"type" : "PUT"
},
"add view" : {
"href" : "https://app.matatika.com/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6/view",
"type" : "PUT"
},
"new alert" : {
"href" : "https://app.matatika.com/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6/alerts"
},
"add subscription" : {
"href" : "https://app.matatika.com/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6/subscriptions"
},
"new message" : {
"href" : "https://app.matatika.com/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6/messages"
}
},
"_embedded" : {
"source" : {
"name" : "@sit+prod",
"description" : "[email protected] Channel"
}
}
}
View the data of a dataset
GET
/api/datasets/{dataset-id}/data
Returns the data of the dataset {dataset-id}
.
Prerequisites
- Dataset
{dataset-id}
must exist
Request
Headers
Accept
Media Type(s) | Description |
---|---|
application/json */* |
Sets the response content type format to JSON |
text/csv |
Sets the response content type format to CSV |
Defaults to application/json
(given Accept */*
or no Accept
header).
Example Snippets
cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.matatika.com:443/api/datasets/62987c43-365a-48b4-bf97-86830d616b86/data' -i -X GET \
-H 'Accept: application/json, application/javascript, text/javascript, text/json'
Python (requests
)
import requests
url = "https://app.matatika.com:443/api/datasets/62987c43-365a-48b4-bf97-86830d616b86/data"
headers = {
'Authorization': ACCESS_TOKEN
}
response = requests.request("GET", url, headers=headers)
print(response.text.encode('utf8'))
Response
200
: The dataset data (defaults to JSON format).
[ {
"gitflixusers.name" : "John",
"gitflixusers.age" : "23"
}, {
"gitflixusers.name" : "George",
"gitflixusers.age" : "42"
}, {
"gitflixusers.name" : "Mary",
"gitflixusers.age" : "19"
}, {
"gitflixusers.name" : "Kate",
"gitflixusers.age" : "52"
}, {
"gitflixusers.name" : "Bill",
"gitflixusers.age" : "35"
}, {
"gitflixusers.name" : "Fiona",
"gitflixusers.age" : "63"
} ]
204
: No response body provided.
Publish a dataset to a workspace
POST
/api/workspaces/{workspace-id}/datasets
Publishes a dataset to the workspace {workspace-id}
.
Prerequisites
- The user must be a member of the workspace
{workspace-id}
Request
Making the request with an existing id
or alias
will result in the respective dataset being overwritten.
Dataset resource.
{
"alias" : "sit-generated-dataset",
"title" : "SIT-Generated Dataset [2025-06-19T11:13:37.982233]",
"description" : "This dataset was created during a SIT run.",
"questions" : "What questions might this dataset help answer?",
"query" : "SELECT * FROM table_name;"
}
Example Snippets
cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.matatika.com:443/api/workspaces/4e00cf80-23b9-41e5-a53f-2f5b4b7e3151/datasets' -i -X POST \
-H 'Accept: application/json, application/javascript, text/javascript, text/json' \
-H 'Content-Type: application/json' \
-d '{
"alias" : "sit-generated-dataset",
"title" : "SIT-Generated Dataset [2025-06-19T11:13:37.982233]",
"description" : "This dataset was created during a SIT run.",
"questions" : "What questions might this dataset help answer?",
"query" : "SELECT * FROM table_name;"
}'
Python (requests
)
import requests
url = "https://app.matatika.com:443/api/workspaces/4e00cf80-23b9-41e5-a53f-2f5b4b7e3151/datasets"
data = {
"alias" : "sit-generated-dataset",
"title" : "SIT-Generated Dataset [2025-06-19T11:13:37.982233]",
"description" : "This dataset was created during a SIT run.",
"questions" : "What questions might this dataset help answer?",
"query" : "SELECT * FROM table_name;"
}
headers = {
'Authorization': ACCESS_TOKEN
}
response = requests.request("POST", url, headers=headers, data=data)
print(response.text.encode('utf8'))
Response
200 OK / 201 Created
Dataset with HAL links.
{
"id" : "8551bcf8-5a80-4e85-95d5-7766d59730c6",
"published" : "2025-06-19T10:13:38.036887711",
"alias" : "sit-generated-dataset",
"workspaceId" : "4e00cf80-23b9-41e5-a53f-2f5b4b7e3151",
"source" : "@sit+prod",
"title" : "SIT-Generated Dataset [2025-06-19T11:13:37.982233]",
"description" : "This dataset was created during a SIT run.",
"descriptionContentType" : "text/plain",
"questions" : "What questions might this dataset help answer?",
"query" : "SELECT * FROM table_name;",
"likeCount" : 0,
"likedByProfiles" : [ ],
"commentCount" : 0,
"viewCount" : 0,
"created" : "2025-06-19T10:13:38.036886811",
"score" : 1.0,
"_links" : {
"self" : {
"href" : "https://app.matatika.com/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6"
},
"delete dataset" : {
"href" : "https://app.matatika.com/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6",
"type" : "DELETE"
},
"edit dataset" : {
"href" : "https://app.matatika.com/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6",
"type" : "PATCH"
},
"data" : {
"href" : "https://app.matatika.com/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6/data",
"type" : "GET"
},
"source" : {
"href" : "https://app.matatika.com/api/channels/3b40397d-c8d1-4314-8d02-40b0ff20ac15",
"type" : "GET"
},
"new comment" : {
"href" : "https://app.matatika.com/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6/comments",
"type" : "POST"
},
"add like" : {
"href" : "https://app.matatika.com/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6/like",
"type" : "PUT"
},
"add view" : {
"href" : "https://app.matatika.com/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6/view",
"type" : "PUT"
},
"new alert" : {
"href" : "https://app.matatika.com/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6/alerts"
},
"add subscription" : {
"href" : "https://app.matatika.com/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6/subscriptions"
},
"new message" : {
"href" : "https://app.matatika.com/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6/messages"
}
},
"_embedded" : {
"source" : {
"name" : "@sit+prod",
"description" : "[email protected] Channel"
}
}
}
Edit a dataset
PATCH
/api/datasets/{dataset-id}
Edits the dataset {dataset-id}
.
Prerequisites
- Dataset
{dataset-id}
must exist
Request
Body
This request can update one or more of the dataset fields at once. With a single request, it is possible to - for example - edit the dataset title
only, or both title
and description
(shown below).
{
"title" : "SIT-Generated Dataset [2025-06-19T11:13:38.282549]",
"description" : "This dataset was edited during a SIT run."
}
Example Snippets
cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.matatika.com:443/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6' -i -X PATCH \
-H 'Accept: application/json, application/javascript, text/javascript, text/json' \
-H 'Content-Type: application/json' \
-d '{
"title" : "SIT-Generated Dataset [2025-06-19T11:13:38.282549]",
"description" : "This dataset was edited during a SIT run."
}'
Python (requests
)
import requests
url = "https://app.matatika.com:443/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6"
data = {
"title" : "SIT-Generated Dataset [2025-06-19T11:13:38.282549]",
"description" : "This dataset was edited during a SIT run."
}
headers = {
'Authorization': ACCESS_TOKEN
}
response = requests.request("PATCH", url, headers=headers, data=data)
print(response.text.encode('utf8'))
Response
200 OK
Dataset with HAL links.
{
"id" : "8551bcf8-5a80-4e85-95d5-7766d59730c6",
"published" : "2025-06-19T10:13:38.333749756",
"alias" : "sit-generated-dataset",
"workspaceId" : "4e00cf80-23b9-41e5-a53f-2f5b4b7e3151",
"source" : "@sit+prod",
"title" : "SIT-Generated Dataset [2025-06-19T11:13:38.282549]",
"description" : "This dataset was edited during a SIT run.",
"descriptionContentType" : "text/plain",
"questions" : "What questions might this dataset help answer?",
"query" : "SELECT * FROM table_name;",
"likeCount" : 0,
"likedByProfiles" : [ ],
"commentCount" : 0,
"viewCount" : 0,
"created" : "2025-06-19T10:13:38.036887",
"score" : 1.0,
"_links" : {
"self" : {
"href" : "https://app.matatika.com/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6"
},
"delete dataset" : {
"href" : "https://app.matatika.com/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6",
"type" : "DELETE"
},
"edit dataset" : {
"href" : "https://app.matatika.com/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6",
"type" : "PATCH"
},
"data" : {
"href" : "https://app.matatika.com/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6/data",
"type" : "GET"
},
"source" : {
"href" : "https://app.matatika.com/api/channels/3b40397d-c8d1-4314-8d02-40b0ff20ac15",
"type" : "GET"
},
"new comment" : {
"href" : "https://app.matatika.com/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6/comments",
"type" : "POST"
},
"add like" : {
"href" : "https://app.matatika.com/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6/like",
"type" : "PUT"
},
"add view" : {
"href" : "https://app.matatika.com/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6/view",
"type" : "PUT"
},
"new alert" : {
"href" : "https://app.matatika.com/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6/alerts"
},
"add subscription" : {
"href" : "https://app.matatika.com/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6/subscriptions"
},
"new message" : {
"href" : "https://app.matatika.com/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6/messages"
}
},
"_embedded" : {
"source" : {
"name" : "@sit+prod",
"description" : "[email protected] Channel"
}
}
}
Record a view of a dataset
PUT
/api/datasets/{dataset-id}/view
“Adds a view to the dataset {dataset-id}
.
Prerequisites
- Dataset
{dataset-id}
must exist
Request
Example Snippets
cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.matatika.com:443/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6/view' -i -X PUT \
-H 'Accept: application/json, application/javascript, text/javascript, text/json' \
-H 'Content-Type: application/json'
Python (requests
)
import requests
url = "https://app.matatika.com:443/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6/view"
headers = {
'Authorization': ACCESS_TOKEN
}
response = requests.request("PUT", url, headers=headers)
print(response.text.encode('utf8'))
Response
200 OK
No response body provided.
Record a like of a dataset
PUT
/api/datasets/{dataset-id}/like
Records a like of the dataset {dataset-id}
from the authenticated user profile.
Prerequisites
- Dataset
{dataset-id}
must exist
Request
Example Snippets
cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.matatika.com:443/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6/like' -i -X PUT \
-H 'Accept: application/json, application/javascript, text/javascript, text/json' \
-H 'Content-Type: application/json'
Python (requests
)
import requests
url = "https://app.matatika.com:443/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6/like"
headers = {
'Authorization': ACCESS_TOKEN
}
response = requests.request("PUT", url, headers=headers)
print(response.text.encode('utf8'))
Response
200 OK
No response body provided.
Remove a like from a dataset
DELETE
/api/datasets/{dataset-id}/like
Removes a like of the dataset {dataset-id}
from the authenticated user profile.
Prerequisites
- Dataset
{dataset-id}
must exist
Request
Example Snippets
cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.matatika.com:443/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6/like' -i -X DELETE \
-H 'Accept: application/json, application/javascript, text/javascript, text/json'
Python (requests
)
import requests
url = "https://app.matatika.com:443/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6/like"
headers = {
'Authorization': ACCESS_TOKEN
}
response = requests.request("DELETE", url, headers=headers)
print(response.text.encode('utf8'))
Response
204 No Content
No response body provided.
Initialise a new dataset message
POST
/api/datasets/{dataset-id}/messages
Initialises a new dataset message for the dataset {dataset-id}
Prerequisites
- Dataset
{dataset-id}
must exist
Requests
Example Snippets
cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.matatika.com:443/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6/messages' -i -X POST \
-H 'Accept: application/json, application/javascript, text/javascript, text/json' \
-H 'Content-Type: application/json'
Python (requests
)
import requests
url = "https://app.matatika.com:443/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6/messages"
headers = {
'Authorization': ACCESS_TOKEN
}
response = requests.request("POST", url, headers=headers)
print(response.text.encode('utf8'))
Response
200 OK
Dataset Message with HAL links.
{
"id" : "b45e29ae-1be5-41b1-8d09-6d258d39f6b8",
"datasetId" : "8551bcf8-5a80-4e85-95d5-7766d59730c6",
"_links" : {
"create message" : {
"href" : "https://app.matatika.com/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6/messages/b45e29ae-1be5-41b1-8d09-6d258d39f6b8"
}
}
}
Create or update a dataset message
PUT
/api/datasets/{dataset-id}/messages/{message-id}
Creates or updates the dataset message {message-id}
for the dataset {dataset-id}
. This appears as DATASET_MESSAGE
notification for the recipient.
Prerequisites
- Dataset
{dataset-id}
must exist
Request
Body
Dataset Message resource.
{
"recipientId" : "auth0|5eb0327cbfd7490bff55feeb",
"message" : "SIT-generated dataset message [2025-06-19T11:13:39.072119]"
}
Example Snippets
cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.matatika.com:443/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6/messages/b45e29ae-1be5-41b1-8d09-6d258d39f6b8' -i -X PUT \
-H 'Accept: application/json, application/javascript, text/javascript, text/json' \
-H 'Content-Type: application/json' \
-d '{
"recipientId" : "auth0|5eb0327cbfd7490bff55feeb",
"message" : "SIT-generated dataset message [2025-06-19T11:13:39.072119]"
}'
Python (requests
)
import requests
url = "https://app.matatika.com:443/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6/messages/b45e29ae-1be5-41b1-8d09-6d258d39f6b8"
data = {
"recipientId" : "auth0|5eb0327cbfd7490bff55feeb",
"message" : "SIT-generated dataset message [2025-06-19T11:13:39.072119]"
}
headers = {
'Authorization': ACCESS_TOKEN
}
response = requests.request("PUT", url, headers=headers, data=data)
print(response.text.encode('utf8'))
Response
200 OK / 201 Created
Dataset Message with HAL links.
{
"id" : "b45e29ae-1be5-41b1-8d09-6d258d39f6b8",
"recipientId" : "auth0|5eb0327cbfd7490bff55feeb",
"message" : "SIT-generated dataset message [2025-06-19T11:13:39.072119]",
"datasetId" : "8551bcf8-5a80-4e85-95d5-7766d59730c6",
"_links" : {
"notification" : {
"href" : "https://app.matatika.com/api/notifications/b45e29ae-1be5-41b1-8d09-6d258d39f6b8"
}
}
}
Delete a dataset
DELETE
/api/datasets/{dataset-id}
Deletes the dataset {dataset-id}
.
Prerequisites
- Dataset
{dataset-id}
must exist
Request
Example Snippets
cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.matatika.com:443/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6' -i -X DELETE \
-H 'Accept: application/json, application/javascript, text/javascript, text/json'
Python (requests
)
import requests
url = "https://app.matatika.com:443/api/datasets/8551bcf8-5a80-4e85-95d5-7766d59730c6"
headers = {
'Authorization': ACCESS_TOKEN
}
response = requests.request("DELETE", url, headers=headers)
print(response.text.encode('utf8'))
Response
204 No Content
No response body provided.
Further Reading: