API Explorer 936 endpoints

Get Call Counts for Consumer

GET /obp/v7.0.0/management/consumers/CONSUMER_ID/call-counters

OBPv6.0.0-getConsumerCallCounters Roles: CanGetRateLimits Consumer

Get the call counters (current usage) for a specific consumer. Shows how many API calls have been made and when the counters reset.

This endpoint returns the current state of API rate limits across all time periods (per second, per minute, per hour, per day, per week, per month).

Response Structure: The response always contains a consistent structure with all six time periods, regardless of whether rate limits are configured or active.

Each time period contains:

  • calls_made: Number of API calls made in the current period (null if no data available)
  • reset_in_seconds: Seconds until the counter resets (null if no data available)
  • status: Current state of the rate limit for this period

Status Values:

  • ACTIVE: Rate limit counter is active and tracking calls. Both calls_made and reset_in_seconds will have numeric values.
  • NO_COUNTER: Key does not exist - the consumer has not made any API calls in this time period yet.
  • EXPIRED: The rate limit counter has expired (TTL reached 0). The counter will be recreated on the next API call.
  • REDIS_UNAVAILABLE: Cannot retrieve data from Redis. This indicates a system connectivity issue.
  • DATA_MISSING: Unexpected error - period data is missing from the response. This should not occur under normal circumstances.

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

URL Parameters:

CONSUMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

JSON response body fields (9)
per_day
4000
per_hour
per_minute
per_month
500
per_second
1000
per_week
50000
status
calls_made
50
reset_in_seconds
Example success response
{
  "per_second": {
    "calls_made": 42,
    "reset_in_seconds": 15,
    "status": "ACTIVE"
  },
  "per_minute": {
    "calls_made": 42,
    "reset_in_seconds": 15,
    "status": "ACTIVE"
  },
  "per_hour": {
    "calls_made": 42,
    "reset_in_seconds": 15,
    "status": "ACTIVE"
  },
  "per_day": {
    "calls_made": 42,
    "reset_in_seconds": 15,
    "status": "ACTIVE"
  },
  "per_week": {
    "calls_made": 42,
    "reset_in_seconds": 15,
    "status": "ACTIVE"
  },
  "per_month": {
    "calls_made": 42,
    "reset_in_seconds": 15,
    "status": "ACTIVE"
  }
}
Possible errors (7)
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-10001: Incorrect json format.
  • OBP-20014: Invalid Consumer ID. Please specify a valid value for CONSUMER_ID.
  • OBP-30019: Consumer not found. Please specify a valid value for CONSUMER_ID.
  • OBP-20006: User is missing one or more roles:
  • OBP-30023: Cannot update Consumer
  • OBP-50000: Unknown Error.
Implemented by OBPv6.0.0 getConsumerCallCounters Originally /obp/v6.0.0/management/consumers/CONSUMER_ID/call-counters