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" : "9b36cc35-7ad9-47e4-9d30-5f3c66040473",
  "published" : "2025-05-02T08:55:11.998479",
  "alias" : "sit-generated-dataset",
  "workspaceId" : "a846f4c0-b968-4f29-9eaa-e06546c3f246",
  "source" : "@sit+prod",
  "title" : "SIT-Generated Dataset [2025-05-02T09:55:11.945625]",
  "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-05-02T08:55:11.998478",
  "score" : 1.0,
  "_links" : {
    "self" : {
      "href" : "https://app.matatika.com/api/datasets/9b36cc35-7ad9-47e4-9d30-5f3c66040473"
    },
    "delete dataset" : {
      "href" : "https://app.matatika.com/api/datasets/9b36cc35-7ad9-47e4-9d30-5f3c66040473",
      "type" : "DELETE"
    },
    "edit dataset" : {
      "href" : "https://app.matatika.com/api/datasets/9b36cc35-7ad9-47e4-9d30-5f3c66040473",
      "type" : "PATCH"
    },
    "data" : {
      "href" : "https://app.matatika.com/api/datasets/9b36cc35-7ad9-47e4-9d30-5f3c66040473/data",
      "type" : "GET"
    },
    "source" : {
      "href" : "https://app.matatika.com/api/channels/1b09d29d-9ca8-402f-988e-9c29ee91c405",
      "type" : "GET"
    },
    "new comment" : {
      "href" : "https://app.matatika.com/api/datasets/9b36cc35-7ad9-47e4-9d30-5f3c66040473/comments",
      "type" : "POST"
    },
    "add like" : {
      "href" : "https://app.matatika.com/api/datasets/9b36cc35-7ad9-47e4-9d30-5f3c66040473/like",
      "type" : "PUT"
    },
    "add view" : {
      "href" : "https://app.matatika.com/api/datasets/9b36cc35-7ad9-47e4-9d30-5f3c66040473/view",
      "type" : "PUT"
    },
    "new alert" : {
      "href" : "https://app.matatika.com/api/datasets/9b36cc35-7ad9-47e4-9d30-5f3c66040473/alerts"
    },
    "add subscription" : {
      "href" : "https://app.matatika.com/api/datasets/9b36cc35-7ad9-47e4-9d30-5f3c66040473/subscriptions"
    },
    "new message" : {
      "href" : "https://app.matatika.com/api/datasets/9b36cc35-7ad9-47e4-9d30-5f3c66040473/messages"
    }
  },
  "_embedded" : {
    "source" : {
      "name" : "@sit+prod",
      "description" : "sit+prod@matatika.com 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" : "9fb70cc1-fb81-4dc2-afb1-2b6ac624e0b1",
  "recipientId" : "auth0|5eb0327cbfd7490bff55feeb",
  "message" : "SIT-generated dataset message [2025-05-02T09:55:12.877779]",
  "datasetId" : "9b36cc35-7ad9-47e4-9d30-5f3c66040473",
  "_links" : {
    "notification" : {
      "href" : "https://app.matatika.com/api/notifications/9fb70cc1-fb81-4dc2-afb1-2b6ac624e0b1"
    }
  }
}

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 -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.matatika.com/api/workspaces/a846f4c0-b968-4f29-9eaa-e06546c3f246/datasets' -i -X GET \
    -H 'Content-Type: application/json'

Response

200 OK

Dataset collection with HAL links.

{
  "_embedded" : {
    "datasets" : [ {
      "id" : "159be65f-6ec7-48e2-834e-58f66d64c286",
      "published" : "2025-05-02T08:55:13.30895",
      "workspaceId" : "a846f4c0-b968-4f29-9eaa-e06546c3f246",
      "source" : "@sit+prod",
      "title" : "SIT-Generated Dataset [2025-05-02T09:55:11.945625]",
      "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-05-02T08:55:13.30895",
      "score" : 1.0,
      "_links" : {
        "self" : {
          "href" : "https://app.matatika.com/api/datasets/159be65f-6ec7-48e2-834e-58f66d64c286"
        },
        "delete dataset" : {
          "href" : "https://app.matatika.com/api/datasets/159be65f-6ec7-48e2-834e-58f66d64c286",
          "type" : "DELETE"
        },
        "edit dataset" : {
          "href" : "https://app.matatika.com/api/datasets/159be65f-6ec7-48e2-834e-58f66d64c286",
          "type" : "PATCH"
        },
        "data" : {
          "href" : "https://app.matatika.com/api/datasets/159be65f-6ec7-48e2-834e-58f66d64c286/data",
          "type" : "GET"
        },
        "source" : {
          "href" : "https://app.matatika.com/api/channels/1b09d29d-9ca8-402f-988e-9c29ee91c405",
          "type" : "GET"
        },
        "new comment" : {
          "href" : "https://app.matatika.com/api/datasets/159be65f-6ec7-48e2-834e-58f66d64c286/comments",
          "type" : "POST"
        },
        "add like" : {
          "href" : "https://app.matatika.com/api/datasets/159be65f-6ec7-48e2-834e-58f66d64c286/like",
          "type" : "PUT"
        },
        "add view" : {
          "href" : "https://app.matatika.com/api/datasets/159be65f-6ec7-48e2-834e-58f66d64c286/view",
          "type" : "PUT"
        },
        "new alert" : {
          "href" : "https://app.matatika.com/api/datasets/159be65f-6ec7-48e2-834e-58f66d64c286/alerts"
        },
        "add subscription" : {
          "href" : "https://app.matatika.com/api/datasets/159be65f-6ec7-48e2-834e-58f66d64c286/subscriptions"
        },
        "new message" : {
          "href" : "https://app.matatika.com/api/datasets/159be65f-6ec7-48e2-834e-58f66d64c286/messages"
        }
      },
      "_embedded" : {
        "source" : {
          "name" : "@sit+prod",
          "description" : "sit+prod@matatika.com Channel"
        }
      }
    }, {
      "id" : "294a0d35-0261-4adf-adfb-4fdd4593d490",
      "published" : "2025-05-02T08:55:13.384057",
      "workspaceId" : "a846f4c0-b968-4f29-9eaa-e06546c3f246",
      "source" : "@sit+prod",
      "title" : "SIT-Generated Dataset [2025-05-02T09:55:11.945625]",
      "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-05-02T08:55:13.384057",
      "score" : 1.0,
      "_links" : {
        "self" : {
          "href" : "https://app.matatika.com/api/datasets/294a0d35-0261-4adf-adfb-4fdd4593d490"
        },
        "delete dataset" : {
          "href" : "https://app.matatika.com/api/datasets/294a0d35-0261-4adf-adfb-4fdd4593d490",
          "type" : "DELETE"
        },
        "edit dataset" : {
          "href" : "https://app.matatika.com/api/datasets/294a0d35-0261-4adf-adfb-4fdd4593d490",
          "type" : "PATCH"
        },
        "data" : {
          "href" : "https://app.matatika.com/api/datasets/294a0d35-0261-4adf-adfb-4fdd4593d490/data",
          "type" : "GET"
        },
        "source" : {
          "href" : "https://app.matatika.com/api/channels/1b09d29d-9ca8-402f-988e-9c29ee91c405",
          "type" : "GET"
        },
        "new comment" : {
          "href" : "https://app.matatika.com/api/datasets/294a0d35-0261-4adf-adfb-4fdd4593d490/comments",
          "type" : "POST"
        },
        "add like" : {
          "href" : "https://app.matatika.com/api/datasets/294a0d35-0261-4adf-adfb-4fdd4593d490/like",
          "type" : "PUT"
        },
        "add view" : {
          "href" : "https://app.matatika.com/api/datasets/294a0d35-0261-4adf-adfb-4fdd4593d490/view",
          "type" : "PUT"
        },
        "new alert" : {
          "href" : "https://app.matatika.com/api/datasets/294a0d35-0261-4adf-adfb-4fdd4593d490/alerts"
        },
        "add subscription" : {
          "href" : "https://app.matatika.com/api/datasets/294a0d35-0261-4adf-adfb-4fdd4593d490/subscriptions"
        },
        "new message" : {
          "href" : "https://app.matatika.com/api/datasets/294a0d35-0261-4adf-adfb-4fdd4593d490/messages"
        }
      },
      "_embedded" : {
        "source" : {
          "name" : "@sit+prod",
          "description" : "sit+prod@matatika.com Channel"
        }
      }
    }, {
      "id" : "37de294f-2e82-434f-a173-72f74490e49f",
      "published" : "2025-05-02T08:55:13.462042",
      "workspaceId" : "a846f4c0-b968-4f29-9eaa-e06546c3f246",
      "source" : "@sit+prod",
      "title" : "SIT-Generated Dataset [2025-05-02T09:55:11.945625]",
      "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-05-02T08:55:13.462042",
      "score" : 1.0,
      "_links" : {
        "self" : {
          "href" : "https://app.matatika.com/api/datasets/37de294f-2e82-434f-a173-72f74490e49f"
        },
        "delete dataset" : {
          "href" : "https://app.matatika.com/api/datasets/37de294f-2e82-434f-a173-72f74490e49f",
          "type" : "DELETE"
        },
        "edit dataset" : {
          "href" : "https://app.matatika.com/api/datasets/37de294f-2e82-434f-a173-72f74490e49f",
          "type" : "PATCH"
        },
        "data" : {
          "href" : "https://app.matatika.com/api/datasets/37de294f-2e82-434f-a173-72f74490e49f/data",
          "type" : "GET"
        },
        "source" : {
          "href" : "https://app.matatika.com/api/channels/1b09d29d-9ca8-402f-988e-9c29ee91c405",
          "type" : "GET"
        },
        "new comment" : {
          "href" : "https://app.matatika.com/api/datasets/37de294f-2e82-434f-a173-72f74490e49f/comments",
          "type" : "POST"
        },
        "add like" : {
          "href" : "https://app.matatika.com/api/datasets/37de294f-2e82-434f-a173-72f74490e49f/like",
          "type" : "PUT"
        },
        "add view" : {
          "href" : "https://app.matatika.com/api/datasets/37de294f-2e82-434f-a173-72f74490e49f/view",
          "type" : "PUT"
        },
        "new alert" : {
          "href" : "https://app.matatika.com/api/datasets/37de294f-2e82-434f-a173-72f74490e49f/alerts"
        },
        "add subscription" : {
          "href" : "https://app.matatika.com/api/datasets/37de294f-2e82-434f-a173-72f74490e49f/subscriptions"
        },
        "new message" : {
          "href" : "https://app.matatika.com/api/datasets/37de294f-2e82-434f-a173-72f74490e49f/messages"
        }
      },
      "_embedded" : {
        "source" : {
          "name" : "@sit+prod",
          "description" : "sit+prod@matatika.com Channel"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://app.matatika.com/api/workspaces/a846f4c0-b968-4f29-9eaa-e06546c3f246/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 -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.matatika.com/api/workspaces/a846f4c0-b968-4f29-9eaa-e06546c3f246/liked' -i -X GET \
    -H 'Content-Type: application/json'

Response

200 OK

Dataset collection with HAL links.

{
  "_embedded" : {
    "datasets" : [ {
      "id" : "9b36cc35-7ad9-47e4-9d30-5f3c66040473",
      "published" : "2025-05-02T08:55:12.264009",
      "alias" : "sit-generated-dataset",
      "workspaceId" : "a846f4c0-b968-4f29-9eaa-e06546c3f246",
      "source" : "@sit+prod",
      "title" : "SIT-Generated Dataset [2025-05-02T09:55:12.215298]",
      "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" : "sit+prod@matatika.com",
        "handle" : "@sit+prod"
      } ],
      "commentCount" : 0,
      "viewCount" : 1,
      "created" : "2025-05-02T08:55:11.998478",
      "score" : 1.0,
      "_links" : {
        "self" : {
          "href" : "https://app.matatika.com/api/datasets/9b36cc35-7ad9-47e4-9d30-5f3c66040473"
        },
        "delete dataset" : {
          "href" : "https://app.matatika.com/api/datasets/9b36cc35-7ad9-47e4-9d30-5f3c66040473",
          "type" : "DELETE"
        },
        "edit dataset" : {
          "href" : "https://app.matatika.com/api/datasets/9b36cc35-7ad9-47e4-9d30-5f3c66040473",
          "type" : "PATCH"
        },
        "data" : {
          "href" : "https://app.matatika.com/api/datasets/9b36cc35-7ad9-47e4-9d30-5f3c66040473/data",
          "type" : "GET"
        },
        "source" : {
          "href" : "https://app.matatika.com/api/channels/1b09d29d-9ca8-402f-988e-9c29ee91c405",
          "type" : "GET"
        },
        "new comment" : {
          "href" : "https://app.matatika.com/api/datasets/9b36cc35-7ad9-47e4-9d30-5f3c66040473/comments",
          "type" : "POST"
        },
        "remove like" : {
          "href" : "https://app.matatika.com/api/datasets/9b36cc35-7ad9-47e4-9d30-5f3c66040473/like",
          "type" : "DELETE"
        },
        "add view" : {
          "href" : "https://app.matatika.com/api/datasets/9b36cc35-7ad9-47e4-9d30-5f3c66040473/view",
          "type" : "PUT"
        },
        "new alert" : {
          "href" : "https://app.matatika.com/api/datasets/9b36cc35-7ad9-47e4-9d30-5f3c66040473/alerts"
        },
        "add subscription" : {
          "href" : "https://app.matatika.com/api/datasets/9b36cc35-7ad9-47e4-9d30-5f3c66040473/subscriptions"
        },
        "new message" : {
          "href" : "https://app.matatika.com/api/datasets/9b36cc35-7ad9-47e4-9d30-5f3c66040473/messages"
        }
      },
      "_embedded" : {
        "source" : {
          "name" : "@sit+prod",
          "description" : "sit+prod@matatika.com Channel"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://app.matatika.com/api/workspaces/a846f4c0-b968-4f29-9eaa-e06546c3f246/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 -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.matatika.com/api/channels/1b09d29d-9ca8-402f-988e-9c29ee91c405/datasets' -i -X GET \
    -H 'Content-Type: application/json'

Response

200 OK

Dataset collection with HAL links.

{
  "_embedded" : {
    "datasets" : [ {
      "id" : "159be65f-6ec7-48e2-834e-58f66d64c286",
      "published" : "2025-05-02T08:55:13.30895",
      "workspaceId" : "a846f4c0-b968-4f29-9eaa-e06546c3f246",
      "source" : "@sit+prod",
      "title" : "SIT-Generated Dataset [2025-05-02T09:55:11.945625]",
      "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-05-02T08:55:13.30895",
      "score" : 1.0,
      "_links" : {
        "self" : {
          "href" : "https://app.matatika.com/api/datasets/159be65f-6ec7-48e2-834e-58f66d64c286"
        },
        "delete dataset" : {
          "href" : "https://app.matatika.com/api/datasets/159be65f-6ec7-48e2-834e-58f66d64c286",
          "type" : "DELETE"
        },
        "edit dataset" : {
          "href" : "https://app.matatika.com/api/datasets/159be65f-6ec7-48e2-834e-58f66d64c286",
          "type" : "PATCH"
        },
        "data" : {
          "href" : "https://app.matatika.com/api/datasets/159be65f-6ec7-48e2-834e-58f66d64c286/data",
          "type" : "GET"
        },
        "source" : {
          "href" : "https://app.matatika.com/api/channels/1b09d29d-9ca8-402f-988e-9c29ee91c405",
          "type" : "GET"
        },
        "new comment" : {
          "href" : "https://app.matatika.com/api/datasets/159be65f-6ec7-48e2-834e-58f66d64c286/comments",
          "type" : "POST"
        },
        "add like" : {
          "href" : "https://app.matatika.com/api/datasets/159be65f-6ec7-48e2-834e-58f66d64c286/like",
          "type" : "PUT"
        },
        "add view" : {
          "href" : "https://app.matatika.com/api/datasets/159be65f-6ec7-48e2-834e-58f66d64c286/view",
          "type" : "PUT"
        },
        "new alert" : {
          "href" : "https://app.matatika.com/api/datasets/159be65f-6ec7-48e2-834e-58f66d64c286/alerts"
        },
        "add subscription" : {
          "href" : "https://app.matatika.com/api/datasets/159be65f-6ec7-48e2-834e-58f66d64c286/subscriptions"
        },
        "new message" : {
          "href" : "https://app.matatika.com/api/datasets/159be65f-6ec7-48e2-834e-58f66d64c286/messages"
        }
      },
      "_embedded" : {
        "source" : {
          "name" : "@sit+prod",
          "description" : "sit+prod@matatika.com Channel"
        }
      }
    }, {
      "id" : "294a0d35-0261-4adf-adfb-4fdd4593d490",
      "published" : "2025-05-02T08:55:13.384057",
      "workspaceId" : "a846f4c0-b968-4f29-9eaa-e06546c3f246",
      "source" : "@sit+prod",
      "title" : "SIT-Generated Dataset [2025-05-02T09:55:11.945625]",
      "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-05-02T08:55:13.384057",
      "score" : 1.0,
      "_links" : {
        "self" : {
          "href" : "https://app.matatika.com/api/datasets/294a0d35-0261-4adf-adfb-4fdd4593d490"
        },
        "delete dataset" : {
          "href" : "https://app.matatika.com/api/datasets/294a0d35-0261-4adf-adfb-4fdd4593d490",
          "type" : "DELETE"
        },
        "edit dataset" : {
          "href" : "https://app.matatika.com/api/datasets/294a0d35-0261-4adf-adfb-4fdd4593d490",
          "type" : "PATCH"
        },
        "data" : {
          "href" : "https://app.matatika.com/api/datasets/294a0d35-0261-4adf-adfb-4fdd4593d490/data",
          "type" : "GET"
        },
        "source" : {
          "href" : "https://app.matatika.com/api/channels/1b09d29d-9ca8-402f-988e-9c29ee91c405",
          "type" : "GET"
        },
        "new comment" : {
          "href" : "https://app.matatika.com/api/datasets/294a0d35-0261-4adf-adfb-4fdd4593d490/comments",
          "type" : "POST"
        },
        "add like" : {
          "href" : "https://app.matatika.com/api/datasets/294a0d35-0261-4adf-adfb-4fdd4593d490/like",
          "type" : "PUT"
        },
        "add view" : {
          "href" : "https://app.matatika.com/api/datasets/294a0d35-0261-4adf-adfb-4fdd4593d490/view",
          "type" : "PUT"
        },
        "new alert" : {
          "href" : "https://app.matatika.com/api/datasets/294a0d35-0261-4adf-adfb-4fdd4593d490/alerts"
        },
        "add subscription" : {
          "href" : "https://app.matatika.com/api/datasets/294a0d35-0261-4adf-adfb-4fdd4593d490/subscriptions"
        },
        "new message" : {
          "href" : "https://app.matatika.com/api/datasets/294a0d35-0261-4adf-adfb-4fdd4593d490/messages"
        }
      },
      "_embedded" : {
        "source" : {
          "name" : "@sit+prod",
          "description" : "sit+prod@matatika.com Channel"
        }
      }
    }, {
      "id" : "37de294f-2e82-434f-a173-72f74490e49f",
      "published" : "2025-05-02T08:55:13.462042",
      "workspaceId" : "a846f4c0-b968-4f29-9eaa-e06546c3f246",
      "source" : "@sit+prod",
      "title" : "SIT-Generated Dataset [2025-05-02T09:55:11.945625]",
      "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-05-02T08:55:13.462042",
      "score" : 1.0,
      "_links" : {
        "self" : {
          "href" : "https://app.matatika.com/api/datasets/37de294f-2e82-434f-a173-72f74490e49f"
        },
        "delete dataset" : {
          "href" : "https://app.matatika.com/api/datasets/37de294f-2e82-434f-a173-72f74490e49f",
          "type" : "DELETE"
        },
        "edit dataset" : {
          "href" : "https://app.matatika.com/api/datasets/37de294f-2e82-434f-a173-72f74490e49f",
          "type" : "PATCH"
        },
        "data" : {
          "href" : "https://app.matatika.com/api/datasets/37de294f-2e82-434f-a173-72f74490e49f/data",
          "type" : "GET"
        },
        "source" : {
          "href" : "https://app.matatika.com/api/channels/1b09d29d-9ca8-402f-988e-9c29ee91c405",
          "type" : "GET"
        },
        "new comment" : {
          "href" : "https://app.matatika.com/api/datasets/37de294f-2e82-434f-a173-72f74490e49f/comments",
          "type" : "POST"
        },
        "add like" : {
          "href" : "https://app.matatika.com/api/datasets/37de294f-2e82-434f-a173-72f74490e49f/like",
          "type" : "PUT"
        },
        "add view" : {
          "href" : "https://app.matatika.com/api/datasets/37de294f-2e82-434f-a173-72f74490e49f/view",
          "type" : "PUT"
        },
        "new alert" : {
          "href" : "https://app.matatika.com/api/datasets/37de294f-2e82-434f-a173-72f74490e49f/alerts"
        },
        "add subscription" : {
          "href" : "https://app.matatika.com/api/datasets/37de294f-2e82-434f-a173-72f74490e49f/subscriptions"
        },
        "new message" : {
          "href" : "https://app.matatika.com/api/datasets/37de294f-2e82-434f-a173-72f74490e49f/messages"
        }
      },
      "_embedded" : {
        "source" : {
          "name" : "@sit+prod",
          "description" : "sit+prod@matatika.com Channel"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://app.matatika.com/api/channels/1b09d29d-9ca8-402f-988e-9c29ee91c405/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 -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.matatika.com/api/datasets/9b36cc35-7ad9-47e4-9d30-5f3c66040473' -i -X GET \
    -H 'Content-Type: application/json'

Response

200 OK

Dataset with HAL links.

{
  "id" : "9b36cc35-7ad9-47e4-9d30-5f3c66040473",
  "published" : "2025-05-02T08:55:11.998479",
  "alias" : "sit-generated-dataset",
  "workspaceId" : "a846f4c0-b968-4f29-9eaa-e06546c3f246",
  "source" : "@sit+prod",
  "title" : "SIT-Generated Dataset [2025-05-02T09:55:11.945625]",
  "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-05-02T08:55:11.998478",
  "score" : 1.0,
  "_links" : {
    "self" : {
      "href" : "https://app.matatika.com/api/datasets/9b36cc35-7ad9-47e4-9d30-5f3c66040473"
    },
    "delete dataset" : {
      "href" : "https://app.matatika.com/api/datasets/9b36cc35-7ad9-47e4-9d30-5f3c66040473",
      "type" : "DELETE"
    },
    "edit dataset" : {
      "href" : "https://app.matatika.com/api/datasets/9b36cc35-7ad9-47e4-9d30-5f3c66040473",
      "type" : "PATCH"
    },
    "data" : {
      "href" : "https://app.matatika.com/api/datasets/9b36cc35-7ad9-47e4-9d30-5f3c66040473/data",
      "type" : "GET"
    },
    "source" : {
      "href" : "https://app.matatika.com/api/channels/1b09d29d-9ca8-402f-988e-9c29ee91c405",
      "type" : "GET"
    },
    "new comment" : {
      "href" : "https://app.matatika.com/api/datasets/9b36cc35-7ad9-47e4-9d30-5f3c66040473/comments",
      "type" : "POST"
    },
    "add like" : {
      "href" : "https://app.matatika.com/api/datasets/9b36cc35-7ad9-47e4-9d30-5f3c66040473/like",
      "type" : "PUT"
    },
    "add view" : {
      "href" : "https://app.matatika.com/api/datasets/9b36cc35-7ad9-47e4-9d30-5f3c66040473/view",
      "type" : "PUT"
    },
    "new alert" : {
      "href" : "https://app.matatika.com/api/datasets/9b36cc35-7ad9-47e4-9d30-5f3c66040473/alerts"
    },
    "add subscription" : {
      "href" : "https://app.matatika.com/api/datasets/9b36cc35-7ad9-47e4-9d30-5f3c66040473/subscriptions"
    },
    "new message" : {
      "href" : "https://app.matatika.com/api/datasets/9b36cc35-7ad9-47e4-9d30-5f3c66040473/messages"
    }
  },
  "_embedded" : {
    "source" : {
      "name" : "@sit+prod",
      "description" : "sit+prod@matatika.com 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 -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.matatika.com/api/workspaces/a846f4c0-b968-4f29-9eaa-e06546c3f246/datasets/sit-generated-dataset' -i -X GET \
    -H 'Content-Type: application/json'

Response

200 OK

Dataset with HAL links.

{
  "id" : "9b36cc35-7ad9-47e4-9d30-5f3c66040473",
  "published" : "2025-05-02T08:55:11.998479",
  "alias" : "sit-generated-dataset",
  "workspaceId" : "a846f4c0-b968-4f29-9eaa-e06546c3f246",
  "source" : "@sit+prod",
  "title" : "SIT-Generated Dataset [2025-05-02T09:55:11.945625]",
  "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-05-02T08:55:11.998478",
  "score" : 1.0,
  "_links" : {
    "self" : {
      "href" : "https://app.matatika.com/api/datasets/9b36cc35-7ad9-47e4-9d30-5f3c66040473"
    },
    "delete dataset" : {
      "href" : "https://app.matatika.com/api/datasets/9b36cc35-7ad9-47e4-9d30-5f3c66040473",
      "type" : "DELETE"
    },
    "edit dataset" : {
      "href" : "https://app.matatika.com/api/datasets/9b36cc35-7ad9-47e4-9d30-5f3c66040473",
      "type" : "PATCH"
    },
    "data" : {
      "href" : "https://app.matatika.com/api/datasets/9b36cc35-7ad9-47e4-9d30-5f3c66040473/data",
      "type" : "GET"
    },
    "source" : {
      "href" : "https://app.matatika.com/api/channels/1b09d29d-9ca8-402f-988e-9c29ee91c405",
      "type" : "GET"
    },
    "new comment" : {
      "href" : "https://app.matatika.com/api/datasets/9b36cc35-7ad9-47e4-9d30-5f3c66040473/comments",
      "type" : "POST"
    },
    "add like" : {
      "href" : "https://app.matatika.com/api/datasets/9b36cc35-7ad9-47e4-9d30-5f3c66040473/like",
      "type" : "PUT"
    },
    "add view" : {
      "href" : "https://app.matatika.com/api/datasets/9b36cc35-7ad9-47e4-9d30-5f3c66040473/view",
      "type" : "PUT"
    },
    "new alert" : {
      "href" : "https://app.matatika.com/api/datasets/9b36cc35-7ad9-47e4-9d30-5f3c66040473/alerts"
    },
    "add subscription" : {
      "href" : "https://app.matatika.com/api/datasets/9b36cc35-7ad9-47e4-9d30-5f3c66040473/subscriptions"
    },
    "new message" : {
      "href" : "https://app.matatika.com/api/datasets/9b36cc35-7ad9-47e4-9d30-5f3c66040473/messages"
    }
  },
  "_embedded" : {
    "source" : {
      "name" : "@sit+prod",
      "description" : "sit+prod@matatika.com 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 -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.matatika.com/api/datasets/03ed1eab-dd09-4441-ba58-b449d51236d9/data' -i -X GET \
    -H 'Content-Type: application/json'

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-05-02T09:55:11.945625]",
  "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 -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.matatika.com/api/workspaces/a846f4c0-b968-4f29-9eaa-e06546c3f246/datasets' -i -X POST \
    -H 'Content-Type: application/json' \
    -d '{
  "alias" : "sit-generated-dataset",
  "title" : "SIT-Generated Dataset [2025-05-02T09:55:11.945625]",
  "description" : "This dataset was created during a SIT run.",
  "questions" : "What questions might this dataset help answer?",
  "query" : "SELECT * FROM table_name;"
}'

Response

200 OK / 201 Created

Dataset with HAL links.

{
  "id" : "9b36cc35-7ad9-47e4-9d30-5f3c66040473",
  "published" : "2025-05-02T08:55:11.998478655",
  "alias" : "sit-generated-dataset",
  "workspaceId" : "a846f4c0-b968-4f29-9eaa-e06546c3f246",
  "source" : "@sit+prod",
  "title" : "SIT-Generated Dataset [2025-05-02T09:55:11.945625]",
  "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-05-02T08:55:11.998478255",
  "score" : 1.0,
  "_links" : {
    "self" : {
      "href" : "https://app.matatika.com/api/datasets/9b36cc35-7ad9-47e4-9d30-5f3c66040473"
    },
    "delete dataset" : {
      "href" : "https://app.matatika.com/api/datasets/9b36cc35-7ad9-47e4-9d30-5f3c66040473",
      "type" : "DELETE"
    },
    "edit dataset" : {
      "href" : "https://app.matatika.com/api/datasets/9b36cc35-7ad9-47e4-9d30-5f3c66040473",
      "type" : "PATCH"
    },
    "data" : {
      "href" : "https://app.matatika.com/api/datasets/9b36cc35-7ad9-47e4-9d30-5f3c66040473/data",
      "type" : "GET"
    },
    "source" : {
      "href" : "https://app.matatika.com/api/channels/1b09d29d-9ca8-402f-988e-9c29ee91c405",
      "type" : "GET"
    },
    "new comment" : {
      "href" : "https://app.matatika.com/api/datasets/9b36cc35-7ad9-47e4-9d30-5f3c66040473/comments",
      "type" : "POST"
    },
    "add like" : {
      "href" : "https://app.matatika.com/api/datasets/9b36cc35-7ad9-47e4-9d30-5f3c66040473/like",
      "type" : "PUT"
    },
    "add view" : {
      "href" : "https://app.matatika.com/api/datasets/9b36cc35-7ad9-47e4-9d30-5f3c66040473/view",
      "type" : "PUT"
    },
    "new alert" : {
      "href" : "https://app.matatika.com/api/datasets/9b36cc35-7ad9-47e4-9d30-5f3c66040473/alerts"
    },
    "add subscription" : {
      "href" : "https://app.matatika.com/api/datasets/9b36cc35-7ad9-47e4-9d30-5f3c66040473/subscriptions"
    },
    "new message" : {
      "href" : "https://app.matatika.com/api/datasets/9b36cc35-7ad9-47e4-9d30-5f3c66040473/messages"
    }
  },
  "_embedded" : {
    "source" : {
      "name" : "@sit+prod",
      "description" : "sit+prod@matatika.com 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-05-02T09:55:12.215298]",
  "description" : "This dataset was edited during a SIT run."
}

Example Snippets

curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.matatika.com/api/datasets/9b36cc35-7ad9-47e4-9d30-5f3c66040473' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -d '{
  "title" : "SIT-Generated Dataset [2025-05-02T09:55:12.215298]",
  "description" : "This dataset was edited during a SIT run."
}'

Response

200 OK

Dataset with HAL links.

{
  "id" : "9b36cc35-7ad9-47e4-9d30-5f3c66040473",
  "published" : "2025-05-02T08:55:12.264008555",
  "alias" : "sit-generated-dataset",
  "workspaceId" : "a846f4c0-b968-4f29-9eaa-e06546c3f246",
  "source" : "@sit+prod",
  "title" : "SIT-Generated Dataset [2025-05-02T09:55:12.215298]",
  "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-05-02T08:55:11.998478",
  "score" : 1.0,
  "_links" : {
    "self" : {
      "href" : "https://app.matatika.com/api/datasets/9b36cc35-7ad9-47e4-9d30-5f3c66040473"
    },
    "delete dataset" : {
      "href" : "https://app.matatika.com/api/datasets/9b36cc35-7ad9-47e4-9d30-5f3c66040473",
      "type" : "DELETE"
    },
    "edit dataset" : {
      "href" : "https://app.matatika.com/api/datasets/9b36cc35-7ad9-47e4-9d30-5f3c66040473",
      "type" : "PATCH"
    },
    "data" : {
      "href" : "https://app.matatika.com/api/datasets/9b36cc35-7ad9-47e4-9d30-5f3c66040473/data",
      "type" : "GET"
    },
    "source" : {
      "href" : "https://app.matatika.com/api/channels/1b09d29d-9ca8-402f-988e-9c29ee91c405",
      "type" : "GET"
    },
    "new comment" : {
      "href" : "https://app.matatika.com/api/datasets/9b36cc35-7ad9-47e4-9d30-5f3c66040473/comments",
      "type" : "POST"
    },
    "add like" : {
      "href" : "https://app.matatika.com/api/datasets/9b36cc35-7ad9-47e4-9d30-5f3c66040473/like",
      "type" : "PUT"
    },
    "add view" : {
      "href" : "https://app.matatika.com/api/datasets/9b36cc35-7ad9-47e4-9d30-5f3c66040473/view",
      "type" : "PUT"
    },
    "new alert" : {
      "href" : "https://app.matatika.com/api/datasets/9b36cc35-7ad9-47e4-9d30-5f3c66040473/alerts"
    },
    "add subscription" : {
      "href" : "https://app.matatika.com/api/datasets/9b36cc35-7ad9-47e4-9d30-5f3c66040473/subscriptions"
    },
    "new message" : {
      "href" : "https://app.matatika.com/api/datasets/9b36cc35-7ad9-47e4-9d30-5f3c66040473/messages"
    }
  },
  "_embedded" : {
    "source" : {
      "name" : "@sit+prod",
      "description" : "sit+prod@matatika.com 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 -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.matatika.com/api/datasets/9b36cc35-7ad9-47e4-9d30-5f3c66040473/view' -i -X PUT \
    -H 'Content-Type: application/json'

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 -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.matatika.com/api/datasets/9b36cc35-7ad9-47e4-9d30-5f3c66040473/like' -i -X PUT \
    -H 'Content-Type: application/json'

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 -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.matatika.com/api/datasets/9b36cc35-7ad9-47e4-9d30-5f3c66040473/like' -i -X DELETE \
    -H 'Content-Type: application/json'

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 -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.matatika.com/api/datasets/9b36cc35-7ad9-47e4-9d30-5f3c66040473/messages' -i -X POST \
    -H 'Content-Type: application/json'

Response

200 OK

Dataset Message with HAL links.

{
  "id" : "9fb70cc1-fb81-4dc2-afb1-2b6ac624e0b1",
  "datasetId" : "9b36cc35-7ad9-47e4-9d30-5f3c66040473",
  "_links" : {
    "create message" : {
      "href" : "https://app.matatika.com/api/datasets/9b36cc35-7ad9-47e4-9d30-5f3c66040473/messages/9fb70cc1-fb81-4dc2-afb1-2b6ac624e0b1"
    }
  }
}

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-05-02T09:55:12.877779]"
}

Example Snippets

curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.matatika.com/api/datasets/9b36cc35-7ad9-47e4-9d30-5f3c66040473/messages/9fb70cc1-fb81-4dc2-afb1-2b6ac624e0b1' -i -X PUT \
    -H 'Content-Type: application/json' \
    -d '{
  "recipientId" : "auth0|5eb0327cbfd7490bff55feeb",
  "message" : "SIT-generated dataset message [2025-05-02T09:55:12.877779]"
}'

Response

200 OK / 201 Created

Dataset Message with HAL links.

{
  "id" : "9fb70cc1-fb81-4dc2-afb1-2b6ac624e0b1",
  "recipientId" : "auth0|5eb0327cbfd7490bff55feeb",
  "message" : "SIT-generated dataset message [2025-05-02T09:55:12.877779]",
  "datasetId" : "9b36cc35-7ad9-47e4-9d30-5f3c66040473",
  "_links" : {
    "notification" : {
      "href" : "https://app.matatika.com/api/notifications/9fb70cc1-fb81-4dc2-afb1-2b6ac624e0b1"
    }
  }
}

Delete a dataset

DELETE

/api/datasets/{dataset-id}

Deletes the dataset {dataset-id}.

Prerequisites

Dataset {dataset-id} must exist

Request

Example Snippets

curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.matatika.com/api/datasets/9b36cc35-7ad9-47e4-9d30-5f3c66040473' -i -X DELETE \
    -H 'Content-Type: application/json'

Response

204 No Content

No response body provided.

Datasets

Objects

Dataset

Dataset Message

Requests

See Also

View all datasets in a workspace

Prerequisites

Request

Example Snippets

Response

View all liked datasets in a workspace

Prerequisites

Request

Example Snippets

Response

View datasets by channel

Prerequisites

Request

Example Snippets

Response

View a dataset

Prerequisites

Request

Example Snippets

Response

View a dataset in a workspace

Prerequisites

Request

Example Snippets

Response

View the data of a dataset

Prerequisites

Request

Headers

Accept

Example Snippets

Response

Publish a dataset to a workspace

Prerequisites

Request

Example Snippets

Response

Edit a dataset

Prerequisites

Request

Body

Example Snippets

Response

Record a view of a dataset

Prerequisites

Request

Example Snippets

Response

Record a like of a dataset

Prerequisites

Request

Example Snippets

Response

Remove a like from a dataset

Prerequisites

Request

Example Snippets

Response

Initialise a new dataset message

Prerequisites

Requests

Example Snippets

Response

Create or update a dataset message

Prerequisites

Request

Body

Example Snippets

Response

Delete a dataset

Prerequisites

Request

Example Snippets

Response