Search
Datasets can be searched for within their containing workspace. Searches can filter datasets by arbitrary text, channel name, or tag name.
See here for more information on constructing a search filter query.
Requests
- 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
- Search for datasets in a workspace using msearch
Search for datasets in a workspace by free text
GET
/api/workspaces/{workspaces-id}/search?q={free-text}
Searches the workspace {workspace-id} for datasets by the free text {free-text}.
Prerequisites
- Workspace
{workspace-id}must exist
Request
Example Snippets
cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com:443/api/workspaces/5247ccea-4c80-4e48-945a-eb133f37eb79/search?q=data%20warehouse' -i -X GET \
-H 'Accept: application/json, application/javascript, text/javascript, text/json' \
-H 'Content-Type: application/json'
Python (requests)
import requests
url = "https://catalog.matatika.com:443/api/workspaces/5247ccea-4c80-4e48-945a-eb133f37eb79/search?q=data%20warehouse"
headers = {
'Authorization': ACCESS_TOKEN
}
response = requests.request("GET", url, headers=headers)
print(response.text.encode('utf8'))
Response
200 OK
{
"_embedded" : {
"datasets" : [ {
"id" : "ab52b44e-0949-4cfc-a9b0-2c9d8fbd88b4",
"published" : "2024-04-10T14:07:36.704109",
"alias" : "analytics-tables",
"workspaceId" : "5247ccea-4c80-4e48-945a-eb133f37eb79",
"source" : "no-picture",
"title" : "What tables are in our #fantastic data warehouse?",
"description" : "# Overview\nThis example is a standalone data set with no visualisation.\n\n## What tables are in my data warehouse\nOur query in this dataset selects all the tables in the same schema we have configured the workspace to use.\n```SHOW TABLES```\n\n## Notes\nThe query is database specific. The #postgres query is\n\n```SELECT * FROM pg_tables where schemaname = 'xbzagje'```",
"visualisation" : "{\"google-chart\": {\"chartType\": \"Table\", \"options\": {\"title\": \"Tables\"}}}",
"metadata" : " { \"name\":\"table_model\", \"label\":\"Analytics Tables\", \"related_table\":{ \"columns\":[ { \"name\":\"schemaname\", \"label\":\"Schema Name\" } ] } }",
"query" : "SELECT schemaname \"table_model.schemaname\",tablename \"table_model.tablename\",tableowner \"table_model.tableowner\"FROM pg_tables where schemaname = 'xbzagje'",
"likeCount" : 0,
"likedByProfiles" : [ ],
"commentCount" : 0,
"viewCount" : 0,
"created" : "2024-04-10T14:07:36.704109",
"score" : 21.549282,
"_links" : {
"self" : {
"href" : "https://catalog.matatika.com/api/datasets/ab52b44e-0949-4cfc-a9b0-2c9d8fbd88b4"
},
"delete dataset" : {
"href" : "https://catalog.matatika.com/api/datasets/ab52b44e-0949-4cfc-a9b0-2c9d8fbd88b4",
"type" : "DELETE"
},
"edit dataset" : {
"href" : "https://catalog.matatika.com/api/datasets/ab52b44e-0949-4cfc-a9b0-2c9d8fbd88b4",
"type" : "PATCH"
},
"data" : {
"href" : "https://catalog.matatika.com/api/datasets/ab52b44e-0949-4cfc-a9b0-2c9d8fbd88b4/data",
"type" : "GET"
},
"source" : {
"href" : "https://catalog.matatika.com/api/channels/26d2f726-3d13-40ec-bd60-f96b2c749637",
"type" : "GET"
},
"new comment" : {
"href" : "https://catalog.matatika.com/api/datasets/ab52b44e-0949-4cfc-a9b0-2c9d8fbd88b4/comments",
"type" : "POST"
},
"add like" : {
"href" : "https://catalog.matatika.com/api/datasets/ab52b44e-0949-4cfc-a9b0-2c9d8fbd88b4/like",
"type" : "PUT"
},
"add view" : {
"href" : "https://catalog.matatika.com/api/datasets/ab52b44e-0949-4cfc-a9b0-2c9d8fbd88b4/view",
"type" : "PUT"
},
"new alert" : {
"href" : "https://catalog.matatika.com/api/datasets/ab52b44e-0949-4cfc-a9b0-2c9d8fbd88b4/alerts"
},
"add subscription" : {
"href" : "https://catalog.matatika.com/api/datasets/ab52b44e-0949-4cfc-a9b0-2c9d8fbd88b4/subscriptions"
},
"new message" : {
"href" : "https://catalog.matatika.com/api/datasets/ab52b44e-0949-4cfc-a9b0-2c9d8fbd88b4/messages"
}
},
"_embedded" : {
"source" : {
"name" : "no-picture",
"description" : "No picture",
"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://catalog.matatika.com/api/workspaces/5247ccea-4c80-4e48-945a-eb133f37eb79/search?q=data%20warehouse&page=0&size=20"
}
},
"page" : {
"size" : 20,
"totalElements" : 1,
"totalPages" : 1,
"number" : 0
}
}
204 No Content
No response body provided.
Search for datasets in a workspace by channel name
GET
/api/workspaces/{workspaces-id}/search?q=in:{channel-name}
Searches the workspace {workspace-id} for datasets by the channel {channel-name}.
Prerequisites
- Workspace
{workspace-id}must exist
Request
Example Snippets
cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com:443/api/workspaces/5247ccea-4c80-4e48-945a-eb133f37eb79/search?q=in%3Amatatika-limited%20' -i -X GET \
-H 'Accept: application/json, application/javascript, text/javascript, text/json' \
-H 'Content-Type: application/json'
Python (requests)
import requests
url = "https://catalog.matatika.com:443/api/workspaces/5247ccea-4c80-4e48-945a-eb133f37eb79/search?q=in%3Amatatika-limited%20"
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" : "2ad080c6-76ee-4db3-8d10-24795dafdb80",
"published" : "2024-04-10T14:07:36.705012",
"alias" : "simple-bar-chart",
"workspaceId" : "5247ccea-4c80-4e48-945a-eb133f37eb79",
"source" : "matatika-limited",
"title" : "How many people have visited our website?",
"description" : "# Some Markdown\n- point 1\n- point 2\n- point 3\n",
"questions" : "[''This is my question'', ''this is second question'']",
"visualisation" : "{\"google-chart\": {\"chartType\": \"BarChart\",\"options\": {\"title\": \"Website visitors\"}}}",
"query" : "SELECT to_char(date(report_date),'YYYYMM') as year_month, SUM(sessions) \n FROM\n \"google_analytics_website_overview\"\n WHERE\n \"google_analytics_website_overview\".\"report_date\" >= DATE(NOW()) - INTERVAL '365 DAY'\n GROUP BY year_month\n ORDER BY year_month ASC;",
"likeCount" : 0,
"likedByProfiles" : [ ],
"commentCount" : 0,
"viewCount" : 0,
"created" : "2024-04-10T14:07:36.705012",
"score" : 17.926548,
"_links" : {
"self" : {
"href" : "https://catalog.matatika.com/api/datasets/2ad080c6-76ee-4db3-8d10-24795dafdb80"
},
"delete dataset" : {
"href" : "https://catalog.matatika.com/api/datasets/2ad080c6-76ee-4db3-8d10-24795dafdb80",
"type" : "DELETE"
},
"edit dataset" : {
"href" : "https://catalog.matatika.com/api/datasets/2ad080c6-76ee-4db3-8d10-24795dafdb80",
"type" : "PATCH"
},
"data" : {
"href" : "https://catalog.matatika.com/api/datasets/2ad080c6-76ee-4db3-8d10-24795dafdb80/data",
"type" : "GET"
},
"source" : {
"href" : "https://catalog.matatika.com/api/channels/f9ad94da-d7d2-4d16-9e24-98f81bf23c68",
"type" : "GET"
},
"new comment" : {
"href" : "https://catalog.matatika.com/api/datasets/2ad080c6-76ee-4db3-8d10-24795dafdb80/comments",
"type" : "POST"
},
"add like" : {
"href" : "https://catalog.matatika.com/api/datasets/2ad080c6-76ee-4db3-8d10-24795dafdb80/like",
"type" : "PUT"
},
"add view" : {
"href" : "https://catalog.matatika.com/api/datasets/2ad080c6-76ee-4db3-8d10-24795dafdb80/view",
"type" : "PUT"
},
"new alert" : {
"href" : "https://catalog.matatika.com/api/datasets/2ad080c6-76ee-4db3-8d10-24795dafdb80/alerts"
},
"add subscription" : {
"href" : "https://catalog.matatika.com/api/datasets/2ad080c6-76ee-4db3-8d10-24795dafdb80/subscriptions"
},
"new message" : {
"href" : "https://catalog.matatika.com/api/datasets/2ad080c6-76ee-4db3-8d10-24795dafdb80/messages"
}
},
"_embedded" : {
"source" : {
"name" : "matatika-limited",
"description" : "Matatika Limited",
"picture" : "https://cdn.auth0.com/avatars/ml.png?ssl=1"
}
}
} ]
},
"_links" : {
"self" : {
"href" : "https://catalog.matatika.com/api/workspaces/5247ccea-4c80-4e48-945a-eb133f37eb79/search?q=in%3Amatatika-limited%20&page=0&size=20"
}
},
"page" : {
"size" : 20,
"totalElements" : 1,
"totalPages" : 1,
"number" : 0
}
}
204 No Content
No response body provided.
Search for datasets in a workspace by tag name
GET
/api/workspaces/{workspace-id}/search?q=tag:{tag-name}
Searches the workspace {workspace-id} for datasets by the tag {tag-name}.
Prerequisites
- Workspace
{workspace-id}must exist
Request
Example Snippets
cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com:443/api/workspaces/5247ccea-4c80-4e48-945a-eb133f37eb79/search?q=tag%3Apostgres' -i -X GET \
-H 'Accept: application/json, application/javascript, text/javascript, text/json' \
-H 'Content-Type: application/json'
Python (requests)
import requests
url = "https://catalog.matatika.com:443/api/workspaces/5247ccea-4c80-4e48-945a-eb133f37eb79/search?q=tag%3Apostgres"
headers = {
'Authorization': ACCESS_TOKEN
}
response = requests.request("GET", url, headers=headers)
print(response.text.encode('utf8'))
Response
200 OK
{
"_embedded" : {
"datasets" : [ {
"id" : "ab52b44e-0949-4cfc-a9b0-2c9d8fbd88b4",
"published" : "2024-04-10T14:07:36.704109",
"alias" : "analytics-tables",
"workspaceId" : "5247ccea-4c80-4e48-945a-eb133f37eb79",
"source" : "no-picture",
"title" : "What tables are in our #fantastic data warehouse?",
"description" : "# Overview\nThis example is a standalone data set with no visualisation.\n\n## What tables are in my data warehouse\nOur query in this dataset selects all the tables in the same schema we have configured the workspace to use.\n```SHOW TABLES```\n\n## Notes\nThe query is database specific. The #postgres query is\n\n```SELECT * FROM pg_tables where schemaname = 'xbzagje'```",
"visualisation" : "{\"google-chart\": {\"chartType\": \"Table\", \"options\": {\"title\": \"Tables\"}}}",
"metadata" : " { \"name\":\"table_model\", \"label\":\"Analytics Tables\", \"related_table\":{ \"columns\":[ { \"name\":\"schemaname\", \"label\":\"Schema Name\" } ] } }",
"query" : "SELECT schemaname \"table_model.schemaname\",tablename \"table_model.tablename\",tableowner \"table_model.tableowner\"FROM pg_tables where schemaname = 'xbzagje'",
"likeCount" : 0,
"likedByProfiles" : [ ],
"commentCount" : 0,
"viewCount" : 0,
"created" : "2024-04-10T14:07:36.704109",
"score" : 10.2505,
"_links" : {
"self" : {
"href" : "https://catalog.matatika.com/api/datasets/ab52b44e-0949-4cfc-a9b0-2c9d8fbd88b4"
},
"delete dataset" : {
"href" : "https://catalog.matatika.com/api/datasets/ab52b44e-0949-4cfc-a9b0-2c9d8fbd88b4",
"type" : "DELETE"
},
"edit dataset" : {
"href" : "https://catalog.matatika.com/api/datasets/ab52b44e-0949-4cfc-a9b0-2c9d8fbd88b4",
"type" : "PATCH"
},
"data" : {
"href" : "https://catalog.matatika.com/api/datasets/ab52b44e-0949-4cfc-a9b0-2c9d8fbd88b4/data",
"type" : "GET"
},
"source" : {
"href" : "https://catalog.matatika.com/api/channels/2a92dc19-60c0-4057-bd8b-6507f23bf9c8",
"type" : "GET"
},
"new comment" : {
"href" : "https://catalog.matatika.com/api/datasets/ab52b44e-0949-4cfc-a9b0-2c9d8fbd88b4/comments",
"type" : "POST"
},
"add like" : {
"href" : "https://catalog.matatika.com/api/datasets/ab52b44e-0949-4cfc-a9b0-2c9d8fbd88b4/like",
"type" : "PUT"
},
"add view" : {
"href" : "https://catalog.matatika.com/api/datasets/ab52b44e-0949-4cfc-a9b0-2c9d8fbd88b4/view",
"type" : "PUT"
},
"new alert" : {
"href" : "https://catalog.matatika.com/api/datasets/ab52b44e-0949-4cfc-a9b0-2c9d8fbd88b4/alerts"
},
"add subscription" : {
"href" : "https://catalog.matatika.com/api/datasets/ab52b44e-0949-4cfc-a9b0-2c9d8fbd88b4/subscriptions"
},
"new message" : {
"href" : "https://catalog.matatika.com/api/datasets/ab52b44e-0949-4cfc-a9b0-2c9d8fbd88b4/messages"
}
},
"_embedded" : {
"source" : {
"name" : "no-picture",
"description" : "No picture",
"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://catalog.matatika.com/api/workspaces/5247ccea-4c80-4e48-945a-eb133f37eb79/search?q=tag%3Apostgres&page=0&size=20"
}
},
"page" : {
"size" : 20,
"totalElements" : 1,
"totalPages" : 1,
"number" : 0
}
}
204 No Content
No response body provided.
Search for datasets in a workspace using msearch
POST
/api/workspaces/{workspace-id}/datasets/_msearch
Searches the workspace {workspace-id} for datasets using an elastic search query.
Prerequisites
- Workspace
{workspace-id}must exist
Request
Example Snippets
cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com:443/api/workspaces/5247ccea-4c80-4e48-945a-eb133f37eb79/datasets/_msearch' -i -X POST \
-H 'Accept: application/json, application/javascript, text/javascript, text/json' \
-H 'Content-Type: text/plain; charset=ISO-8859-1' \
-d '{"preference":"search"}
{
"query":{
"bool":{
"must":[
{
"bool":{
"must":{
"bool":{
"should":[
{
"multi_match":{
"query":"data warehouse",
"fields":[
"title"
],
"type":"cross_fields",
"operator":"and"
}
},
{
"multi_match":{
"query":"data warehouse",
"fields":[
"title"
],
"type":"phrase",
"operator":"and"
}
},
{
"multi_match":{
"query":"data warehouse",
"fields":[
"title"
],
"type":"phrase_prefix",
"operator":"and"
}
}
],
"minimum_should_match":"1"
}
}
}
}
]
}
},
"highlight":{
"pre_tags":[
"<mark>"
],
"post_tags":[
"</mark>"
],
"fields":{
"title":{
}
},
"require_field_match":false
},
"size":10,
"_source":{
"includes":[
"*"
],
"excludes":[
]
}
}'
Python (requests)
import requests
url = "https://catalog.matatika.com:443/api/workspaces/5247ccea-4c80-4e48-945a-eb133f37eb79/datasets/_msearch"
data = {"preference":"search"}
{
"query":{
"bool":{
"must":[
{
"bool":{
"must":{
"bool":{
"should":[
{
"multi_match":{
"query":"data warehouse",
"fields":[
"title"
],
"type":"cross_fields",
"operator":"and"
}
},
{
"multi_match":{
"query":"data warehouse",
"fields":[
"title"
],
"type":"phrase",
"operator":"and"
}
},
{
"multi_match":{
"query":"data warehouse",
"fields":[
"title"
],
"type":"phrase_prefix",
"operator":"and"
}
}
],
"minimum_should_match":"1"
}
}
}
}
]
}
},
"highlight":{
"pre_tags":[
"<mark>"
],
"post_tags":[
"</mark>"
],
"fields":{
"title":{
}
},
"require_field_match":false
},
"size":10,
"_source":{
"includes":[
"*"
],
"excludes":[
]
}
}
headers = {
'Authorization': ACCESS_TOKEN
}
response = requests.request("POST", url, headers=headers, data=data)
print(response.text.encode('utf8'))
Response
200 OK
{
"took" : 1,
"timed_out" : false,
"_shards" : {
"failed" : 0.0,
"successful" : 2.0,
"total" : 2.0,
"skipped" : 0.0
},
"hits" : {
"total" : {
"relation" : "eq",
"value" : 1
},
"hits" : [ {
"_index" : "datasets",
"_id" : "ab52b44e-0949-4cfc-a9b0-2c9d8fbd88b4",
"_score" : 48.0051,
"_source" : {
"id" : "ab52b44e-0949-4cfc-a9b0-2c9d8fbd88b4",
"tags" : [ "fantastic", "postgres" ],
"title" : "What tables are in our #fantastic data warehouse?",
"description" : "# Overview\nThis example is a standalone data set with no visualisation.\n\n## What tables are in my data warehouse\nOur query in this dataset selects all the tables in the same schema we have configured the workspace to use.\n```SHOW TABLES```\n\n## Notes\nThe query is database specific. The #postgres query is\n\n```SELECT * FROM pg_tables where schemaname = 'xbzagje'```",
"workspaceId" : "5247ccea-4c80-4e48-945a-eb133f37eb79",
"workspaceOwnerProfile" : "auth0|5eb0327cbfd7490bff55feeb",
"inChannelName" : "no-picture",
"channelName" : "no-picture",
"channelDescription" : "No picture",
"channelPicture" : "https://s.gravatar.com/avatar/8f4ad8fa0793181b761d030196e62053?s=480&r=pg&d=https%3A%2F%2Fcdn.auth0.com%2Favatars%2Fsu.png",
"comments" : [ ],
"alias" : "analytics-tables",
"visualisation" : "{\"google-chart\": {\"chartType\": \"Table\", \"options\": {\"title\": \"Tables\"}}}",
"metadata" : " { \"name\":\"table_model\", \"label\":\"Analytics Tables\", \"related_table\":{ \"columns\":[ { \"name\":\"schemaname\", \"label\":\"Schema Name\" } ] } }",
"likedByProfiles" : [ ],
"likeCount" : 0,
"viewCount" : 0,
"commentCount" : 0,
"created" : "2024-04-10T14:07:36.704109Z",
"lastModified" : "2024-04-10T14:07:36.704109Z",
"lastModifiedMillisDay" : 50856704,
"query" : "SELECT schemaname \"table_model.schemaname\",tablename \"table_model.tablename\",tableowner \"table_model.tableowner\"FROM pg_tables where schemaname = 'xbzagje'",
"lastCommentDate" : "2024-04-10T14:07:36.704109Z",
"lastCommentMillisDay" : 50856704
}
} ],
"max_score" : 48.0051
}
}
204 No Content
No response body provided.