List alert logs by filter with optional expand for customer, wallet, and feature
curl --request POST \
--url https://api.cloud.flexprice.io/v1/alert/search \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"alert_status": "ok",
"alert_type": "low_ongoing_balance",
"customer_id": "<string>",
"end_time": "<string>",
"entity_id": "<string>",
"entity_type": "wallet",
"expand": "<string>",
"filters": [
{
"data_type": "string",
"field": "<string>",
"operator": "eq",
"value": {
"array": [
"<string>"
],
"boolean": true,
"date": "<string>",
"number": 123,
"string": "<string>"
}
}
],
"limit": 500,
"offset": 1,
"order": "asc",
"sort": [
{
"direction": "asc",
"field": "<string>"
}
],
"start_time": "<string>",
"status": "published"
}
'{
"items": [
{
"alert_info": {
"alert_settings": {
"alert_enabled": true,
"critical": {
"condition": "above",
"threshold": 123
},
"info": {
"condition": "above",
"threshold": 123
},
"warning": {
"condition": "above",
"threshold": 123
}
},
"timestamp": "<string>",
"value_at_time": 123
},
"alert_status": "ok",
"alert_type": "low_ongoing_balance",
"created_at": "<string>",
"created_by": "<string>",
"customer": {
"address_city": "<string>",
"address_country": "<string>",
"address_line1": "<string>",
"address_line2": "<string>",
"address_postal_code": "<string>",
"address_state": "<string>",
"created_at": "<string>",
"created_by": "<string>",
"email": "<string>",
"environment_id": "<string>",
"external_id": "<string>",
"id": "<string>",
"metadata": {},
"name": "<string>",
"status": "published",
"tenant_id": "<string>",
"updated_at": "<string>",
"updated_by": "<string>"
},
"customer_id": "<string>",
"entity_id": "<string>",
"entity_type": "wallet",
"environment_id": "<string>",
"feature": {
"alert_settings": {
"alert_enabled": true,
"critical": {
"condition": "above",
"threshold": 123
},
"info": {
"condition": "above",
"threshold": 123
},
"warning": {
"condition": "above",
"threshold": 123
}
},
"created_at": "<string>",
"created_by": "<string>",
"description": "<string>",
"environment_id": "<string>",
"id": "<string>",
"lookup_key": "<string>",
"metadata": {},
"meter": {
"aggregation": {
"bucket_size": "MINUTE",
"field": "<string>",
"multiplier": 123,
"type": "COUNT"
},
"created_at": "2024-03-20T15:04:05Z",
"event_name": "api_request",
"filters": [
{
"key": "<string>",
"values": [
"<string>"
]
}
],
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "API Usage Meter",
"reset_usage": "BILLING_PERIOD",
"status": "published",
"tenant_id": "tenant123",
"updated_at": "2024-03-20T15:04:05Z"
},
"meter_id": "<string>",
"name": "<string>",
"status": "published",
"tenant_id": "<string>",
"type": "metered",
"unit_plural": "<string>",
"unit_singular": "<string>",
"updated_at": "<string>",
"updated_by": "<string>"
},
"id": "<string>",
"parent_entity_id": "<string>",
"parent_entity_type": "<string>",
"status": "<string>",
"tenant_id": "<string>",
"updated_at": "<string>",
"updated_by": "<string>",
"wallet": {
"alert_config": {
"threshold": {
"type": "amount",
"value": 123
}
},
"alert_enabled": true,
"alert_state": "<string>",
"auto_topup_amount": 123,
"auto_topup_min_balance": 123,
"auto_topup_trigger": "disabled",
"balance": 123,
"config": {
"allowed_price_types": [
"ALL"
]
},
"conversion_rate": 123,
"created_at": "<string>",
"credit_balance": 123,
"currency": "<string>",
"customer_id": "<string>",
"description": "<string>",
"id": "<string>",
"metadata": {},
"name": "<string>",
"updated_at": "<string>",
"wallet_status": "active",
"wallet_type": "PROMOTIONAL"
}
}
],
"pagination": {
"limit": 123,
"offset": 123,
"total": 123
}
}Enter your API key in the format x-api-key <api-key>*
Filter
ok, info, warning, in_alarm low_ongoing_balance, low_credit_balance, feature_wallet_balance wallet, feature filters allows complex filtering based on multiple fields
Show child attributes
string, number, date, array eq, contains, gt, lt, in, not_in, before, after 1 <= x <= 1000x >= 0asc, desc published, deleted, archived OK
Show child attributes
Show child attributes
Show child attributes
ok, info, warning, in_alarm low_ongoing_balance, low_credit_balance, feature_wallet_balance Customer response object containing all customer information
Show child attributes
AddressCity is the city of the customer's address
AddressCountry is the country of the customer's address (ISO 3166-1 alpha-2)
AddressLine1 is the first line of the customer's address
AddressLine2 is the second line of the customer's address
AddressPostalCode is the postal code of the customer's address
AddressState is the state of the customer's address
Email is the email of the customer
EnvironmentID is the environment identifier for the customer
ExternalID is the external identifier for the customer
ID is the unique identifier for the customer
Name is the name of the customer
published, deleted, archived wallet, feature Show child attributes
Show child attributes
Show child attributes
Show child attributes
MINUTE, 15MIN, 30MIN, HOUR, 3HOUR, 6HOUR, 12HOUR, DAY, WEEK, MONTH Field is the key in $event.properties on which the aggregation is to be applied For ex if the aggregation type is sum for API usage, the field could be "duration_ms"
Multiplier is the multiplier for the aggregation For ex if the aggregation type is sum_with_multiplier for API usage, the multiplier could be 1000 to scale up by a factor of 1000. If not provided, it will be null.
COUNT, SUM, AVG, COUNT_UNIQUE, LATEST, SUM_WITH_MULTIPLIER, MAX, WEIGHTED_SUM "2024-03-20T15:04:05Z"
"api_request"
Show child attributes
Key is the key for the filter from $event.properties Currently we support only first level keys in the properties and not nested keys
Values are the possible values for the filter to be considered for the meter For ex "model_name" could have values "o1-mini", "gpt-4o" etc
"550e8400-e29b-41d4-a716-446655440000"
"API Usage Meter"
BILLING_PERIOD, NEVER "published"
"tenant123"
"2024-03-20T15:04:05Z"
published, deleted, archived metered, boolean, static Show child attributes
disabled, balance_below_threshold active, frozen, closed PROMOTIONAL, PRE_PAID curl --request POST \
--url https://api.cloud.flexprice.io/v1/alert/search \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"alert_status": "ok",
"alert_type": "low_ongoing_balance",
"customer_id": "<string>",
"end_time": "<string>",
"entity_id": "<string>",
"entity_type": "wallet",
"expand": "<string>",
"filters": [
{
"data_type": "string",
"field": "<string>",
"operator": "eq",
"value": {
"array": [
"<string>"
],
"boolean": true,
"date": "<string>",
"number": 123,
"string": "<string>"
}
}
],
"limit": 500,
"offset": 1,
"order": "asc",
"sort": [
{
"direction": "asc",
"field": "<string>"
}
],
"start_time": "<string>",
"status": "published"
}
'{
"items": [
{
"alert_info": {
"alert_settings": {
"alert_enabled": true,
"critical": {
"condition": "above",
"threshold": 123
},
"info": {
"condition": "above",
"threshold": 123
},
"warning": {
"condition": "above",
"threshold": 123
}
},
"timestamp": "<string>",
"value_at_time": 123
},
"alert_status": "ok",
"alert_type": "low_ongoing_balance",
"created_at": "<string>",
"created_by": "<string>",
"customer": {
"address_city": "<string>",
"address_country": "<string>",
"address_line1": "<string>",
"address_line2": "<string>",
"address_postal_code": "<string>",
"address_state": "<string>",
"created_at": "<string>",
"created_by": "<string>",
"email": "<string>",
"environment_id": "<string>",
"external_id": "<string>",
"id": "<string>",
"metadata": {},
"name": "<string>",
"status": "published",
"tenant_id": "<string>",
"updated_at": "<string>",
"updated_by": "<string>"
},
"customer_id": "<string>",
"entity_id": "<string>",
"entity_type": "wallet",
"environment_id": "<string>",
"feature": {
"alert_settings": {
"alert_enabled": true,
"critical": {
"condition": "above",
"threshold": 123
},
"info": {
"condition": "above",
"threshold": 123
},
"warning": {
"condition": "above",
"threshold": 123
}
},
"created_at": "<string>",
"created_by": "<string>",
"description": "<string>",
"environment_id": "<string>",
"id": "<string>",
"lookup_key": "<string>",
"metadata": {},
"meter": {
"aggregation": {
"bucket_size": "MINUTE",
"field": "<string>",
"multiplier": 123,
"type": "COUNT"
},
"created_at": "2024-03-20T15:04:05Z",
"event_name": "api_request",
"filters": [
{
"key": "<string>",
"values": [
"<string>"
]
}
],
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "API Usage Meter",
"reset_usage": "BILLING_PERIOD",
"status": "published",
"tenant_id": "tenant123",
"updated_at": "2024-03-20T15:04:05Z"
},
"meter_id": "<string>",
"name": "<string>",
"status": "published",
"tenant_id": "<string>",
"type": "metered",
"unit_plural": "<string>",
"unit_singular": "<string>",
"updated_at": "<string>",
"updated_by": "<string>"
},
"id": "<string>",
"parent_entity_id": "<string>",
"parent_entity_type": "<string>",
"status": "<string>",
"tenant_id": "<string>",
"updated_at": "<string>",
"updated_by": "<string>",
"wallet": {
"alert_config": {
"threshold": {
"type": "amount",
"value": 123
}
},
"alert_enabled": true,
"alert_state": "<string>",
"auto_topup_amount": 123,
"auto_topup_min_balance": 123,
"auto_topup_trigger": "disabled",
"balance": 123,
"config": {
"allowed_price_types": [
"ALL"
]
},
"conversion_rate": 123,
"created_at": "<string>",
"credit_balance": 123,
"currency": "<string>",
"customer_id": "<string>",
"description": "<string>",
"id": "<string>",
"metadata": {},
"name": "<string>",
"updated_at": "<string>",
"wallet_status": "active",
"wallet_type": "PROMOTIONAL"
}
}
],
"pagination": {
"limit": 123,
"offset": 123,
"total": 123
}
}