API Reference
Log In
API Reference

List AI Alerts

get
https://api.revenium.ai/profitstream/v2/api/sources/ai/alert

Retrieve a paginated list of AI alerts. Each alert is one time an alert rule fired.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

ID of the team that owns this data.

string
enum

Filters alerts by metric type.

string

Start date for filtering alerts by trigger time. Format: ISO 8601 date string (YYYY-MM-DD). When provided with end date, returns only alerts triggered within the date range. When omitted, no start date filtering is applied.

string

End date for filtering alerts by trigger time. Format: ISO 8601 date string (YYYY-MM-DD). When provided with start date, returns only alerts triggered within the date range. When omitted, no end date filtering is applied.

string

Filters alerts by the ID of the alert rule that fired them. When provided, returns only alerts from one alert rule. Format: URL-safe encoded string.

string

Filters alerts by the ID of the user who created or is responsible for the alert rule. When provided, returns only alerts from alert rules owned by the specified user. Format: URL-safe encoded string.

boolean

Filters alerts by their resolution status. When true, returns only resolved alerts. When false, returns only unresolved (active) alerts. When omitted, returns all alerts regardless of resolution status.

integer
≥ 0
Defaults to 0

Zero-based page index (0..N)

integer
≥ 1
Defaults to 10

The size of the page to be returned

sort
array of strings

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

sort
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 6 months ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/hal+json
*/*

Updated 6 months ago

Did this page help you?