Link Search Menu Expand Document

Notifications

Notifications are alerts triggered by certain events pertaining to a resource. To receive notifications for a specific resource, a user must have a subscription to the resource.


Objects

Notification

Path Type Format Description
id String Version 4 UUID The notification ID
created String ISO 8601 timestamp The instant the notification was created at
lastModified String ISO 8601 timestamp The instant the notification was last modified at
actor Member   The member whose action raised this notification
type String Notification Type The type of notification
resolved Boolean   Whether or not the notification has been read
{
  "id" : "e672f82b-2905-4595-b639-edd085abb230",
  "created" : "2022-06-30T15:37:51.210895",
  "lastModified" : "2022-06-30T15:37:51.210896",
  "type" : "DATASET_COMMENT",
  "actor" : {
    "id" : "auth0|5eb0327cbfd7490bff55feeb",
    "name" : "[email protected]",
    "handle" : "@support+integrationtests+a7o91bel"
  },
  "resolved" : false,
  "_embedded" : {
    "subscriberProfile" : {
      "id" : "auth0|5eb0327cbfd7490bff55feeb",
      "name" : "[email protected]",
      "handle" : "@support+integrationtests+a7o91bel"
    },
    "channel" : {
      "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"
    },
    "datasetComment" : {
      "id" : "2df8a030-4cc7-48eb-a710-f293361a006e",
      "message" : "SIT-generated comment",
      "likeCount" : 0,
      "created" : "2022-06-30T15:37:50.230192",
      "lastModified" : "2022-06-30T15:37:50.230193",
      "from" : {
        "id" : "auth0|5eb0327cbfd7490bff55feeb",
        "name" : "[email protected]",
        "handle" : "@support+integrationtests+a7o91bel"
      },
      "commentCount" : 0,
      "datasetId" : "da203606-eb43-4274-8799-4828c4516d57"
    },
    "dataset" : {
      "id" : "da203606-eb43-4274-8799-4828c4516d57",
      "published" : "2022-06-30T15:37:48.413637",
      "alias" : "analytics-tables",
      "workspaceId" : "55f514da-5192-45ae-b561-7877efe2c5bb",
      "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 = 'kabsnwy'```",
      "likeCount" : 0,
      "commentCount" : 0,
      "viewCount" : 0,
      "created" : "2022-06-30T15:37:48.413636",
      "score" : 1.0
    },
    "workspace" : {
      "id" : "55f514da-5192-45ae-b561-7877efe2c5bb",
      "name" : "Test Workspace [2022-06-30T15:37:45.579599]"
    }
  },
  "_links" : {
    "self" : {
      "href" : "https://catalog.matatika.com/api/notifications/e672f82b-2905-4595-b639-edd085abb230"
    },
    "delete notification" : {
      "href" : "https://catalog.matatika.com/api/notifications/e672f82b-2905-4595-b639-edd085abb230",
      "type" : "DELETE"
    },
    "channel" : {
      "href" : "https://catalog.matatika.com/api/channels/fac1329f-f6dc-4c4e-81dd-f4543e216700"
    },
    "datasetComment" : {
      "href" : "https://catalog.matatika.com/api/comments/2df8a030-4cc7-48eb-a710-f293361a006e"
    },
    "dataset" : {
      "href" : "https://catalog.matatika.com/api/datasets/da203606-eb43-4274-8799-4828c4516d57"
    },
    "data" : {
      "href" : "https://catalog.matatika.com/api/datasets/da203606-eb43-4274-8799-4828c4516d57/data"
    },
    "workspace" : {
      "href" : "https://catalog.matatika.com/api/workspaces/55f514da-5192-45ae-b561-7877efe2c5bb"
    }
  }
}

Formats

Notification Type

String

Value Description
DATASET_ACTIVITY Any activity on the dataset
DATASET_ANOMOLY A detected anomoly in the dataset data
DATASET_COMMENT A comment on the dataset
DATASET_LIKE A like recorded on the dataset
DATASET_MESSAGE A message about the dataset

Requests

See Also


View all notifications

GET

/api/notifications?all={all}&before={before}&since={since}

Returns all notifications for the authenticated user profile.

Request

Query Parameters

Parameter Required Format Default Value Description
all No Boolean false Whether or not to return both resolved and unresolved notifications
before No ISO 8601 timestamp The instant at which the request was made The instant to return any notifications created before
since No ISO 8601 timestamp 2021-02-11T11:12 The instant to return any notifications created since

Example Snippets

  • cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com/api/notifications?before=2022-06-30T16%3A37%3A51.397938&since=2021-01-01T00%3A00' -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/api/notifications?before=2022-06-30T16%3A37%3A51.397938&since=2021-01-01T00%3A00"

headers = {
  'Authorization': ACCESS_TOKEN
}

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

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

Response

200 OK

Notification collection with HAL links.

