Alerts

Alerts can be created by users on datasets. These alerts can then be used to inform users of information related to that dataset.

Requests

• Initialise an alert on a dataset
• Create an alert on a dataset
• View alerts on a dataset
• View an alert

Initialise an alert on a dataset

POST

datasets/{dataset-id}/alerts

Initialises a new alert on a dataset.

Prerequisites

• The authenticated user must own a Matatika account

Request

Example Snippets

• cURL

curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com:443/api/datasets/6c9ecbc7-d4f6-4b8d-a2a6-eba4f0fa4706/alerts' -i -X POST \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Content-Type: application/json'

• Python (requests)

import requests

url = "https://catalog.matatika.com:443/api/datasets/6c9ecbc7-d4f6-4b8d-a2a6-eba4f0fa4706/alerts"

headers = {
  'Authorization': ACCESS_TOKEN
}

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

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

Response

200 OK

{
  "id" : "306ad785-0f8d-418b-85b0-ce7c0946d9b5",
  "created" : "2023-03-23T21:48:12.53203339",
  "lastModified" : "2023-03-23T21:48:12.53203389",
  "_links" : {
    "create alert" : {
      "href" : "https://catalog.matatika.com/api/datasets/6c9ecbc7-d4f6-4b8d-a2a6-eba4f0fa4706/alerts/306ad785-0f8d-418b-85b0-ce7c0946d9b5"
    }
  }
}

Create an alert on a dataset

PUT

datasets/{dataset-id}/alerts/{alert-id}

Create a new alert on a dataset.

Prerequisites

• The authenticated user must own a Matatika account

Request

Example Snippets

• cURL

curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com:443/api/datasets/6c9ecbc7-d4f6-4b8d-a2a6-eba4f0fa4706/alerts/306ad785-0f8d-418b-85b0-ce7c0946d9b5' -i -X PUT \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Content-Type: application/json' \
    -d '{
  "detail" : "New dataset alert"
}'

• Python (requests)

import requests

url = "https://catalog.matatika.com:443/api/datasets/6c9ecbc7-d4f6-4b8d-a2a6-eba4f0fa4706/alerts/306ad785-0f8d-418b-85b0-ce7c0946d9b5"

data = {
  "detail" : "New dataset alert"
}
headers = {
  'Authorization': ACCESS_TOKEN
}

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

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

Response

201 Created

{
  "id" : "306ad785-0f8d-418b-85b0-ce7c0946d9b5",
  "created" : "2023-03-23T21:48:12.700151502",
  "lastModified" : "2023-03-23T21:48:12.700151802",
  "raised" : "2023-03-23T21:48:12.700151502",
  "detail" : "New dataset alert",
  "_links" : {
    "dataset" : {
      "href" : "https://catalog.matatika.com/api/datasets/6c9ecbc7-d4f6-4b8d-a2a6-eba4f0fa4706"
    }
  }
}

View alerts on a dataset

GET

datasets/{dataset-id}/alerts

View alerts on a dataset.

Prerequisites

• The authenticated user must own a Matatika account

Request

Example Snippets

• cURL

curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com:443/api/datasets/6c9ecbc7-d4f6-4b8d-a2a6-eba4f0fa4706/alerts' -i -X GET \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Content-Type: application/json'

• Python (requests)

import requests

url = "https://catalog.matatika.com:443/api/datasets/6c9ecbc7-d4f6-4b8d-a2a6-eba4f0fa4706/alerts"

headers = {
  'Authorization': ACCESS_TOKEN
}

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

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

Response

200 OK

{
  "_embedded" : {
    "alerts" : [ {
      "id" : "306ad785-0f8d-418b-85b0-ce7c0946d9b5",
      "created" : "2023-03-23T21:48:12.700152",
      "lastModified" : "2023-03-23T21:48:12.700152",
      "raised" : "2023-03-23T21:48:12.700152",
      "detail" : "New dataset alert",
      "_links" : {
        "dataset" : {
          "href" : "https://catalog.matatika.com/api/datasets/6c9ecbc7-d4f6-4b8d-a2a6-eba4f0fa4706"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://catalog.matatika.com/api/datasets/6c9ecbc7-d4f6-4b8d-a2a6-eba4f0fa4706/alerts?page=0&size=20"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

View an alert

GET

alerts/{alert-id}

View an alert.

Prerequisites

• The authenticated user must own a Matatika account

Request

Example Snippets

• cURL

curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com:443/api/alerts/306ad785-0f8d-418b-85b0-ce7c0946d9b5' -i -X GET \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Content-Type: application/json'

• Python (requests)

import requests

url = "https://catalog.matatika.com:443/api/alerts/306ad785-0f8d-418b-85b0-ce7c0946d9b5"

headers = {
  'Authorization': ACCESS_TOKEN
}

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

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

Response

200 OK

{
  "id" : "306ad785-0f8d-418b-85b0-ce7c0946d9b5",
  "created" : "2023-03-23T21:48:12.700152",
  "lastModified" : "2023-03-23T21:48:12.700152",
  "raised" : "2023-03-23T21:48:12.700152",
  "detail" : "New dataset alert",
  "_links" : {
    "dataset" : {
      "href" : "https://catalog.matatika.com/api/datasets/6c9ecbc7-d4f6-4b8d-a2a6-eba4f0fa4706"
    }
  }
}