Tagging Datasets 🔗

Tags allow to only view a subset of variables inside the dataset.

Adding tags 🔗

You can add tags to the dataset by POST to the tags endpoint

POST /api/datasets/{dataset_id}/tags/ HTTP/1.1
Host: app.crunch.io
Content-Type: application/json

{
  "body": {
      "name": "<name_of_new_tag>",
      "variables": [
          "<var_url_1>",
          "<var_url_2>",
          "..."
      ]
  }
}

-----
HTTP/1.1 202 Accepted


{
    "element": "shoji:view",
    "self": "https://app.crunch.io/api/datasets/{dataset_id}/tags/{<name_of_new_tag>}"
}

Filtering by tag 🔗

You can filter variables by tag the using the folder endpoint reference. Some examples are:

  • /datasets/{id}/folders/?tag=tag1
  • /datasets/{id}/folders/?tag=tag1&tag=tag%202

Set the selected tags 🔗

Use the dataset preferences to set which tags are selected. This is can be used by API clients to filter variables using the method explained above.

{
    "element": "shoji:entity",
    "self": "https://app.crunch.io/api/datasets/223fd4/preferences/",
    "body": {
      "selected_tags": ["tag name"]
    }
}