Alert

Endpointhttps://api.ultralayer.ai

Create Alert

POST

https://api.ultralayer.ai

/v0/alert/create_alert

Create an alert that periodically polls an endpoint and delivers new results to your configured receivers (webhook, email, and/or telegram).

Create Alert › Request Body

path

string · enum · required

Endpoint the alert polls.

Enum values:

/v0/search/list_wire

/v0/search/semantic_search

/v0/search/search_developments

/v0/search/retrieve_event_developments

/v0/search/search_events

/v0/filings/list_guidance

/v0/filings/list_changes

/v0/filings/list_guidance_outcomes

Example: /v0/search/list_wire

object · required

Endpoint arguments, dont provide system timestamps.

Example: {"entities":["Apple Inc."],"max_entity_sentiment":-0.3,"min_entity_sentiment":0.3,"novelty":["new","update","correction"]}

interval_minutes

integer · min: 5 · required

Poll interval; multiple of 5.

Example: 15

array · minItems: 1 · maxItems: 2 · required

1-2 unique targets.

Unique label; auto-generated if omitted

Example: apple_wire_sentiment

Defaults to interval_minutes

threshold

integer · min: 1

Items required to fire.

Default: 1

Create Alert › Responses

Successful Response

alert_id

integer · required

Unique identifier for the alert.

name

string · required

Human label for the alert.

status

string · enum · required

Current status of the alert.

Enum values:

active

paused

path

string · enum · required

The endpoint the alert polls.

Enum values:

/v0/search/list_wire

/v0/search/semantic_search

/v0/search/search_developments

/v0/search/retrieve_event_developments

/v0/search/search_events

/v0/filings/list_guidance

/v0/filings/list_changes

/v0/filings/list_guidance_outcomes

object · required

The endpoint arguments.

interval_minutes

integer · required

How often the alert checks the endpoint, in minutes.

lookback_minutes

integer · required

Rolling lookback window, in minutes.

threshold

integer · required

Minimum item count before the alert fires.

array · required

The configured delivery targets.

required

end_timestamp of the last successful delivery, or null.

object[] · required

Recent execution attempts (no payload).

object[] · required

Recent deliveries (includes payload).

created_at

string · date-time · required

When the alert was created.

POST/v0/alert/create_alert

curl --request POST \
  --url https://api.ultralayer.ai/v0/alert/create_alert \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "apple_wire_sentiment",
  "path": "/v0/search/list_wire",
  "arguments": {
    "entities": [
      "Apple Inc."
    ],
    "max_entity_sentiment": -0.3,
    "min_entity_sentiment": 0.3,
    "novelty": [
      "new",
      "update",
      "correction"
    ]
  },
  "interval_minutes": 15,
  "lookback_minutes": 5,
  "threshold": 1,
  "receivers": [
    {
      "type": "webhook",
      "url": "url",
      "headers": {
        "key": "string"
      },
      "body_wrap_key": "string",
      "body_wrap_as_string": false,
      "body_extra": {
        "key": "string"
      }
    }
  ]
}
'

shell

Example Request Body

{
  "name": "apple_wire_sentiment",
  "path": "/v0/search/list_wire",
  "arguments": {
    "entities": [
      "Apple Inc."
    ],
    "max_entity_sentiment": -0.3,
    "min_entity_sentiment": 0.3,
    "novelty": [
      "new",
      "update",
      "correction"
    ]
  },
  "interval_minutes": 15,
  "lookback_minutes": 5,
  "threshold": 1,
  "receivers": [
    {
      "type": "webhook",
      "url": "url",
      "headers": {
        "key": "string"
      },
      "body_wrap_key": "string",
      "body_wrap_as_string": false,
      "body_extra": {
        "key": "string"
      }
    }
  ]
}

json

Example Responses

