List point alarm registrations (paged)
curl --request POST \
--url https://api.iklim.co/v1/alarms/points/page \
--header 'Content-Type: application/json' \
--data '
{
"pageNumber": 0,
"pageSize": 10,
"filterByRecipientIds": [
"Receiver1",
"Receiver2"
],
"filterByPolygonIntersection": [
[
[
32.85,
39.95
],
[
32.86,
39.95
],
[
32.86,
39.96
],
[
32.85,
39.96
],
[
32.85,
39.95
]
]
],
"accountId": "2f04f1b5-1c0a-4c4e-b0a7-0ba6e9b7f2e1"
}
'import requests
url = "https://api.iklim.co/v1/alarms/points/page"
payload = {
"pageNumber": 0,
"pageSize": 10,
"filterByRecipientIds": ["Receiver1", "Receiver2"],
"filterByPolygonIntersection": [[[32.85, 39.95], [32.86, 39.95], [32.86, 39.96], [32.85, 39.96], [32.85, 39.95]]],
"accountId": "2f04f1b5-1c0a-4c4e-b0a7-0ba6e9b7f2e1"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
pageNumber: 0,
pageSize: 10,
filterByRecipientIds: ['Receiver1', 'Receiver2'],
filterByPolygonIntersection: [
[[32.85, 39.95], [32.86, 39.95], [32.86, 39.96], [32.85, 39.96], [32.85, 39.95]]
],
accountId: '2f04f1b5-1c0a-4c4e-b0a7-0ba6e9b7f2e1'
})
};
fetch('https://api.iklim.co/v1/alarms/points/page', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.iklim.co/v1/alarms/points/page",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'pageNumber' => 0,
'pageSize' => 10,
'filterByRecipientIds' => [
'Receiver1',
'Receiver2'
],
'filterByPolygonIntersection' => [
[
[
32.85,
39.95
],
[
32.86,
39.95
],
[
32.86,
39.96
],
[
32.85,
39.96
],
[
32.85,
39.95
]
]
],
'accountId' => '2f04f1b5-1c0a-4c4e-b0a7-0ba6e9b7f2e1'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.iklim.co/v1/alarms/points/page"
payload := strings.NewReader("{\n \"pageNumber\": 0,\n \"pageSize\": 10,\n \"filterByRecipientIds\": [\n \"Receiver1\",\n \"Receiver2\"\n ],\n \"filterByPolygonIntersection\": [\n [\n [\n 32.85,\n 39.95\n ],\n [\n 32.86,\n 39.95\n ],\n [\n 32.86,\n 39.96\n ],\n [\n 32.85,\n 39.96\n ],\n [\n 32.85,\n 39.95\n ]\n ]\n ],\n \"accountId\": \"2f04f1b5-1c0a-4c4e-b0a7-0ba6e9b7f2e1\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.iklim.co/v1/alarms/points/page")
.header("Content-Type", "application/json")
.body("{\n \"pageNumber\": 0,\n \"pageSize\": 10,\n \"filterByRecipientIds\": [\n \"Receiver1\",\n \"Receiver2\"\n ],\n \"filterByPolygonIntersection\": [\n [\n [\n 32.85,\n 39.95\n ],\n [\n 32.86,\n 39.95\n ],\n [\n 32.86,\n 39.96\n ],\n [\n 32.85,\n 39.96\n ],\n [\n 32.85,\n 39.95\n ]\n ]\n ],\n \"accountId\": \"2f04f1b5-1c0a-4c4e-b0a7-0ba6e9b7f2e1\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.iklim.co/v1/alarms/points/page")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"pageNumber\": 0,\n \"pageSize\": 10,\n \"filterByRecipientIds\": [\n \"Receiver1\",\n \"Receiver2\"\n ],\n \"filterByPolygonIntersection\": [\n [\n [\n 32.85,\n 39.95\n ],\n [\n 32.86,\n 39.95\n ],\n [\n 32.86,\n 39.96\n ],\n [\n 32.85,\n 39.96\n ],\n [\n 32.85,\n 39.95\n ]\n ]\n ],\n \"accountId\": \"2f04f1b5-1c0a-4c4e-b0a7-0ba6e9b7f2e1\"\n}"
response = http.request(request)
puts response.read_body{
"registrations": [
{
"registrationId": "f7587d9e-2481-4b4c-818d-c8d1946851b7",
"recipientId": "Recipient1",
"boundary": {
"point": {
"lat": 39.9208,
"lng": 32.8541
},
"radius": 10000
},
"webhook": {
"accountId": "2f04f1b5-1c0a-4c4e-b0a7-0ba6e9b7f2e1",
"url": "https://api.customer.com/alerts/callback",
"httpMethod": "POST",
"contentType": "application/json",
"authentication": {
"username": "alert-user",
"password": "******"
},
"requestHeaders": {
"source": "iklim.co",
"custom-header": "value"
},
"deliveryPolicy": {
"timeout": 60,
"maxRetries": 3,
"retryDelay": 10
}
},
"filter": {
"lightning": {
"type": "FLASH_CLOUD_TO_GROUND",
"peakCurrent": -12.5,
"inCloudHeight": 4500
},
"thunderstorm": {
"intersectsAffectedPolygon": true,
"intersectsCellPolygon": false,
"severityThreshold": "MEDIUM",
"speedThreshold": 20
},
"precipitation": {
"intensities": [
"LIGHT",
"MODERATE"
]
}
}
}
],
"totalRecords": 128,
"pageNumber": 0,
"pageSize": 10
}List point alarm registrations (paged)
Returns a paged list of point alarm registrations filtered by recipient IDs and/or polygon intersection.
POST
/
v1
/
alarms
/
points
/
page
List point alarm registrations (paged)
curl --request POST \
--url https://api.iklim.co/v1/alarms/points/page \
--header 'Content-Type: application/json' \
--data '
{
"pageNumber": 0,
"pageSize": 10,
"filterByRecipientIds": [
"Receiver1",
"Receiver2"
],
"filterByPolygonIntersection": [
[
[
32.85,
39.95
],
[
32.86,
39.95
],
[
32.86,
39.96
],
[
32.85,
39.96
],
[
32.85,
39.95
]
]
],
"accountId": "2f04f1b5-1c0a-4c4e-b0a7-0ba6e9b7f2e1"
}
'import requests
url = "https://api.iklim.co/v1/alarms/points/page"
payload = {
"pageNumber": 0,
"pageSize": 10,
"filterByRecipientIds": ["Receiver1", "Receiver2"],
"filterByPolygonIntersection": [[[32.85, 39.95], [32.86, 39.95], [32.86, 39.96], [32.85, 39.96], [32.85, 39.95]]],
"accountId": "2f04f1b5-1c0a-4c4e-b0a7-0ba6e9b7f2e1"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
pageNumber: 0,
pageSize: 10,
filterByRecipientIds: ['Receiver1', 'Receiver2'],
filterByPolygonIntersection: [
[[32.85, 39.95], [32.86, 39.95], [32.86, 39.96], [32.85, 39.96], [32.85, 39.95]]
],
accountId: '2f04f1b5-1c0a-4c4e-b0a7-0ba6e9b7f2e1'
})
};
fetch('https://api.iklim.co/v1/alarms/points/page', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.iklim.co/v1/alarms/points/page",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'pageNumber' => 0,
'pageSize' => 10,
'filterByRecipientIds' => [
'Receiver1',
'Receiver2'
],
'filterByPolygonIntersection' => [
[
[
32.85,
39.95
],
[
32.86,
39.95
],
[
32.86,
39.96
],
[
32.85,
39.96
],
[
32.85,
39.95
]
]
],
'accountId' => '2f04f1b5-1c0a-4c4e-b0a7-0ba6e9b7f2e1'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.iklim.co/v1/alarms/points/page"
payload := strings.NewReader("{\n \"pageNumber\": 0,\n \"pageSize\": 10,\n \"filterByRecipientIds\": [\n \"Receiver1\",\n \"Receiver2\"\n ],\n \"filterByPolygonIntersection\": [\n [\n [\n 32.85,\n 39.95\n ],\n [\n 32.86,\n 39.95\n ],\n [\n 32.86,\n 39.96\n ],\n [\n 32.85,\n 39.96\n ],\n [\n 32.85,\n 39.95\n ]\n ]\n ],\n \"accountId\": \"2f04f1b5-1c0a-4c4e-b0a7-0ba6e9b7f2e1\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.iklim.co/v1/alarms/points/page")
.header("Content-Type", "application/json")
.body("{\n \"pageNumber\": 0,\n \"pageSize\": 10,\n \"filterByRecipientIds\": [\n \"Receiver1\",\n \"Receiver2\"\n ],\n \"filterByPolygonIntersection\": [\n [\n [\n 32.85,\n 39.95\n ],\n [\n 32.86,\n 39.95\n ],\n [\n 32.86,\n 39.96\n ],\n [\n 32.85,\n 39.96\n ],\n [\n 32.85,\n 39.95\n ]\n ]\n ],\n \"accountId\": \"2f04f1b5-1c0a-4c4e-b0a7-0ba6e9b7f2e1\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.iklim.co/v1/alarms/points/page")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"pageNumber\": 0,\n \"pageSize\": 10,\n \"filterByRecipientIds\": [\n \"Receiver1\",\n \"Receiver2\"\n ],\n \"filterByPolygonIntersection\": [\n [\n [\n 32.85,\n 39.95\n ],\n [\n 32.86,\n 39.95\n ],\n [\n 32.86,\n 39.96\n ],\n [\n 32.85,\n 39.96\n ],\n [\n 32.85,\n 39.95\n ]\n ]\n ],\n \"accountId\": \"2f04f1b5-1c0a-4c4e-b0a7-0ba6e9b7f2e1\"\n}"
response = http.request(request)
puts response.read_body{
"registrations": [
{
"registrationId": "f7587d9e-2481-4b4c-818d-c8d1946851b7",
"recipientId": "Recipient1",
"boundary": {
"point": {
"lat": 39.9208,
"lng": 32.8541
},
"radius": 10000
},
"webhook": {
"accountId": "2f04f1b5-1c0a-4c4e-b0a7-0ba6e9b7f2e1",
"url": "https://api.customer.com/alerts/callback",
"httpMethod": "POST",
"contentType": "application/json",
"authentication": {
"username": "alert-user",
"password": "******"
},
"requestHeaders": {
"source": "iklim.co",
"custom-header": "value"
},
"deliveryPolicy": {
"timeout": 60,
"maxRetries": 3,
"retryDelay": 10
}
},
"filter": {
"lightning": {
"type": "FLASH_CLOUD_TO_GROUND",
"peakCurrent": -12.5,
"inCloudHeight": 4500
},
"thunderstorm": {
"intersectsAffectedPolygon": true,
"intersectsCellPolygon": false,
"severityThreshold": "MEDIUM",
"speedThreshold": 20
},
"precipitation": {
"intensities": [
"LIGHT",
"MODERATE"
]
}
}
}
],
"totalRecords": 128,
"pageNumber": 0,
"pageSize": 10
}Body
application/json
Zero-based page number
Required range:
x >= 0Example:
0
Page size (1..100)
Required range:
1 <= x <= 100Example:
10
Only registrations whose recipientId is in this list
Example:
["Receiver1", "Receiver2"]
Only registrations whose boundary intersects with this polygon (GeoJSON ring order: [lon, lat])
Example:
[
[
[32.85, 39.95],
[32.86, 39.95],
[32.86, 39.96],
[32.85, 39.96],
[32.85, 39.95]
]
]
Account UUID to query on behalf of (admin/operator only). If omitted, uses caller's account.
Example:
"2f04f1b5-1c0a-4c4e-b0a7-0ba6e9b7f2e1"
Response
Paged registrations returned successfully
⌘I