API Explorer 936 endpoints

Get Connector Call Counts

GET /obp/v7.0.0/management/connector/metrics/counts

OBPv6.0.0-getConnectorCallCounts Roles: CanReadMetrics MetricAPI

Returns per-hour Redis counters for connector outbound and inbound messages.

This provides real-time visibility into which connector methods are being called and how many responses (success/failure) are being received.

Counters automatically reset every hour (rolling window). The ttl_seconds field shows when the current hour window resets.

Requires the prop: write_connector_metrics_redis=true

Redis key format:

  • Outbound (before connector call): {instance}{env}connector_outbound{version}{connectorName}_{methodName}_PER_HOUR
  • Inbound success (after connector call): {instance}{env}connector_inbound{version}{connectorName}_{methodName}_success_PER_HOUR
  • Inbound failure (after connector call): {instance}{env}connector_inbound{version}{connectorName}_{methodName}_failure_PER_HOUR

For example: obp_dev_connector_outbound_1_star_getBanks_PER_HOUR

Authentication is Required

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON response body fields (8)
connector_counts
connector_counts
connector_name
enabled
false
method_name
per_hour_inbound_failure_count
per_hour_inbound_failure_count
per_hour_inbound_success_count
per_hour_inbound_success_count
per_hour_outbound_count
per_hour_outbound_count
ttl_seconds
ttl_seconds
Example success response
{
  "enabled": true,
  "connector_counts": [
    {
      "connector_name": "mapped",
      "method_name": "getBank",
      "per_hour_outbound_count": 152,
      "per_hour_inbound_success_count": 150,
      "per_hour_inbound_failure_count": 2,
      "ttl_seconds": 2847
    }
  ]
}
Possible errors (3)
  • OBP-50000: Unknown Error.
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
Implemented by OBPv6.0.0 getConnectorCallCounts Originally /obp/v6.0.0/management/connector/metrics/counts