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" : "1c0392f8-8021-4057-9b2c-62c0fe871a96",
  "created" : "2024-10-24T15:16:18.790058",
  "lastModified" : "2024-10-24T15:16:18.790058",
  "type" : "DATASET_COMMENT",
  "actor" : {
    "id" : "auth0|5eb0327cbfd7490bff55feeb",
    "name" : "[email protected]",
    "handle" : "@sit+prod"
  },
  "resolved" : false,
  "_embedded" : {
    "subscriberProfile" : {
      "id" : "auth0|5eb0327cbfd7490bff55feeb",
      "name" : "[email protected]",
      "handle" : "@sit+prod"
    },
    "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" : "36ac44d0-6e34-4c54-acb0-aca89067b9ec",
      "message" : "SIT-generated comment",
      "likeCount" : 0,
      "created" : "2024-10-24T15:16:15.489748",
      "lastModified" : "2024-10-24T15:16:15.489748",
      "from" : {
        "id" : "auth0|5eb0327cbfd7490bff55feeb",
        "name" : "[email protected]",
        "handle" : "@sit+prod"
      },
      "commentCount" : 0,
      "datasetId" : "621e830d-9363-4f95-8a53-6bc6db6acab3"
    },
    "dataset" : {
      "id" : "621e830d-9363-4f95-8a53-6bc6db6acab3",
      "published" : "2024-10-24T15:16:08.41699",
      "alias" : "analytics-tables",
      "workspaceId" : "c567050a-bce8-4108-93dc-9ea919f4269d",
      "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 = 'tsfqqzn'```",
      "likeCount" : 0,
      "commentCount" : 0,
      "viewCount" : 0,
      "created" : "2024-10-24T15:16:08.41699",
      "score" : 1.0
    },
    "workspace" : {
      "id" : "c567050a-bce8-4108-93dc-9ea919f4269d",
      "name" : "Test Workspace [2024-10-24T15:16:08.026496601]"
    }
  },
  "_links" : {
    "self" : {
      "href" : "https://app.matatika.com/api/notifications/1c0392f8-8021-4057-9b2c-62c0fe871a96"
    },
    "delete notification" : {
      "href" : "https://app.matatika.com/api/notifications/1c0392f8-8021-4057-9b2c-62c0fe871a96",
      "type" : "DELETE"
    },
    "channel" : {
      "href" : "https://app.matatika.com/api/channels/08328c31-63e7-43f7-9c4c-f1aa81fbce34"
    },
    "datasetComment" : {
      "href" : "https://app.matatika.com/api/comments/36ac44d0-6e34-4c54-acb0-aca89067b9ec"
    },
    "dataset" : {
      "href" : "https://app.matatika.com/api/datasets/621e830d-9363-4f95-8a53-6bc6db6acab3"
    },
    "data" : {
      "href" : "https://app.matatika.com/api/datasets/621e830d-9363-4f95-8a53-6bc6db6acab3/data"
    },
    "workspace" : {
      "href" : "https://app.matatika.com/api/workspaces/c567050a-bce8-4108-93dc-9ea919f4269d"
    }
  }
}

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
`JOB_STARTED`	A job started for a pipeline
`JOB_ENDED`	A job ended for a pipeline

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://app.matatika.com/api/notifications?before=2024-10-24T16%3A16%3A19.015433&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://app.matatika.com/api/notifications?before=2024-10-24T16%3A16%3A19.015433&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" : "1c0392f8-8021-4057-9b2c-62c0fe871a96",
      "created" : "2024-10-24T15:16:18.790058",
      "lastModified" : "2024-10-24T15:16:18.790058",
      "type" : "DATASET_COMMENT",
      "actor" : {
        "id" : "auth0|5eb0327cbfd7490bff55feeb",
        "name" : "[email protected]",
        "handle" : "@sit+prod"
      },
      "resolved" : false,
      "_embedded" : {
        "subscriberProfile" : {
          "id" : "auth0|5eb0327cbfd7490bff55feeb",
          "name" : "[email protected]",
          "handle" : "@sit+prod"
        },
        "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" : "36ac44d0-6e34-4c54-acb0-aca89067b9ec",
          "message" : "SIT-generated comment",
          "likeCount" : 0,
          "created" : "2024-10-24T15:16:15.489748",
          "lastModified" : "2024-10-24T15:16:15.489748",
          "from" : {
            "id" : "auth0|5eb0327cbfd7490bff55feeb",
            "name" : "[email protected]",
            "handle" : "@sit+prod"
          },
          "commentCount" : 0,
          "datasetId" : "621e830d-9363-4f95-8a53-6bc6db6acab3"
        },
        "dataset" : {
          "id" : "621e830d-9363-4f95-8a53-6bc6db6acab3",
          "published" : "2024-10-24T15:16:08.41699",
          "alias" : "analytics-tables",
          "workspaceId" : "c567050a-bce8-4108-93dc-9ea919f4269d",
          "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 = 'tsfqqzn'```",
          "likeCount" : 0,
          "commentCount" : 0,
          "viewCount" : 0,
          "created" : "2024-10-24T15:16:08.41699",
          "score" : 1.0
        },
        "workspace" : {
          "id" : "c567050a-bce8-4108-93dc-9ea919f4269d",
          "name" : "Test Workspace [2024-10-24T15:16:08.026496601]"
        }
      },
      "_links" : {
        "self" : {
          "href" : "https://app.matatika.com/api/notifications/1c0392f8-8021-4057-9b2c-62c0fe871a96"
        },
        "delete notification" : {
          "href" : "https://app.matatika.com/api/notifications/1c0392f8-8021-4057-9b2c-62c0fe871a96",
          "type" : "DELETE"
        },
        "channel" : {
          "href" : "https://app.matatika.com/api/channels/08328c31-63e7-43f7-9c4c-f1aa81fbce34"
        },
        "datasetComment" : {
          "href" : "https://app.matatika.com/api/comments/36ac44d0-6e34-4c54-acb0-aca89067b9ec"
        },
        "dataset" : {
          "href" : "https://app.matatika.com/api/datasets/621e830d-9363-4f95-8a53-6bc6db6acab3"
        },
        "data" : {
          "href" : "https://app.matatika.com/api/datasets/621e830d-9363-4f95-8a53-6bc6db6acab3/data"
        },
        "workspace" : {
          "href" : "https://app.matatika.com/api/workspaces/c567050a-bce8-4108-93dc-9ea919f4269d"
        }
      }
    }, {
      "id" : "e3fce322-17a9-4009-a57f-e982f3be6da2",
      "created" : "2024-10-24T15:16:18.73613",
      "lastModified" : "2024-10-24T15:16:18.736131",
      "type" : "DATASET_COMMENT",
      "actor" : {
        "id" : "auth0|5eb0327cbfd7490bff55feeb",
        "name" : "[email protected]",
        "handle" : "@sit+prod"
      },
      "resolved" : false,
      "_embedded" : {
        "subscriberProfile" : {
          "id" : "auth0|5eb0327cbfd7490bff55feeb",
          "name" : "[email protected]",
          "handle" : "@sit+prod"
        },
        "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" : "5fc127f8-a984-4c73-bd22-c76dd71c921f",
          "message" : "SIT-generated comment",
          "likeCount" : 0,
          "created" : "2024-10-24T15:16:15.188506",
          "lastModified" : "2024-10-24T15:16:15.188506",
          "from" : {
            "id" : "auth0|5eb0327cbfd7490bff55feeb",
            "name" : "[email protected]",
            "handle" : "@sit+prod"
          },
          "commentCount" : 0,
          "datasetId" : "621e830d-9363-4f95-8a53-6bc6db6acab3"
        },
        "dataset" : {
          "id" : "621e830d-9363-4f95-8a53-6bc6db6acab3",
          "published" : "2024-10-24T15:16:08.41699",
          "alias" : "analytics-tables",
          "workspaceId" : "c567050a-bce8-4108-93dc-9ea919f4269d",
          "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 = 'tsfqqzn'```",
          "likeCount" : 0,
          "commentCount" : 0,
          "viewCount" : 0,
          "created" : "2024-10-24T15:16:08.41699",
          "score" : 1.0
        },
        "workspace" : {
          "id" : "c567050a-bce8-4108-93dc-9ea919f4269d",
          "name" : "Test Workspace [2024-10-24T15:16:08.026496601]"
        }
      },
      "_links" : {
        "self" : {
          "href" : "https://app.matatika.com/api/notifications/e3fce322-17a9-4009-a57f-e982f3be6da2"
        },
        "delete notification" : {
          "href" : "https://app.matatika.com/api/notifications/e3fce322-17a9-4009-a57f-e982f3be6da2",
          "type" : "DELETE"
        },
        "channel" : {
          "href" : "https://app.matatika.com/api/channels/08328c31-63e7-43f7-9c4c-f1aa81fbce34"
        },
        "datasetComment" : {
          "href" : "https://app.matatika.com/api/comments/5fc127f8-a984-4c73-bd22-c76dd71c921f"
        },
        "dataset" : {
          "href" : "https://app.matatika.com/api/datasets/621e830d-9363-4f95-8a53-6bc6db6acab3"
        },
        "data" : {
          "href" : "https://app.matatika.com/api/datasets/621e830d-9363-4f95-8a53-6bc6db6acab3/data"
        },
        "workspace" : {
          "href" : "https://app.matatika.com/api/workspaces/c567050a-bce8-4108-93dc-9ea919f4269d"
        }
      }
    }, {
      "id" : "7d84dbf5-4d3d-47d2-9833-0dee06e0d587",
      "created" : "2024-10-24T15:16:18.657627",
      "lastModified" : "2024-10-24T15:16:18.657628",
      "type" : "DATASET_COMMENT",
      "actor" : {
        "id" : "auth0|5eb0327cbfd7490bff55feeb",
        "name" : "[email protected]",
        "handle" : "@sit+prod"
      },
      "resolved" : false,
      "_embedded" : {
        "subscriberProfile" : {
          "id" : "auth0|5eb0327cbfd7490bff55feeb",
          "name" : "[email protected]",
          "handle" : "@sit+prod"
        },
        "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" : "47d83562-679d-46a9-b8ca-e42bb34a0907",
          "message" : "SIT-generated comment",
          "likeCount" : 0,
          "created" : "2024-10-24T15:16:14.834579",
          "lastModified" : "2024-10-24T15:16:14.834579",
          "from" : {
            "id" : "auth0|5eb0327cbfd7490bff55feeb",
            "name" : "[email protected]",
            "handle" : "@sit+prod"
          },
          "commentCount" : 0,
          "datasetId" : "621e830d-9363-4f95-8a53-6bc6db6acab3"
        },
        "dataset" : {
          "id" : "621e830d-9363-4f95-8a53-6bc6db6acab3",
          "published" : "2024-10-24T15:16:08.41699",
          "alias" : "analytics-tables",
          "workspaceId" : "c567050a-bce8-4108-93dc-9ea919f4269d",
          "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 = 'tsfqqzn'```",
          "likeCount" : 0,
          "commentCount" : 0,
          "viewCount" : 0,
          "created" : "2024-10-24T15:16:08.41699",
          "score" : 1.0
        },
        "workspace" : {
          "id" : "c567050a-bce8-4108-93dc-9ea919f4269d",
          "name" : "Test Workspace [2024-10-24T15:16:08.026496601]"
        }
      },
      "_links" : {
        "self" : {
          "href" : "https://app.matatika.com/api/notifications/7d84dbf5-4d3d-47d2-9833-0dee06e0d587"
        },
        "delete notification" : {
          "href" : "https://app.matatika.com/api/notifications/7d84dbf5-4d3d-47d2-9833-0dee06e0d587",
          "type" : "DELETE"
        },
        "channel" : {
          "href" : "https://app.matatika.com/api/channels/08328c31-63e7-43f7-9c4c-f1aa81fbce34"
        },
        "datasetComment" : {
          "href" : "https://app.matatika.com/api/comments/47d83562-679d-46a9-b8ca-e42bb34a0907"
        },
        "dataset" : {
          "href" : "https://app.matatika.com/api/datasets/621e830d-9363-4f95-8a53-6bc6db6acab3"
        },
        "data" : {
          "href" : "https://app.matatika.com/api/datasets/621e830d-9363-4f95-8a53-6bc6db6acab3/data"
        },
        "workspace" : {
          "href" : "https://app.matatika.com/api/workspaces/c567050a-bce8-4108-93dc-9ea919f4269d"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://app.matatika.com/api/notifications?before=2024-10-24T16%3A16%3A19.015433&since=2021-01-01T00%3A00&page=0&size=20"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 3,
    "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://app.matatika.com/api/workspaces/c567050a-bce8-4108-93dc-9ea919f4269d/notifications?before=2024-10-24T16%3A16%3A19.271676&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://app.matatika.com/api/workspaces/c567050a-bce8-4108-93dc-9ea919f4269d/notifications?before=2024-10-24T16%3A16%3A19.271676&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" : "1c0392f8-8021-4057-9b2c-62c0fe871a96",
      "created" : "2024-10-24T15:16:18.790058",
      "lastModified" : "2024-10-24T15:16:18.790058",
      "type" : "DATASET_COMMENT",
      "actor" : {
        "id" : "auth0|5eb0327cbfd7490bff55feeb",
        "name" : "[email protected]",
        "handle" : "@sit+prod"
      },
      "resolved" : false,
      "_embedded" : {
        "subscriberProfile" : {
          "id" : "auth0|5eb0327cbfd7490bff55feeb",
          "name" : "[email protected]",
          "handle" : "@sit+prod"
        },
        "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" : "36ac44d0-6e34-4c54-acb0-aca89067b9ec",
          "message" : "SIT-generated comment",
          "likeCount" : 0,
          "created" : "2024-10-24T15:16:15.489748",
          "lastModified" : "2024-10-24T15:16:15.489748",
          "from" : {
            "id" : "auth0|5eb0327cbfd7490bff55feeb",
            "name" : "[email protected]",
            "handle" : "@sit+prod"
          },
          "commentCount" : 0,
          "datasetId" : "621e830d-9363-4f95-8a53-6bc6db6acab3"
        },
        "dataset" : {
          "id" : "621e830d-9363-4f95-8a53-6bc6db6acab3",
          "published" : "2024-10-24T15:16:08.41699",
          "alias" : "analytics-tables",
          "workspaceId" : "c567050a-bce8-4108-93dc-9ea919f4269d",
          "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 = 'tsfqqzn'```",
          "likeCount" : 0,
          "commentCount" : 0,
          "viewCount" : 0,
          "created" : "2024-10-24T15:16:08.41699",
          "score" : 1.0
        },
        "workspace" : {
          "id" : "c567050a-bce8-4108-93dc-9ea919f4269d",
          "name" : "Test Workspace [2024-10-24T15:16:08.026496601]"
        }
      },
      "_links" : {
        "self" : {
          "href" : "https://app.matatika.com/api/notifications/1c0392f8-8021-4057-9b2c-62c0fe871a96"
        },
        "delete notification" : {
          "href" : "https://app.matatika.com/api/notifications/1c0392f8-8021-4057-9b2c-62c0fe871a96",
          "type" : "DELETE"
        },
        "channel" : {
          "href" : "https://app.matatika.com/api/channels/08328c31-63e7-43f7-9c4c-f1aa81fbce34"
        },
        "datasetComment" : {
          "href" : "https://app.matatika.com/api/comments/36ac44d0-6e34-4c54-acb0-aca89067b9ec"
        },
        "dataset" : {
          "href" : "https://app.matatika.com/api/datasets/621e830d-9363-4f95-8a53-6bc6db6acab3"
        },
        "data" : {
          "href" : "https://app.matatika.com/api/datasets/621e830d-9363-4f95-8a53-6bc6db6acab3/data"
        },
        "workspace" : {
          "href" : "https://app.matatika.com/api/workspaces/c567050a-bce8-4108-93dc-9ea919f4269d"
        }
      }
    }, {
      "id" : "e3fce322-17a9-4009-a57f-e982f3be6da2",
      "created" : "2024-10-24T15:16:18.73613",
      "lastModified" : "2024-10-24T15:16:18.736131",
      "type" : "DATASET_COMMENT",
      "actor" : {
        "id" : "auth0|5eb0327cbfd7490bff55feeb",
        "name" : "[email protected]",
        "handle" : "@sit+prod"
      },
      "resolved" : false,
      "_embedded" : {
        "subscriberProfile" : {
          "id" : "auth0|5eb0327cbfd7490bff55feeb",
          "name" : "[email protected]",
          "handle" : "@sit+prod"
        },
        "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" : "5fc127f8-a984-4c73-bd22-c76dd71c921f",
          "message" : "SIT-generated comment",
          "likeCount" : 0,
          "created" : "2024-10-24T15:16:15.188506",
          "lastModified" : "2024-10-24T15:16:15.188506",
          "from" : {
            "id" : "auth0|5eb0327cbfd7490bff55feeb",
            "name" : "[email protected]",
            "handle" : "@sit+prod"
          },
          "commentCount" : 0,
          "datasetId" : "621e830d-9363-4f95-8a53-6bc6db6acab3"
        },
        "dataset" : {
          "id" : "621e830d-9363-4f95-8a53-6bc6db6acab3",
          "published" : "2024-10-24T15:16:08.41699",
          "alias" : "analytics-tables",
          "workspaceId" : "c567050a-bce8-4108-93dc-9ea919f4269d",
          "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 = 'tsfqqzn'```",
          "likeCount" : 0,
          "commentCount" : 0,
          "viewCount" : 0,
          "created" : "2024-10-24T15:16:08.41699",
          "score" : 1.0
        },
        "workspace" : {
          "id" : "c567050a-bce8-4108-93dc-9ea919f4269d",
          "name" : "Test Workspace [2024-10-24T15:16:08.026496601]"
        }
      },
      "_links" : {
        "self" : {
          "href" : "https://app.matatika.com/api/notifications/e3fce322-17a9-4009-a57f-e982f3be6da2"
        },
        "delete notification" : {
          "href" : "https://app.matatika.com/api/notifications/e3fce322-17a9-4009-a57f-e982f3be6da2",
          "type" : "DELETE"
        },
        "channel" : {
          "href" : "https://app.matatika.com/api/channels/08328c31-63e7-43f7-9c4c-f1aa81fbce34"
        },
        "datasetComment" : {
          "href" : "https://app.matatika.com/api/comments/5fc127f8-a984-4c73-bd22-c76dd71c921f"
        },
        "dataset" : {
          "href" : "https://app.matatika.com/api/datasets/621e830d-9363-4f95-8a53-6bc6db6acab3"
        },
        "data" : {
          "href" : "https://app.matatika.com/api/datasets/621e830d-9363-4f95-8a53-6bc6db6acab3/data"
        },
        "workspace" : {
          "href" : "https://app.matatika.com/api/workspaces/c567050a-bce8-4108-93dc-9ea919f4269d"
        }
      }
    }, {
      "id" : "7d84dbf5-4d3d-47d2-9833-0dee06e0d587",
      "created" : "2024-10-24T15:16:18.657627",
      "lastModified" : "2024-10-24T15:16:18.657628",
      "type" : "DATASET_COMMENT",
      "actor" : {
        "id" : "auth0|5eb0327cbfd7490bff55feeb",
        "name" : "[email protected]",
        "handle" : "@sit+prod"
      },
      "resolved" : false,
      "_embedded" : {
        "subscriberProfile" : {
          "id" : "auth0|5eb0327cbfd7490bff55feeb",
          "name" : "[email protected]",
          "handle" : "@sit+prod"
        },
        "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" : "47d83562-679d-46a9-b8ca-e42bb34a0907",
          "message" : "SIT-generated comment",
          "likeCount" : 0,
          "created" : "2024-10-24T15:16:14.834579",
          "lastModified" : "2024-10-24T15:16:14.834579",
          "from" : {
            "id" : "auth0|5eb0327cbfd7490bff55feeb",
            "name" : "[email protected]",
            "handle" : "@sit+prod"
          },
          "commentCount" : 0,
          "datasetId" : "621e830d-9363-4f95-8a53-6bc6db6acab3"
        },
        "dataset" : {
          "id" : "621e830d-9363-4f95-8a53-6bc6db6acab3",
          "published" : "2024-10-24T15:16:08.41699",
          "alias" : "analytics-tables",
          "workspaceId" : "c567050a-bce8-4108-93dc-9ea919f4269d",
          "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 = 'tsfqqzn'```",
          "likeCount" : 0,
          "commentCount" : 0,
          "viewCount" : 0,
          "created" : "2024-10-24T15:16:08.41699",
          "score" : 1.0
        },
        "workspace" : {
          "id" : "c567050a-bce8-4108-93dc-9ea919f4269d",
          "name" : "Test Workspace [2024-10-24T15:16:08.026496601]"
        }
      },
      "_links" : {
        "self" : {
          "href" : "https://app.matatika.com/api/notifications/7d84dbf5-4d3d-47d2-9833-0dee06e0d587"
        },
        "delete notification" : {
          "href" : "https://app.matatika.com/api/notifications/7d84dbf5-4d3d-47d2-9833-0dee06e0d587",
          "type" : "DELETE"
        },
        "channel" : {
          "href" : "https://app.matatika.com/api/channels/08328c31-63e7-43f7-9c4c-f1aa81fbce34"
        },
        "datasetComment" : {
          "href" : "https://app.matatika.com/api/comments/47d83562-679d-46a9-b8ca-e42bb34a0907"
        },
        "dataset" : {
          "href" : "https://app.matatika.com/api/datasets/621e830d-9363-4f95-8a53-6bc6db6acab3"
        },
        "data" : {
          "href" : "https://app.matatika.com/api/datasets/621e830d-9363-4f95-8a53-6bc6db6acab3/data"
        },
        "workspace" : {
          "href" : "https://app.matatika.com/api/workspaces/c567050a-bce8-4108-93dc-9ea919f4269d"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://app.matatika.com/api/workspaces/c567050a-bce8-4108-93dc-9ea919f4269d/notifications?before=2024-10-24T16%3A16%3A19.271676&since=2021-01-01T00%3A00&page=0&size=20"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 3,
    "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://app.matatika.com/api/notifications/1c0392f8-8021-4057-9b2c-62c0fe871a96' -i -X GET \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Content-Type: application/json'

Python (requests)

import requests

url = "https://app.matatika.com/api/notifications/1c0392f8-8021-4057-9b2c-62c0fe871a96"

headers = {
  'Authorization': ACCESS_TOKEN
}

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

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

Response

200 OK

Notification with HAL links.

{
  "id" : "1c0392f8-8021-4057-9b2c-62c0fe871a96",
  "created" : "2024-10-24T15:16:18.790058",
  "lastModified" : "2024-10-24T15:16:18.790058",
  "type" : "DATASET_COMMENT",
  "actor" : {
    "id" : "auth0|5eb0327cbfd7490bff55feeb",
    "name" : "[email protected]",
    "handle" : "@sit+prod"
  },
  "resolved" : false,
  "_embedded" : {
    "subscriberProfile" : {
      "id" : "auth0|5eb0327cbfd7490bff55feeb",
      "name" : "[email protected]",
      "handle" : "@sit+prod"
    },
    "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" : "36ac44d0-6e34-4c54-acb0-aca89067b9ec",
      "message" : "SIT-generated comment",
      "likeCount" : 0,
      "created" : "2024-10-24T15:16:15.489748",
      "lastModified" : "2024-10-24T15:16:15.489748",
      "from" : {
        "id" : "auth0|5eb0327cbfd7490bff55feeb",
        "name" : "[email protected]",
        "handle" : "@sit+prod"
      },
      "commentCount" : 0,
      "datasetId" : "621e830d-9363-4f95-8a53-6bc6db6acab3"
    },
    "dataset" : {
      "id" : "621e830d-9363-4f95-8a53-6bc6db6acab3",
      "published" : "2024-10-24T15:16:08.41699",
      "alias" : "analytics-tables",
      "workspaceId" : "c567050a-bce8-4108-93dc-9ea919f4269d",
      "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 = 'tsfqqzn'```",
      "likeCount" : 0,
      "commentCount" : 0,
      "viewCount" : 0,
      "created" : "2024-10-24T15:16:08.41699",
      "score" : 1.0
    },
    "workspace" : {
      "id" : "c567050a-bce8-4108-93dc-9ea919f4269d",
      "name" : "Test Workspace [2024-10-24T15:16:08.026496601]"
    }
  },
  "_links" : {
    "self" : {
      "href" : "https://app.matatika.com/api/notifications/1c0392f8-8021-4057-9b2c-62c0fe871a96"
    },
    "delete notification" : {
      "href" : "https://app.matatika.com/api/notifications/1c0392f8-8021-4057-9b2c-62c0fe871a96",
      "type" : "DELETE"
    },
    "channel" : {
      "href" : "https://app.matatika.com/api/channels/08328c31-63e7-43f7-9c4c-f1aa81fbce34"
    },
    "datasetComment" : {
      "href" : "https://app.matatika.com/api/comments/36ac44d0-6e34-4c54-acb0-aca89067b9ec"
    },
    "dataset" : {
      "href" : "https://app.matatika.com/api/datasets/621e830d-9363-4f95-8a53-6bc6db6acab3"
    },
    "data" : {
      "href" : "https://app.matatika.com/api/datasets/621e830d-9363-4f95-8a53-6bc6db6acab3/data"
    },
    "workspace" : {
      "href" : "https://app.matatika.com/api/workspaces/c567050a-bce8-4108-93dc-9ea919f4269d"
    }
  }
}

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://app.matatika.com/api/notifications?since=2024-10-24T15%3A16%3A23.713246' -i -X PUT \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Content-Type: application/json'

Python (requests)

import requests

url = "https://app.matatika.com/api/notifications?since=2024-10-24T15%3A16%3A23.713246"

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" : "cc3c0c18-867f-4a24-8287-e464fae1540c",
      "created" : "2024-10-24T15:16:28.672787",
      "lastModified" : "2024-10-24T15:16:28.672787",
      "type" : "DATASET_COMMENT",
      "actor" : {
        "id" : "auth0|5eb0327cbfd7490bff55feeb",
        "name" : "[email protected]",
        "handle" : "@sit+prod"
      },
      "resolved" : false,
      "_embedded" : {
        "subscriberProfile" : {
          "id" : "auth0|5eb0327cbfd7490bff55feeb",
          "name" : "[email protected]",
          "handle" : "@sit+prod"
        },
        "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" : "5165b08f-9bc6-4bdf-a507-57675ab16988",
          "message" : "SIT-generated comment",
          "likeCount" : 0,
          "created" : "2024-10-24T15:16:25.547725",
          "lastModified" : "2024-10-24T15:16:25.547725",
          "from" : {
            "id" : "auth0|5eb0327cbfd7490bff55feeb",
            "name" : "[email protected]",
            "handle" : "@sit+prod"
          },
          "commentCount" : 0,
          "datasetId" : "621e830d-9363-4f95-8a53-6bc6db6acab3"
        },
        "dataset" : {
          "id" : "621e830d-9363-4f95-8a53-6bc6db6acab3",
          "published" : "2024-10-24T15:16:08.41699",
          "alias" : "analytics-tables",
          "workspaceId" : "c567050a-bce8-4108-93dc-9ea919f4269d",
          "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 = 'tsfqqzn'```",
          "likeCount" : 0,
          "commentCount" : 0,
          "viewCount" : 0,
          "created" : "2024-10-24T15:16:08.41699",
          "score" : 1.0
        },
        "workspace" : {
          "id" : "c567050a-bce8-4108-93dc-9ea919f4269d",
          "name" : "Test Workspace [2024-10-24T15:16:08.026496601]"
        }
      },
      "_links" : {
        "self" : {
          "href" : "https://app.matatika.com/api/notifications/cc3c0c18-867f-4a24-8287-e464fae1540c"
        },
        "delete notification" : {
          "href" : "https://app.matatika.com/api/notifications/cc3c0c18-867f-4a24-8287-e464fae1540c",
          "type" : "DELETE"
        },
        "channel" : {
          "href" : "https://app.matatika.com/api/channels/08328c31-63e7-43f7-9c4c-f1aa81fbce34"
        },
        "datasetComment" : {
          "href" : "https://app.matatika.com/api/comments/5165b08f-9bc6-4bdf-a507-57675ab16988"
        },
        "dataset" : {
          "href" : "https://app.matatika.com/api/datasets/621e830d-9363-4f95-8a53-6bc6db6acab3"
        },
        "data" : {
          "href" : "https://app.matatika.com/api/datasets/621e830d-9363-4f95-8a53-6bc6db6acab3/data"
        },
        "workspace" : {
          "href" : "https://app.matatika.com/api/workspaces/c567050a-bce8-4108-93dc-9ea919f4269d"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://app.matatika.com/api/notifications?since=2024-10-24T15%3A16%3A23.713246&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://app.matatika.com/api/notifications/1c0392f8-8021-4057-9b2c-62c0fe871a96' -i -X DELETE \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Content-Type: application/json'

Python (requests)

import requests

url = "https://app.matatika.com/api/notifications/1c0392f8-8021-4057-9b2c-62c0fe871a96"

headers = {
  'Authorization': ACCESS_TOKEN
}

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

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

Response

204 No Content

No response body provided.

Notifications

Objects

Notification

Formats

Notification Type

Requests

See Also

View all notifications

Request

Query Parameters

Example Snippets

Response

View all notifications for a workspace

Prerequisites

Request

Query Parameters

Example Snippets

Response

View a notification

Prerequisites

Request

Example Snippets

Response

Refresh notifications

Request

Query Parameters

Example Snippets

Response

Delete a notification

Prerequisites

Request

Example Snippets

Response