Link Search Menu Expand Document

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

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/26816383-bcb0-43bd-b689-4f050648a646/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/26816383-bcb0-43bd-b689-4f050648a646/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" : "e9600e74-78da-4995-a592-9682f1a56bb4",
      "published" : "2023-03-23T21:48:57.94158",
      "alias" : "analytics-tables",
      "workspaceId" : "26816383-bcb0-43bd-b689-4f050648a646",
      "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 = 'rkbejxe'```",
      "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 = 'rkbejxe'",
      "likeCount" : 0,
      "likedByProfiles" : [ ],
      "commentCount" : 0,
      "viewCount" : 0,
      "created" : "2023-03-23T21:48:57.94158",
      "score" : 20.759422,
      "_links" : {
        "self" : {
          "href" : "https://catalog.matatika.com/api/datasets/e9600e74-78da-4995-a592-9682f1a56bb4"
        },
        "delete dataset" : {
          "href" : "https://catalog.matatika.com/api/datasets/e9600e74-78da-4995-a592-9682f1a56bb4",
          "type" : "DELETE"
        },
        "edit dataset" : {
          "href" : "https://catalog.matatika.com/api/datasets/e9600e74-78da-4995-a592-9682f1a56bb4",
          "type" : "PATCH"
        },
        "data" : {
          "href" : "https://catalog.matatika.com/api/datasets/e9600e74-78da-4995-a592-9682f1a56bb4/data",
          "type" : "GET"
        },
        "source" : {
          "href" : "https://catalog.matatika.com/api/channels/7b4fbda1-5157-4637-b059-0ef2cbaea0f1",
          "type" : "GET"
        },
        "new comment" : {
          "href" : "https://catalog.matatika.com/api/datasets/e9600e74-78da-4995-a592-9682f1a56bb4/comments",
          "type" : "POST"
        },
        "add like" : {
          "href" : "https://catalog.matatika.com/api/datasets/e9600e74-78da-4995-a592-9682f1a56bb4/like",
          "type" : "PUT"
        },
        "add view" : {
          "href" : "https://catalog.matatika.com/api/datasets/e9600e74-78da-4995-a592-9682f1a56bb4/view",
          "type" : "PUT"
        },
        "new alert" : {
          "href" : "https://catalog.matatika.com/api/datasets/e9600e74-78da-4995-a592-9682f1a56bb4/alerts"
        },
        "add subscription" : {
          "href" : "https://catalog.matatika.com/api/datasets/e9600e74-78da-4995-a592-9682f1a56bb4/subscriptions"
        },
        "new message" : {
          "href" : "https://catalog.matatika.com/api/datasets/e9600e74-78da-4995-a592-9682f1a56bb4/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/26816383-bcb0-43bd-b689-4f050648a646/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/26816383-bcb0-43bd-b689-4f050648a646/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/26816383-bcb0-43bd-b689-4f050648a646/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" : "a802f442-7373-4407-be58-e70f0b1542b1",
      "published" : "2023-03-23T21:48:57.94411",
      "alias" : "simple-bar-chart",
      "workspaceId" : "26816383-bcb0-43bd-b689-4f050648a646",
      "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" : "2023-03-23T21:48:57.944109",
      "score" : 17.219315,
      "_links" : {
        "self" : {
          "href" : "https://catalog.matatika.com/api/datasets/a802f442-7373-4407-be58-e70f0b1542b1"
        },
        "delete dataset" : {
          "href" : "https://catalog.matatika.com/api/datasets/a802f442-7373-4407-be58-e70f0b1542b1",
          "type" : "DELETE"
        },
        "edit dataset" : {
          "href" : "https://catalog.matatika.com/api/datasets/a802f442-7373-4407-be58-e70f0b1542b1",
          "type" : "PATCH"
        },
        "data" : {
          "href" : "https://catalog.matatika.com/api/datasets/a802f442-7373-4407-be58-e70f0b1542b1/data",
          "type" : "GET"
        },
        "source" : {
          "href" : "https://catalog.matatika.com/api/channels/187f8a0d-e535-4e65-a023-e0a9bee86522",
          "type" : "GET"
        },
        "new comment" : {
          "href" : "https://catalog.matatika.com/api/datasets/a802f442-7373-4407-be58-e70f0b1542b1/comments",
          "type" : "POST"
        },
        "add like" : {
          "href" : "https://catalog.matatika.com/api/datasets/a802f442-7373-4407-be58-e70f0b1542b1/like",
          "type" : "PUT"
        },
        "add view" : {
          "href" : "https://catalog.matatika.com/api/datasets/a802f442-7373-4407-be58-e70f0b1542b1/view",
          "type" : "PUT"
        },
        "new alert" : {
          "href" : "https://catalog.matatika.com/api/datasets/a802f442-7373-4407-be58-e70f0b1542b1/alerts"
        },
        "add subscription" : {
          "href" : "https://catalog.matatika.com/api/datasets/a802f442-7373-4407-be58-e70f0b1542b1/subscriptions"
        },
        "new message" : {
          "href" : "https://catalog.matatika.com/api/datasets/a802f442-7373-4407-be58-e70f0b1542b1/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/26816383-bcb0-43bd-b689-4f050648a646/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/26816383-bcb0-43bd-b689-4f050648a646/search?q=tag%3Afantastic' -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/26816383-bcb0-43bd-b689-4f050648a646/search?q=tag%3Afantastic"

headers = {
  'Authorization': ACCESS_TOKEN
}

response = requests.request("GET", url, headers=headers)

print(response.text.encode('utf8'))

Response

200 OK

{
  "_embedded" : {
    "datasets" : [ {
      "id" : "e9600e74-78da-4995-a592-9682f1a56bb4",
      "published" : "2023-03-23T21:48:57.94158",
      "alias" : "analytics-tables",
      "workspaceId" : "26816383-bcb0-43bd-b689-4f050648a646",
      "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 = 'rkbejxe'```",
      "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 = 'rkbejxe'",
      "likeCount" : 0,
      "likedByProfiles" : [ ],
      "commentCount" : 0,
      "viewCount" : 0,
      "created" : "2023-03-23T21:48:57.94158",
      "score" : 9.553192,
      "_links" : {
        "self" : {
          "href" : "https://catalog.matatika.com/api/datasets/e9600e74-78da-4995-a592-9682f1a56bb4"
        },
        "delete dataset" : {
          "href" : "https://catalog.matatika.com/api/datasets/e9600e74-78da-4995-a592-9682f1a56bb4",
          "type" : "DELETE"
        },
        "edit dataset" : {
          "href" : "https://catalog.matatika.com/api/datasets/e9600e74-78da-4995-a592-9682f1a56bb4",
          "type" : "PATCH"
        },
        "data" : {
          "href" : "https://catalog.matatika.com/api/datasets/e9600e74-78da-4995-a592-9682f1a56bb4/data",
          "type" : "GET"
        },
        "source" : {
          "href" : "https://catalog.matatika.com/api/channels/2e55d56e-bf9f-4a8d-b266-77ffe7d8f047",
          "type" : "GET"
        },
        "new comment" : {
          "href" : "https://catalog.matatika.com/api/datasets/e9600e74-78da-4995-a592-9682f1a56bb4/comments",
          "type" : "POST"
        },
        "add like" : {
          "href" : "https://catalog.matatika.com/api/datasets/e9600e74-78da-4995-a592-9682f1a56bb4/like",
          "type" : "PUT"
        },
        "add view" : {
          "href" : "https://catalog.matatika.com/api/datasets/e9600e74-78da-4995-a592-9682f1a56bb4/view",
          "type" : "PUT"
        },
        "new alert" : {
          "href" : "https://catalog.matatika.com/api/datasets/e9600e74-78da-4995-a592-9682f1a56bb4/alerts"
        },
        "add subscription" : {
          "href" : "https://catalog.matatika.com/api/datasets/e9600e74-78da-4995-a592-9682f1a56bb4/subscriptions"
        },
        "new message" : {
          "href" : "https://catalog.matatika.com/api/datasets/e9600e74-78da-4995-a592-9682f1a56bb4/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/26816383-bcb0-43bd-b689-4f050648a646/search?q=tag%3Afantastic&page=0&size=20"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

204 No Content

No response body provided.