List Usage Limits Policy Entities

List entities tracked by a usage limits policy with their current usage.

GET /policies/usage-limits/{policyUsageLimitsId}/entities

List Usage Limits Policy Entities

cURL

curl --request GET \
  --url https://api.portkey.ai/v1/policies/usage-limits/{policyUsageLimitsId}/entities \
  --header 'x-portkey-api-key: <api-key>'

200

{
  "object": "list",
  "data": [
    {
      "id": "<string>",
      "value_key": "<string>",
      "current_usage": 123
    }
  ],
  "total": 123
}

Authorizations

x-portkey-api-key · string · header · required

Path Parameters

policyUsageLimitsId · string<uuid> · required

Usage limits policy UUID

Query Parameters

status · enum<string>

Filter by entity usage status

Available options: active, exhausted

search · string

Filter entities by value key

page_size · integer

Number of items per page

Required range: 1 <= x <= 100

current_page · integer

Current page number

Required range: x >= 0

Response

200

application/json

List of entities for the policy

object · string

Example:

"list"

data · object[]

Show child attributes

total · integer

Total number of entities