Tags
Tags are hash-prefixed keywords or phrases that appear in the title, description, or comments of a dataset. Tags can be used to index datasets by their contained tags with a search, which allows for topical dataset categorisation.
Objects
Tag
| Path | JSON Type | Format | Description |
|---|---|---|---|
id |
string |
Version 4 UUID | The tag ID |
name |
string |
The tag name | |
usage |
number |
Unsigned integer | Number of times the tag is used within the workspace |
{
"id" : "d377bf4e-2561-45e9-9ea4-0385e49a042a",
"name" : "fantastic",
"usage" : 1,
"_links" : {
"self" : {
"href" : "https://app.matatika.com/api/workspaces/b6a689c0-a60c-4db0-b3b3-8b3be0a13d71/tags/d377bf4e-2561-45e9-9ea4-0385e49a042a"
},
"search" : {
"href" : "https://app.matatika.com/api/workspaces/b6a689c0-a60c-4db0-b3b3-8b3be0a13d71/search?q=tag:fantastic"
}
}
}
Requests
See Also
View all tags in a workspace
GET
/api/workspaces/{workspace-id}/tags
Returns all tags in the workspace {workspace-id}.
Prerequisites
- Workspace
{workspace-id}must exist
Request
Example Snippets
cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.matatika.com/api/workspaces/b6a689c0-a60c-4db0-b3b3-8b3be0a13d71/tags' -i -X GET \
-H 'Content-Type: application/json'
Python (requests)
import requests
url = "https://app.matatika.com/api/workspaces/b6a689c0-a60c-4db0-b3b3-8b3be0a13d71/tags"
headers = {
'Authorization': ACCESS_TOKEN
}
response = requests.request("GET", url, headers=headers)
print(response.text.encode('utf8'))
Response
200 OK
Tag collection with HAL links.
{
"_embedded" : {
"tags" : [ {
"id" : "28b7970a-abcf-42c2-ab6d-53fe1d79e2b0",
"name" : "postgres",
"usage" : 1,
"_links" : {
"self" : {
"href" : "https://app.matatika.com/api/workspaces/b6a689c0-a60c-4db0-b3b3-8b3be0a13d71/tags/28b7970a-abcf-42c2-ab6d-53fe1d79e2b0"
},
"search" : {
"href" : "https://app.matatika.com/api/workspaces/b6a689c0-a60c-4db0-b3b3-8b3be0a13d71/search?q=tag:postgres"
}
}
}, {
"id" : "d377bf4e-2561-45e9-9ea4-0385e49a042a",
"name" : "fantastic",
"usage" : 1,
"_links" : {
"self" : {
"href" : "https://app.matatika.com/api/workspaces/b6a689c0-a60c-4db0-b3b3-8b3be0a13d71/tags/d377bf4e-2561-45e9-9ea4-0385e49a042a"
},
"search" : {
"href" : "https://app.matatika.com/api/workspaces/b6a689c0-a60c-4db0-b3b3-8b3be0a13d71/search?q=tag:fantastic"
}
}
} ]
},
"_links" : {
"self" : {
"href" : "https://app.matatika.com/api/workspaces/b6a689c0-a60c-4db0-b3b3-8b3be0a13d71/tags"
}
}
}
View all tags in the news for a workspace
GET
/api/workspaces/{workspace-id}/news/tags
Returns all tags in the news for the workspace {workspace-id}.
Prerequisites
- Workspace
{workspace-id}must exist
Response
200 OK
Tag collection with HAL links.
View a tag in a workspace
GET
/api/workspaces/{workspace-id}/tags/{tag-id}
Returns the tag {tag-id} in the workspace {workspace-id}.
Prerequisites
- Workspace
{workspace-id}must exist - Tag
{tag-id}must exist
Request
Example Snippets
cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.matatika.com/api/workspaces/b6a689c0-a60c-4db0-b3b3-8b3be0a13d71/tags/d377bf4e-2561-45e9-9ea4-0385e49a042a' -i -X GET \
-H 'Content-Type: application/json'
Python (requests)
import requests
url = "https://app.matatika.com/api/workspaces/b6a689c0-a60c-4db0-b3b3-8b3be0a13d71/tags/d377bf4e-2561-45e9-9ea4-0385e49a042a"
headers = {
'Authorization': ACCESS_TOKEN
}
response = requests.request("GET", url, headers=headers)
print(response.text.encode('utf8'))
Response
200 OK
Tag with HAL links.
{
"id" : "d377bf4e-2561-45e9-9ea4-0385e49a042a",
"name" : "fantastic",
"usage" : 1,
"_links" : {
"self" : {
"href" : "https://app.matatika.com/api/workspaces/b6a689c0-a60c-4db0-b3b3-8b3be0a13d71/tags/d377bf4e-2561-45e9-9ea4-0385e49a042a"
},
"search" : {
"href" : "https://app.matatika.com/api/workspaces/b6a689c0-a60c-4db0-b3b3-8b3be0a13d71/search?q=tag:fantastic"
}
}
}