{
  "_embedded" : {
    "notifications" : [ {
      "id" : "e672f82b-2905-4595-b639-edd085abb230",
      "created" : "2022-06-30T15:37:51.210895",
      "lastModified" : "2022-06-30T15:37:51.210896",
      "type" : "DATASET_COMMENT",
      "actor" : {
        "id" : "auth0|5eb0327cbfd7490bff55feeb",
        "name" : "[email protected]",
        "handle" : "@support+integrationtests+a7o91bel"
      },
      "resolved" : false,
      "_embedded" : {
        "subscriberProfile" : {
          "id" : "auth0|5eb0327cbfd7490bff55feeb",
          "name" : "[email protected]",
          "handle" : "@support+integrationtests+a7o91bel"
        },
        "channel" : {
          "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"
        },
        "datasetComment" : {
          "id" : "2df8a030-4cc7-48eb-a710-f293361a006e",
          "message" : "SIT-generated comment",
          "likeCount" : 0,
          "created" : "2022-06-30T15:37:50.230192",
          "lastModified" : "2022-06-30T15:37:50.230193",
          "from" : {
            "id" : "auth0|5eb0327cbfd7490bff55feeb",
            "name" : "[email protected]",
            "handle" : "@support+integrationtests+a7o91bel"
          },
          "commentCount" : 0,
          "datasetId" : "da203606-eb43-4274-8799-4828c4516d57"
        },
        "dataset" : {
          "id" : "da203606-eb43-4274-8799-4828c4516d57",
          "published" : "2022-06-30T15:37:48.413637",
          "alias" : "analytics-tables",
          "workspaceId" : "55f514da-5192-45ae-b561-7877efe2c5bb",
          "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 = 'kabsnwy'```",
          "likeCount" : 0,
          "commentCount" : 0,
          "viewCount" : 0,
          "created" : "2022-06-30T15:37:48.413636",
          "score" : 1.0
        },
        "workspace" : {
          "id" : "55f514da-5192-45ae-b561-7877efe2c5bb",
          "name" : "Test Workspace [2022-06-30T15:37:45.579599]"
        }
      },
      "_links" : {
        "self" : {
          "href" : "https://catalog.matatika.com/api/notifications/e672f82b-2905-4595-b639-edd085abb230"
        },
        "delete notification" : {
          "href" : "https://catalog.matatika.com/api/notifications/e672f82b-2905-4595-b639-edd085abb230",
          "type" : "DELETE"
        },
        "channel" : {
          "href" : "https://catalog.matatika.com/api/channels/fac1329f-f6dc-4c4e-81dd-f4543e216700"
        },
        "datasetComment" : {
          "href" : "https://catalog.matatika.com/api/comments/2df8a030-4cc7-48eb-a710-f293361a006e"
        },
        "dataset" : {
          "href" : "https://catalog.matatika.com/api/datasets/da203606-eb43-4274-8799-4828c4516d57"
        },
        "data" : {
          "href" : "https://catalog.matatika.com/api/datasets/da203606-eb43-4274-8799-4828c4516d57/data"
        },
        "workspace" : {
          "href" : "https://catalog.matatika.com/api/workspaces/55f514da-5192-45ae-b561-7877efe2c5bb"
        }
      }
    }, {
      "id" : "2b73947c-1792-4198-9794-72550ab7ec8b",
      "created" : "2022-06-30T15:37:50.124111",
      "lastModified" : "2022-06-30T15:37:50.124112",
      "type" : "DATASET_COMMENT",
      "actor" : {
        "id" : "auth0|5eb0327cbfd7490bff55feeb",
        "name" : "[email protected]",
        "handle" : "@support+integrationtests+a7o91bel"
      },
      "resolved" : false,
      "_embedded" : {
        "subscriberProfile" : {
          "id" : "auth0|5eb0327cbfd7490bff55feeb",
          "name" : "[email protected]",
          "handle" : "@support+integrationtests+a7o91bel"
        },
        "channel" : {
          "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"
        },
        "datasetComment" : {
          "id" : "38ec4e92-730b-4f30-8304-e9793b279a29",
          "message" : "SIT-generated comment",
          "likeCount" : 0,
          "created" : "2022-06-30T15:37:49.896899",
          "lastModified" : "2022-06-30T15:37:49.8969",
          "from" : {
            "id" : "auth0|5eb0327cbfd7490bff55feeb",
            "name" : "[email protected]",
            "handle" : "@support+integrationtests+a7o91bel"
          },
          "commentCount" : 0,
          "datasetId" : "da203606-eb43-4274-8799-4828c4516d57"
        },
        "dataset" : {
          "id" : "da203606-eb43-4274-8799-4828c4516d57",
          "published" : "2022-06-30T15:37:48.413637",
          "alias" : "analytics-tables",
          "workspaceId" : "55f514da-5192-45ae-b561-7877efe2c5bb",
          "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 = 'kabsnwy'```",
          "likeCount" : 0,
          "commentCount" : 0,
          "viewCount" : 0,
          "created" : "2022-06-30T15:37:48.413636",
          "score" : 1.0
        },
        "workspace" : {
          "id" : "55f514da-5192-45ae-b561-7877efe2c5bb",
          "name" : "Test Workspace [2022-06-30T15:37:45.579599]"
        }
      },
      "_links" : {
        "self" : {
          "href" : "https://catalog.matatika.com/api/notifications/2b73947c-1792-4198-9794-72550ab7ec8b"
        },
        "delete notification" : {
          "href" : "https://catalog.matatika.com/api/notifications/2b73947c-1792-4198-9794-72550ab7ec8b",
          "type" : "DELETE"
        },
        "channel" : {
          "href" : "https://catalog.matatika.com/api/channels/fac1329f-f6dc-4c4e-81dd-f4543e216700"
        },
        "datasetComment" : {
          "href" : "https://catalog.matatika.com/api/comments/38ec4e92-730b-4f30-8304-e9793b279a29"
        },
        "dataset" : {
          "href" : "https://catalog.matatika.com/api/datasets/da203606-eb43-4274-8799-4828c4516d57"
        },
        "data" : {
          "href" : "https://catalog.matatika.com/api/datasets/da203606-eb43-4274-8799-4828c4516d57/data"
        },
        "workspace" : {
          "href" : "https://catalog.matatika.com/api/workspaces/55f514da-5192-45ae-b561-7877efe2c5bb"
        }
      }
    }, {
      "id" : "1e8739e6-353e-4f5e-8c7c-798ac5a06abd",
      "created" : "2022-06-30T15:37:50.026088",
      "lastModified" : "2022-06-30T15:37:50.026089",
      "type" : "DATASET_COMMENT",
      "actor" : {
        "id" : "auth0|5eb0327cbfd7490bff55feeb",
        "name" : "[email protected]",
        "handle" : "@support+integrationtests+a7o91bel"
      },
      "resolved" : false,
      "_embedded" : {
        "subscriberProfile" : {
          "id" : "auth0|5eb0327cbfd7490bff55feeb",
          "name" : "[email protected]",
          "handle" : "@support+integrationtests+a7o91bel"
        },
        "channel" : {
          "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"
        },
        "datasetComment" : {
          "id" : "65633568-38a3-4c40-bedf-d5fee3f27d23",
          "message" : "SIT-generated comment",
          "likeCount" : 0,
          "created" : "2022-06-30T15:37:49.521518",
          "lastModified" : "2022-06-30T15:37:49.521519",
          "from" : {
            "id" : "auth0|5eb0327cbfd7490bff55feeb",
            "name" : "[email protected]",
            "handle" : "@support+integrationtests+a7o91bel"
          },
          "commentCount" : 0,
          "datasetId" : "da203606-eb43-4274-8799-4828c4516d57"
        },
        "dataset" : {
          "id" : "da203606-eb43-4274-8799-4828c4516d57",
          "published" : "2022-06-30T15:37:48.413637",
          "alias" : "analytics-tables",
          "workspaceId" : "55f514da-5192-45ae-b561-7877efe2c5bb",
          "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 = 'kabsnwy'```",
          "likeCount" : 0,
          "commentCount" : 0,
          "viewCount" : 0,
          "created" : "2022-06-30T15:37:48.413636",
          "score" : 1.0
        },
        "workspace" : {
          "id" : "55f514da-5192-45ae-b561-7877efe2c5bb",
          "name" : "Test Workspace [2022-06-30T15:37:45.579599]"
        }
      },
      "_links" : {
        "self" : {
          "href" : "https://catalog.matatika.com/api/notifications/1e8739e6-353e-4f5e-8c7c-798ac5a06abd"
        },
        "delete notification" : {
          "href" : "https://catalog.matatika.com/api/notifications/1e8739e6-353e-4f5e-8c7c-798ac5a06abd",
          "type" : "DELETE"
        },
        "channel" : {
          "href" : "https://catalog.matatika.com/api/channels/fac1329f-f6dc-4c4e-81dd-f4543e216700"
        },
        "datasetComment" : {
          "href" : "https://catalog.matatika.com/api/comments/65633568-38a3-4c40-bedf-d5fee3f27d23"
        },
        "dataset" : {
          "href" : "https://catalog.matatika.com/api/datasets/da203606-eb43-4274-8799-4828c4516d57"
        },
        "data" : {
          "href" : "https://catalog.matatika.com/api/datasets/da203606-eb43-4274-8799-4828c4516d57/data"
        },
        "workspace" : {
          "href" : "https://catalog.matatika.com/api/workspaces/55f514da-5192-45ae-b561-7877efe2c5bb"
        }
      }
    }, {
      "id" : "288f918d-110e-4da2-9a0e-59f5ca711032",
      "created" : "2022-06-30T15:37:49.73079",
      "lastModified" : "2022-06-30T15:37:49.730791",
      "type" : "DATASET_ACTIVITY",
      "actor" : {
        "id" : "auth0|5eb0327cbfd7490bff55feeb",
        "name" : "[email protected]",
        "handle" : "@support+integrationtests+a7o91bel"
      },
      "resolved" : false,
      "_embedded" : {
        "subscriberProfile" : {
          "id" : "auth0|5eb0327cbfd7490bff55feeb",
          "name" : "[email protected]",
          "handle" : "@support+integrationtests+a7o91bel"
        },
        "channel" : {
          "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"
        },
        "dataset" : {
          "id" : "da203606-eb43-4274-8799-4828c4516d57",
          "published" : "2022-06-30T15:37:48.413637",
          "alias" : "analytics-tables",
          "workspaceId" : "55f514da-5192-45ae-b561-7877efe2c5bb",
          "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 = 'kabsnwy'```",
          "likeCount" : 0,
          "commentCount" : 0,
          "viewCount" : 0,
          "created" : "2022-06-30T15:37:48.413636",
          "score" : 1.0
        },
        "workspace" : {
          "id" : "55f514da-5192-45ae-b561-7877efe2c5bb",
          "name" : "Test Workspace [2022-06-30T15:37:45.579599]"
        }
      },
      "_links" : {
        "self" : {
          "href" : "https://catalog.matatika.com/api/notifications/288f918d-110e-4da2-9a0e-59f5ca711032"
        },
        "delete notification" : {
          "href" : "https://catalog.matatika.com/api/notifications/288f918d-110e-4da2-9a0e-59f5ca711032",
          "type" : "DELETE"
        },
        "channel" : {
          "href" : "https://catalog.matatika.com/api/channels/fac1329f-f6dc-4c4e-81dd-f4543e216700"
        },
        "dataset" : {
          "href" : "https://catalog.matatika.com/api/datasets/da203606-eb43-4274-8799-4828c4516d57"
        },
        "data" : {
          "href" : "https://catalog.matatika.com/api/datasets/da203606-eb43-4274-8799-4828c4516d57/data"
        },
        "workspace" : {
          "href" : "https://catalog.matatika.com/api/workspaces/55f514da-5192-45ae-b561-7877efe2c5bb"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://catalog.matatika.com/api/notifications?before=2022-06-30T16%3A37%3A51.397938&since=2021-01-01T00%3A00&page=0&size=20"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 4,
    "totalPages" : 1,
    "number" : 0
  }
}

View all notifications for a workspace

GET

/api/workspaces/{workspaceId}/notifications?all={all}&before={before}&since={since}

Returns all notifications for the workspace {workspace-id}.

Prerequisites

  • Workspace {workspace-id} must exist

Request

Query Parameters

Parameter Required Format Default Value Description
all No Boolean   Whether or not to return both resolved and unresolved notifications
before No ISO 8601 timestamp The instant at which the request was made The instant to return any notifications created before
since No ISO 8601 timestamp 2021-02-11T11:12 The instant to return any notifications created since

Example Snippets

  • cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com/api/workspaces/55f514da-5192-45ae-b561-7877efe2c5bb/notifications?before=2022-06-30T16%3A37%3A51.700417&since=2021-01-01T00%3A00' -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/api/workspaces/55f514da-5192-45ae-b561-7877efe2c5bb/notifications?before=2022-06-30T16%3A37%3A51.700417&since=2021-01-01T00%3A00"

headers = {
  'Authorization': ACCESS_TOKEN
}

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

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

Response

200 OK

Notification collection with HAL links.

{
  "_embedded" : {
    "notifications" : [ {
      "id" : "e672f82b-2905-4595-b639-edd085abb230",
      "created" : "2022-06-30T15:37:51.210895",
      "lastModified" : "2022-06-30T15:37:51.210896",
      "type" : "DATASET_COMMENT",
      "actor" : {
        "id" : "auth0|5eb0327cbfd7490bff55feeb",
        "name" : "[email protected]",
        "handle" : "@support+integrationtests+a7o91bel"
      },
      "resolved" : false,
      "_embedded" : {
        "subscriberProfile" : {
          "id" : "auth0|5eb0327cbfd7490bff55feeb",
          "name" : "[email protected]",
          "handle" : "@support+integrationtests+a7o91bel"
        },
        "channel" : {
          "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"
        },
        "datasetComment" : {
          "id" : "2df8a030-4cc7-48eb-a710-f293361a006e",
          "message" : "SIT-generated comment",
          "likeCount" : 0,
          "created" : "2022-06-30T15:37:50.230192",
          "lastModified" : "2022-06-30T15:37:50.230193",
          "from" : {
            "id" : "auth0|5eb0327cbfd7490bff55feeb",
            "name" : "[email protected]",
            "handle" : "@support+integrationtests+a7o91bel"
          },
          "commentCount" : 0,
          "datasetId" : "da203606-eb43-4274-8799-4828c4516d57"
        },
        "dataset" : {
          "id" : "da203606-eb43-4274-8799-4828c4516d57",
          "published" : "2022-06-30T15:37:48.413637",
          "alias" : "analytics-tables",
          "workspaceId" : "55f514da-5192-45ae-b561-7877efe2c5bb",
          "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 = 'kabsnwy'```",
          "likeCount" : 0,
          "commentCount" : 0,
          "viewCount" : 0,
          "created" : "2022-06-30T15:37:48.413636",
          "score" : 1.0
        },
        "workspace" : {
          "id" : "55f514da-5192-45ae-b561-7877efe2c5bb",
          "name" : "Test Workspace [2022-06-30T15:37:45.579599]"
        }
      },
      "_links" : {
        "self" : {
          "href" : "https://catalog.matatika.com/api/notifications/e672f82b-2905-4595-b639-edd085abb230"
        },
        "delete notification" : {
          "href" : "https://catalog.matatika.com/api/notifications/e672f82b-2905-4595-b639-edd085abb230",
          "type" : "DELETE"
        },
        "channel" : {
          "href" : "https://catalog.matatika.com/api/channels/fac1329f-f6dc-4c4e-81dd-f4543e216700"
        },
        "datasetComment" : {
          "href" : "https://catalog.matatika.com/api/comments/2df8a030-4cc7-48eb-a710-f293361a006e"
        },
        "dataset" : {
          "href" : "https://catalog.matatika.com/api/datasets/da203606-eb43-4274-8799-4828c4516d57"
        },
        "data" : {
          "href" : "https://catalog.matatika.com/api/datasets/da203606-eb43-4274-8799-4828c4516d57/data"
        },
        "workspace" : {
          "href" : "https://catalog.matatika.com/api/workspaces/55f514da-5192-45ae-b561-7877efe2c5bb"
        }
      }
    }, {
      "id" : "2b73947c-1792-4198-9794-72550ab7ec8b",
      "created" : "2022-06-30T15:37:50.124111",
      "lastModified" : "2022-06-30T15:37:50.124112",
      "type" : "DATASET_COMMENT",
      "actor" : {
        "id" : "auth0|5eb0327cbfd7490bff55feeb",
        "name" : "[email protected]",
        "handle" : "@support+integrationtests+a7o91bel"
      },
      "resolved" : false,
      "_embedded" : {
        "subscriberProfile" : {
          "id" : "auth0|5eb0327cbfd7490bff55feeb",
          "name" : "[email protected]",
          "handle" : "@support+integrationtests+a7o91bel"
        },
        "channel" : {
          "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"
        },
        "datasetComment" : {
          "id" : "38ec4e92-730b-4f30-8304-e9793b279a29",
          "message" : "SIT-generated comment",
          "likeCount" : 0,
          "created" : "2022-06-30T15:37:49.896899",
          "lastModified" : "2022-06-30T15:37:49.8969",
          "from" : {
            "id" : "auth0|5eb0327cbfd7490bff55feeb",
            "name" : "[email protected]",
            "handle" : "@support+integrationtests+a7o91bel"
          },
          "commentCount" : 0,
          "datasetId" : "da203606-eb43-4274-8799-4828c4516d57"
        },
        "dataset" : {
          "id" : "da203606-eb43-4274-8799-4828c4516d57",
          "published" : "2022-06-30T15:37:48.413637",
          "alias" : "analytics-tables",
          "workspaceId" : "55f514da-5192-45ae-b561-7877efe2c5bb",
          "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 = 'kabsnwy'```",
          "likeCount" : 0,
          "commentCount" : 0,
          "viewCount" : 0,
          "created" : "2022-06-30T15:37:48.413636",
          "score" : 1.0
        },
        "workspace" : {
          "id" : "55f514da-5192-45ae-b561-7877efe2c5bb",
          "name" : "Test Workspace [2022-06-30T15:37:45.579599]"
        }
      },
      "_links" : {
        "self" : {
          "href" : "https://catalog.matatika.com/api/notifications/2b73947c-1792-4198-9794-72550ab7ec8b"
        },
        "delete notification" : {
          "href" : "https://catalog.matatika.com/api/notifications/2b73947c-1792-4198-9794-72550ab7ec8b",
          "type" : "DELETE"
        },
        "channel" : {
          "href" : "https://catalog.matatika.com/api/channels/fac1329f-f6dc-4c4e-81dd-f4543e216700"
        },
        "datasetComment" : {
          "href" : "https://catalog.matatika.com/api/comments/38ec4e92-730b-4f30-8304-e9793b279a29"
        },
        "dataset" : {
          "href" : "https://catalog.matatika.com/api/datasets/da203606-eb43-4274-8799-4828c4516d57"
        },
        "data" : {
          "href" : "https://catalog.matatika.com/api/datasets/da203606-eb43-4274-8799-4828c4516d57/data"
        },
        "workspace" : {
          "href" : "https://catalog.matatika.com/api/workspaces/55f514da-5192-45ae-b561-7877efe2c5bb"
        }
      }
    }, {
      "id" : "1e8739e6-353e-4f5e-8c7c-798ac5a06abd",
      "created" : "2022-06-30T15:37:50.026088",
      "lastModified" : "2022-06-30T15:37:50.026089",
      "type" : "DATASET_COMMENT",
      "actor" : {
        "id" : "auth0|5eb0327cbfd7490bff55feeb",
        "name" : "[email protected]",
        "handle" : "@support+integrationtests+a7o91bel"
      },
      "resolved" : false,
      "_embedded" : {
        "subscriberProfile" : {
          "id" : "auth0|5eb0327cbfd7490bff55feeb",
          "name" : "[email protected]",
          "handle" : "@support+integrationtests+a7o91bel"
        },
        "channel" : {
          "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"
        },
        "datasetComment" : {
          "id" : "65633568-38a3-4c40-bedf-d5fee3f27d23",
          "message" : "SIT-generated comment",
          "likeCount" : 0,
          "created" : "2022-06-30T15:37:49.521518",
          "lastModified" : "2022-06-30T15:37:49.521519",
          "from" : {
            "id" : "auth0|5eb0327cbfd7490bff55feeb",
            "name" : "[email protected]",
            "handle" : "@support+integrationtests+a7o91bel"
          },
          "commentCount" : 0,
          "datasetId" : "da203606-eb43-4274-8799-4828c4516d57"
        },
        "dataset" : {
          "id" : "da203606-eb43-4274-8799-4828c4516d57",
          "published" : "2022-06-30T15:37:48.413637",
          "alias" : "analytics-tables",
          "workspaceId" : "55f514da-5192-45ae-b561-7877efe2c5bb",
          "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 = 'kabsnwy'```",
          "likeCount" : 0,
          "commentCount" : 0,
          "viewCount" : 0,
          "created" : "2022-06-30T15:37:48.413636",
          "score" : 1.0
        },
        "workspace" : {
          "id" : "55f514da-5192-45ae-b561-7877efe2c5bb",
          "name" : "Test Workspace [2022-06-30T15:37:45.579599]"
        }
      },
      "_links" : {
        "self" : {
          "href" : "https://catalog.matatika.com/api/notifications/1e8739e6-353e-4f5e-8c7c-798ac5a06abd"
        },
        "delete notification" : {
          "href" : "https://catalog.matatika.com/api/notifications/1e8739e6-353e-4f5e-8c7c-798ac5a06abd",
          "type" : "DELETE"
        },
        "channel" : {
          "href" : "https://catalog.matatika.com/api/channels/fac1329f-f6dc-4c4e-81dd-f4543e216700"
        },
        "datasetComment" : {
          "href" : "https://catalog.matatika.com/api/comments/65633568-38a3-4c40-bedf-d5fee3f27d23"
        },
        "dataset" : {
          "href" : "https://catalog.matatika.com/api/datasets/da203606-eb43-4274-8799-4828c4516d57"
        },
        "data" : {
          "href" : "https://catalog.matatika.com/api/datasets/da203606-eb43-4274-8799-4828c4516d57/data"
        },
        "workspace" : {
          "href" : "https://catalog.matatika.com/api/workspaces/55f514da-5192-45ae-b561-7877efe2c5bb"
        }
      }
    }, {
      "id" : "288f918d-110e-4da2-9a0e-59f5ca711032",
      "created" : "2022-06-30T15:37:49.73079",
      "lastModified" : "2022-06-30T15:37:49.730791",
      "type" : "DATASET_ACTIVITY",
      "actor" : {
        "id" : "auth0|5eb0327cbfd7490bff55feeb",
        "name" : "[email protected]",
        "handle" : "@support+integrationtests+a7o91bel"
      },
      "resolved" : false,
      "_embedded" : {
        "subscriberProfile" : {
          "id" : "auth0|5eb0327cbfd7490bff55feeb",
          "name" : "[email protected]",
          "handle" : "@support+integrationtests+a7o91bel"
        },
        "channel" : {
          "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"
        },
        "dataset" : {
          "id" : "da203606-eb43-4274-8799-4828c4516d57",
          "published" : "2022-06-30T15:37:48.413637",
          "alias" : "analytics-tables",
          "workspaceId" : "55f514da-5192-45ae-b561-7877efe2c5bb",
          "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 = 'kabsnwy'```",
          "likeCount" : 0,
          "commentCount" : 0,
          "viewCount" : 0,
          "created" : "2022-06-30T15:37:48.413636",
          "score" : 1.0
        },
        "workspace" : {
          "id" : "55f514da-5192-45ae-b561-7877efe2c5bb",
          "name" : "Test Workspace [2022-06-30T15:37:45.579599]"
        }
      },
      "_links" : {
        "self" : {
          "href" : "https://catalog.matatika.com/api/notifications/288f918d-110e-4da2-9a0e-59f5ca711032"
        },
        "delete notification" : {
          "href" : "https://catalog.matatika.com/api/notifications/288f918d-110e-4da2-9a0e-59f5ca711032",
          "type" : "DELETE"
        },
        "channel" : {
          "href" : "https://catalog.matatika.com/api/channels/fac1329f-f6dc-4c4e-81dd-f4543e216700"
        },
        "dataset" : {
          "href" : "https://catalog.matatika.com/api/datasets/da203606-eb43-4274-8799-4828c4516d57"
        },
        "data" : {
          "href" : "https://catalog.matatika.com/api/datasets/da203606-eb43-4274-8799-4828c4516d57/data"
        },
        "workspace" : {
          "href" : "https://catalog.matatika.com/api/workspaces/55f514da-5192-45ae-b561-7877efe2c5bb"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://catalog.matatika.com/api/workspaces/55f514da-5192-45ae-b561-7877efe2c5bb/notifications?before=2022-06-30T16%3A37%3A51.700417&since=2021-01-01T00%3A00&page=0&size=20"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 4,
    "totalPages" : 1,
    "number" : 0
  }
}

View a notification

GET

/api/notifications/{notification-id}

Returns the notification {notification-id}.

Prerequisites

  • Notification {notification-id} must exist

Request

Example Snippets

  • cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com/api/notifications/e672f82b-2905-4595-b639-edd085abb230' -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/api/notifications/e672f82b-2905-4595-b639-edd085abb230"

headers = {
  'Authorization': ACCESS_TOKEN
}

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

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

Response

200 OK

Notification with HAL links.

{
  "id" : "e672f82b-2905-4595-b639-edd085abb230",
  "created" : "2022-06-30T15:37:51.210895",
  "lastModified" : "2022-06-30T15:37:51.210896",
  "type" : "DATASET_COMMENT",
  "actor" : {
    "id" : "auth0|5eb0327cbfd7490bff55feeb",
    "name" : "[email protected]",
    "handle" : "@support+integrationtests+a7o91bel"
  },
  "resolved" : false,
  "_embedded" : {
    "subscriberProfile" : {
      "id" : "auth0|5eb0327cbfd7490bff55feeb",
      "name" : "[email protected]",
      "handle" : "@support+integrationtests+a7o91bel"
    },
    "channel" : {
      "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"
    },
    "datasetComment" : {
      "id" : "2df8a030-4cc7-48eb-a710-f293361a006e",
      "message" : "SIT-generated comment",
      "likeCount" : 0,
      "created" : "2022-06-30T15:37:50.230192",
      "lastModified" : "2022-06-30T15:37:50.230193",
      "from" : {
        "id" : "auth0|5eb0327cbfd7490bff55feeb",
        "name" : "[email protected]",
        "handle" : "@support+integrationtests+a7o91bel"
      },
      "commentCount" : 0,
      "datasetId" : "da203606-eb43-4274-8799-4828c4516d57"
    },
    "dataset" : {
      "id" : "da203606-eb43-4274-8799-4828c4516d57",
      "published" : "2022-06-30T15:37:48.413637",
      "alias" : "analytics-tables",
      "workspaceId" : "55f514da-5192-45ae-b561-7877efe2c5bb",
      "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 = 'kabsnwy'```",
      "likeCount" : 0,
      "commentCount" : 0,
      "viewCount" : 0,
      "created" : "2022-06-30T15:37:48.413636",
      "score" : 1.0
    },
    "workspace" : {
      "id" : "55f514da-5192-45ae-b561-7877efe2c5bb",
      "name" : "Test Workspace [2022-06-30T15:37:45.579599]"
    }
  },
  "_links" : {
    "self" : {
      "href" : "https://catalog.matatika.com/api/notifications/e672f82b-2905-4595-b639-edd085abb230"
    },
    "delete notification" : {
      "href" : "https://catalog.matatika.com/api/notifications/e672f82b-2905-4595-b639-edd085abb230",
      "type" : "DELETE"
    },
    "channel" : {
      "href" : "https://catalog.matatika.com/api/channels/fac1329f-f6dc-4c4e-81dd-f4543e216700"
    },
    "datasetComment" : {
      "href" : "https://catalog.matatika.com/api/comments/2df8a030-4cc7-48eb-a710-f293361a006e"
    },
    "dataset" : {
      "href" : "https://catalog.matatika.com/api/datasets/da203606-eb43-4274-8799-4828c4516d57"
    },
    "data" : {
      "href" : "https://catalog.matatika.com/api/datasets/da203606-eb43-4274-8799-4828c4516d57/data"
    },
    "workspace" : {
      "href" : "https://catalog.matatika.com/api/workspaces/55f514da-5192-45ae-b561-7877efe2c5bb"
    }
  }
}

Refresh notifications

PUT

/api/notifications?since={since}&markAsResolved={markAsResolved}

Returns new notifications for the authenticated user profile, optionally marking existing notifications as resolved up to the moment the request was made or the supplied since parameter.

Request

Query Parameters

Parameter Required Format Default Value Description
since No ISO 8601 timestamp The instant at which the request was made The instant to fetch any new notifications from
markAsResolved No Boolean true Whether or not to mark notifications created up to since as resolved

Example Snippets

  • cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com/api/notifications?since=2022-06-30T15%3A37%3A54.489274' -i -X PUT \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Content-Type: application/json'
  • Python (requests)
import requests

url = "https://catalog.matatika.com/api/notifications?since=2022-06-30T15%3A37%3A54.489274"

headers = {
  'Authorization': ACCESS_TOKEN
}

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

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

Response

200 OK

Notification collection with HAL links.

{
  "_embedded" : {
    "notifications" : [ {
      "id" : "a2874ad7-7e54-4e82-85a8-dbc7035c84d1",
      "created" : "2022-06-30T15:37:59.492858",
      "lastModified" : "2022-06-30T15:37:59.492859",
      "type" : "DATASET_COMMENT",
      "actor" : {
        "id" : "auth0|5eb0327cbfd7490bff55feeb",
        "name" : "[email protected]",
        "handle" : "@support+integrationtests+a7o91bel"
      },
      "resolved" : false,
      "_embedded" : {
        "subscriberProfile" : {
          "id" : "auth0|5eb0327cbfd7490bff55feeb",
          "name" : "[email protected]",
          "handle" : "@support+integrationtests+a7o91bel"
        },
        "channel" : {
          "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"
        },
        "datasetComment" : {
          "id" : "9fd8acd3-1227-40a0-926f-7b2bad9cea37",
          "message" : "SIT-generated comment",
          "likeCount" : 0,
          "created" : "2022-06-30T15:37:55.630603",
          "lastModified" : "2022-06-30T15:37:55.630604",
          "from" : {
            "id" : "auth0|5eb0327cbfd7490bff55feeb",
            "name" : "[email protected]",
            "handle" : "@support+integrationtests+a7o91bel"
          },
          "commentCount" : 0,
          "datasetId" : "da203606-eb43-4274-8799-4828c4516d57"
        },
        "dataset" : {
          "id" : "da203606-eb43-4274-8799-4828c4516d57",
          "published" : "2022-06-30T15:37:48.413637",
          "alias" : "analytics-tables",
          "workspaceId" : "55f514da-5192-45ae-b561-7877efe2c5bb",
          "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 = 'kabsnwy'```",
          "likeCount" : 0,
          "commentCount" : 0,
          "viewCount" : 0,
          "created" : "2022-06-30T15:37:48.413636",
          "score" : 1.0
        },
        "workspace" : {
          "id" : "55f514da-5192-45ae-b561-7877efe2c5bb",
          "name" : "Test Workspace [2022-06-30T15:37:45.579599]"
        }
      },
      "_links" : {
        "self" : {
          "href" : "https://catalog.matatika.com/api/notifications/a2874ad7-7e54-4e82-85a8-dbc7035c84d1"
        },
        "delete notification" : {
          "href" : "https://catalog.matatika.com/api/notifications/a2874ad7-7e54-4e82-85a8-dbc7035c84d1",
          "type" : "DELETE"
        },
        "channel" : {
          "href" : "https://catalog.matatika.com/api/channels/fac1329f-f6dc-4c4e-81dd-f4543e216700"
        },
        "datasetComment" : {
          "href" : "https://catalog.matatika.com/api/comments/9fd8acd3-1227-40a0-926f-7b2bad9cea37"
        },
        "dataset" : {
          "href" : "https://catalog.matatika.com/api/datasets/da203606-eb43-4274-8799-4828c4516d57"
        },
        "data" : {
          "href" : "https://catalog.matatika.com/api/datasets/da203606-eb43-4274-8799-4828c4516d57/data"
        },
        "workspace" : {
          "href" : "https://catalog.matatika.com/api/workspaces/55f514da-5192-45ae-b561-7877efe2c5bb"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://catalog.matatika.com/api/notifications?since=2022-06-30T15%3A37%3A54.489274&page=0&size=20"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

Delete a notification

DELETE

/api/notifications/{notification-id}

Deletes the notification {notification-id}.

Prerequisites

  • Notification {notification-id} must exist

Request

Example Snippets

  • cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com/api/notifications/e672f82b-2905-4595-b639-edd085abb230' -i -X DELETE \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Content-Type: application/json'
  • Python (requests)
import requests

url = "https://catalog.matatika.com/api/notifications/e672f82b-2905-4595-b639-edd085abb230"

headers = {
  'Authorization': ACCESS_TOKEN
}

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

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

Response

204 No Content

No response body provided.