{
  "alert_id": 0,
  "name": "name",
  "status": "active",
  "path": "/v0/search/list_wire",
  "arguments": {},
  "interval_minutes": 0,
  "lookback_minutes": 0,
  "threshold": 0,
  "receivers": [
    {
      "type": "webhook",
      "url": "url",
      "headers": {
        "key": "string"
      },
      "body_wrap_key": "string",
      "body_wrap_as_string": false,
      "body_extra": {
        "key": "string"
      }
    }
  ],
  "last_triggered_end_timestamp": "2024-08-25T15:00:00Z",
  "attempts": [
    {
      "end_timestamp": "2024-08-25T15:00:00Z",
      "execution_finished_at": "2024-08-25T15:00:00Z",
      "outcome": "no_data",
      "item_count": 0
    }
  ],
  "deliveries": [
    {
      "end_timestamp": "2024-08-25T15:00:00Z",
      "delivered_at": "2024-08-25T15:00:00Z",
      "payload": {},
      "receiver_results": [
        {
          "type": "webhook",
          "target": "target",
          "status": "success",
          "delivered_at": "2024-08-25T15:00:00Z",
          "error": "string"
        }
      ]
    }
  ],
  "created_at": "2024-08-25T15:00:00Z"
}

json

application/json

Get Alerts

GET

https://api.ultralayer.ai

/v0/alert/get_alerts

Retrieve all alerts for the authenticated user, including recent attempt and delivery history.

Get Alerts › Responses

200

Successful Response

object[]

alert_id

integer · required

Unique identifier for the alert.

name

string · required

Human label for the alert.

status

string · enum · required

Current status of the alert.

Enum values:

active

paused

path

string · enum · required

The endpoint the alert polls.

Enum values:

/v0/search/list_wire

/v0/search/semantic_search

/v0/search/search_developments

/v0/search/retrieve_event_developments

/v0/search/search_events

/v0/filings/list_guidance

/v0/filings/list_changes

/v0/filings/list_guidance_outcomes

object · required

The endpoint arguments.

interval_minutes

integer · required

How often the alert checks the endpoint, in minutes.

lookback_minutes

integer · required

Rolling lookback window, in minutes.

threshold

integer · required

Minimum item count before the alert fires.

array · required

The configured delivery targets.

required

end_timestamp of the last successful delivery, or null.

object[] · required

Recent execution attempts (no payload).

object[] · required

Recent deliveries (includes payload).

created_at

string · date-time · required

When the alert was created.

GET/v0/alert/get_alerts

curl --request GET \
  --url https://api.ultralayer.ai/v0/alert/get_alerts

shell

Example Responses

[
  {
    "alert_id": 0,
    "name": "name",
    "status": "active",
    "path": "/v0/search/list_wire",
    "arguments": {},
    "interval_minutes": 0,
    "lookback_minutes": 0,
    "threshold": 0,
    "receivers": [
      {
        "type": "webhook",
        "url": "url",
        "headers": {
          "key": "string"
        },
        "body_wrap_key": "string",
        "body_wrap_as_string": false,
        "body_extra": {
          "key": "string"
        }
      }
    ],
    "last_triggered_end_timestamp": "2024-08-25T15:00:00Z",
    "attempts": [
      {
        "end_timestamp": "2024-08-25T15:00:00Z",
        "execution_finished_at": "2024-08-25T15:00:00Z",
        "outcome": "no_data",
        "item_count": 0
      }
    ],
    "deliveries": [
      {
        "end_timestamp": "2024-08-25T15:00:00Z",
        "delivered_at": "2024-08-25T15:00:00Z",
        "payload": {},
        "receiver_results": [
          {
            "type": "webhook",
            "target": "target",
            "status": "success",
            "delivered_at": "2024-08-25T15:00:00Z",
            "error": "string"
          }
        ]
      }
    ],
    "created_at": "2024-08-25T15:00:00Z"
  }
]

json

application/json

Deactivate Alert

POST

https://api.ultralayer.ai

/v0/alert/deactivate_alert

Deactivate an alert by setting its status to 'paused'.

Deactivate Alert › Request Body

alert_id

integer · required

Deactivate Alert › Responses

Successful Response

string

Activate Alert

POST

https://api.ultralayer.ai

/v0/alert/activate_alert

