API Explorer 993 endpoints

Get My Consumer Usage

GET /obp/v7.0.0/my/consumers/CONSUMER_ID/usage

OBPv7.0.0-getMyConsumerUsage No role required ConsumerOrganisation

Get the rate limits one of your Consumers is under now, and how many calls it has made in each period so far. Every response from OBP also carries the headers X-Rate-Limit-Limit, X-Rate-Limit-Remaining and X-Rate-Limit-Reset for the calling application.

You may read a Consumer here if you created it and it belongs to no Organisation, or if it belongs to an active Organisation you are a member of. Any other CONSUMER_ID answers 404. The consumer key and secret are never returned.

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 (20)
active_at_date
active_at_date
active_per_day_rate_limit
active_per_day_rate_limit
active_per_hour_rate_limit
active_per_hour_rate_limit
active_per_minute_rate_limit
active_per_minute_rate_limit
active_per_month_rate_limit
active_per_month_rate_limit
active_per_second_rate_limit
active_per_second_rate_limit
active_per_week_rate_limit
active_per_week_rate_limit
active_rate_limits
active_rate_limits
call_counters
call_counters
considered_rate_limit_ids
considered_rate_limit_ids
consumer_id
7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
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
{
  "consumer_id": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "active_rate_limits": {
    "considered_rate_limit_ids": [
      "80e1e0b2-d8bf-4f85-a579-e69ef36e3305"
    ],
    "active_at_date": "1100-01-01T00:00:00Z",
    "active_per_second_rate_limit": 100,
    "active_per_minute_rate_limit": 1000,
    "active_per_hour_rate_limit": -1,
    "active_per_day_rate_limit": -1,
    "active_per_week_rate_limit": -1,
    "active_per_month_rate_limit": -1
  },
  "call_counters": {
    "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 (3)
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30643: Consumer not found. Please specify the CONSUMER_ID of a Consumer you created or one that belongs to your Organisation.
  • OBP-50000: Unknown Error.
Implemented by OBPv7.0.0 getMyConsumerUsage