Skip to main content
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"
}'
{
  "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": "******"
        },
        "deliveryPolicy": {
          "timeout": 5000,
          "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": {
          "types": [
            "RAIN",
            "SNOW"
          ],
          "intensity": 2
        }
      }
    }
  ],
  "totalRecords": 128,
  "pageNumber": 0,
  "pageSize": 10
}

Body

application/json
​
pageNumber
integer

Zero-based page number

Required range: x >= 0
Example:

0

​
pageSize
integer

Page size (1..100)

Required range: 1 <= x <= 100
Example:

10

​
filterByRecipientIds
string[]

Only registrations whose recipientId is in this list

{msg:swagger.schema.alarms.page-request.filter-by-recipient-ids}

Example:
["Receiver1", "Receiver2"]
​
filterByPolygonIntersection
number[][]

Only registrations whose boundary intersects with this polygon (GeoJSON ring order: [lon, lat])

{msg:swagger.schema.alarms.page-request.filter-by-polygon-intersection}

Example:
[
  [
    [32.85, 39.95],
    [32.86, 39.95],
    [32.86, 39.96],
    [32.85, 39.96],
    [32.85, 39.95]
  ]
]
​
accountId
string<uuid>

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

​
registrations
object[]

Result registrations for this page

​
totalRecords
integer

Total number of matching registrations

Example:

128

​
pageNumber
integer

Returned page number

Example:

0

​
pageSize
integer

Returned page size

Example:

10