Activate an alert by setting its status to 'active'.

Activate Alert › Request Body

alert_id

integer · required

Activate Alert › Responses

Successful Response

string

Delete Alert

POST

https://api.ultralayer.ai

/v0/alert/delete_alert

Permanently delete an alert from the database.

Delete Alert › Request Body

alert_id

integer · required

Delete Alert › Responses

Successful Response

string

Execute Alert

POST

https://api.ultralayer.ai

/v0/alert/execute_alert

Execute an alert immediately to test it. Runs the exact same path as scheduled execution, including history and dedup.

Execute Alert › Request Body

alert_id

integer · required

Execute Alert › Responses

Successful Response

string

Search Signal

Create Alert

POST

https://api.ultralayer.ai

/v0/alert/create_alert

Create an alert that periodically polls an endpoint and delivers new results to your configured receivers (webhook, email, and/or telegram).

Create Alert › Request Body

path

string · enum · required

Endpoint the alert polls.

Enum values:

/v0/search/list_wire

/v0/search/semantic_search

/v0/search/search_developments

/v0/search/retrieve_event_developments

/v0/search/search_events

/v0/filings/list_guidance

/v0/filings/list_changes

/v0/filings/list_guidance_outcomes

Example: /v0/search/list_wire

object · required

Endpoint arguments, dont provide system timestamps.

Example: {"entities":["Apple Inc."],"max_entity_sentiment":-0.3,"min_entity_sentiment":0.3,"novelty":["new","update","correction"]}

interval_minutes

integer · min: 5 · required

Poll interval; multiple of 5.

Example: 15

array · minItems: 1 · maxItems: 2 · required

1-2 unique targets.

Unique label; auto-generated if omitted

Example: apple_wire_sentiment

Defaults to interval_minutes

threshold

integer · min: 1

Items required to fire.

Default: 1

Create Alert › Responses

Successful Response

alert_id

integer · required

Unique identifier for the alert.

name

string · required

Human label for the alert.

status

string · enum · required

Current status of the alert.

Enum values:

active

paused

path

string · enum · required

The endpoint the alert polls.

Enum values:

/v0/search/list_wire

/v0/search/semantic_search

/v0/search/search_developments

/v0/search/retrieve_event_developments

/v0/search/search_events

/v0/filings/list_guidance

/v0/filings/list_changes

/v0/filings/list_guidance_outcomes

object · required

The endpoint arguments.

interval_minutes

integer · required

How often the alert checks the endpoint, in minutes.

lookback_minutes

integer · required

Rolling lookback window, in minutes.

threshold

integer · required

Minimum item count before the alert fires.

array · required

The configured delivery targets.

required

end_timestamp of the last successful delivery, or null.

object[] · required

Recent execution attempts (no payload).

object[] · required

Recent deliveries (includes payload).

created_at

string · date-time · required

When the alert was created.

Get Alerts

GET

https://api.ultralayer.ai

/v0/alert/get_alerts

Retrieve all alerts for the authenticated user, including recent attempt and delivery history.

Get Alerts › Responses

200

Successful Response

object[]

alert_id

integer · required

Unique identifier for the alert.

name

string · required

Human label for the alert.

status

string · enum · required

Current status of the alert.

Enum values:

active

paused

path

string · enum · required

The endpoint the alert polls.

Enum values:

/v0/search/list_wire

/v0/search/semantic_search

/v0/search/search_developments

/v0/search/retrieve_event_developments

/v0/search/search_events

/v0/filings/list_guidance

/v0/filings/list_changes

/v0/filings/list_guidance_outcomes

object · required

The endpoint arguments.

interval_minutes

integer · required

How often the alert checks the endpoint, in minutes.

lookback_minutes

integer · required

Rolling lookback window, in minutes.

threshold

integer · required

Minimum item count before the alert fires.

array · required

The configured delivery targets.

required

end_timestamp of the last successful delivery, or null.

object[] · required

Recent execution attempts (no payload).

object[] · required

Recent deliveries (includes payload).

created_at

string · date-time · required

When the alert was created.