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>",
"parent_customer": "<unknown>",
"parent_customer_id": "<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": "<string>",
"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": "<string>",
"auto_topup_min_balance": "<string>",
"auto_topup_trigger": "disabled",
"balance": "<string>",
"config": {
"allowed_price_types": [
"ALL"
]
},
"conversion_rate": "<string>",
"created_at": "<string>",
"credit_balance": "<string>",
"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
1 <= x <= 1000x >= 0asc, desc Show child attributes
published, deleted, archived 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>",
"parent_customer": "<unknown>",
"parent_customer_id": "<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": "<string>",
"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": "<string>",
"auto_topup_min_balance": "<string>",
"auto_topup_trigger": "disabled",
"balance": "<string>",
"config": {
"allowed_price_types": [
"ALL"
]
},
"conversion_rate": "<string>",
"created_at": "<string>",
"credit_balance": "<string>",
"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
}
}