Sign in

v4

latestOpenAPI 3.0.32026-08-0161180264.4 KB
monitoring
integrations

queryInboundMonitoringEvents

Query inbound monitoring events for a specific integration. Returns detailed information about inbound sync events from ERP systems, including success rates, error breakdowns, and processing metrics.

post/v1/integrations/{integrationId}/monitoring/inbound-events

Path parameters

integrationIdstring uuid required

The integration ID

Request body

use_case_idstring uuid

Filter by use case ID

event_type'CREATE' | 'UPDATE' | 'DELETE' | 'TRIGGER'

Filter by event type

sync_type'entity' | 'meter_reading' | 'webhook' | 'api_deprecation'

Filter by sync type

status'success' | 'error' | 'skipped' | 'warning'

Filter by processing status

error_category'validation' | 'configuration' | 'downstream_api' | 'timeout' | 'system'

Filter by error category (only applicable when status=error)

correlation_idstring

Filter by correlation ID

object_typestring

Filter by object type (e.g., 'contract', 'meter')

event_namestring

Filter by event name (alias for object_type)

event_idstring

Filter by event ID to find a specific event

from_datestring date-time

Filter events from this date (inclusive)

to_datestring date-time

Filter events until this date (inclusive)

limitinteger

Maximum number of results to return

Example request

{
  "from_date": "2025-01-01T00:00:00Z",
  "to_date": "2025-01-31T23:59:59Z",
  "limit": 50
}

Response

Inbound monitoring events queried successfully

has_moreboolean

Indicates if more results are available