Fetch User Limits

curl --request GET \
  --url https://api.intelligence.io.solutions/api/r2r/v3/users/{id}/limits \
  --header 'Authorization: Bearer <token>'

{
  "results": {
    "storage_limits": {
      "chunks": {
        "limit": 1,
        "used": 1,
        "remaining": 1
      },
      "documents": {
        "limit": 1,
        "used": 1,
        "remaining": 1
      },
      "collections": {
        "limit": 1,
        "used": 1,
        "remaining": 1
      }
    },
    "system_defaults": {
      "global_per_min": 1,
      "monthly_limit": 1,
      "route_per_min": 1
    },
    "user_overrides": {
      "key": "value"
    },
    "effective_limits": {
      "global_per_min": 1,
      "monthly_limit": 1,
      "route_per_min": 1
    },
    "usage": {
      "global_per_min": {
        "used": 1,
        "limit": 1,
        "remaining": 1
      },
      "monthly_limit": {
        "used": 1,
        "limit": 1,
        "remaining": 1
      },
      "routes": {
        "key": {
          "route_per_min": {
            "used": 1,
            "limit": 1,
            "remaining": 1
          },
          "monthly_limit": {
            "used": 1,
            "limit": 1,
            "remaining": 1
          }
        }
      }
    }
  }
}

GET

api

r2r

users

{id}

limits

Fetch User Limits

curl --request GET \
  --url https://api.intelligence.io.solutions/api/r2r/v3/users/{id}/limits \
  --header 'Authorization: Bearer <token>'

{
  "results": {
    "storage_limits": {
      "chunks": {
        "limit": 1,
        "used": 1,
        "remaining": 1
      },
      "documents": {
        "limit": 1,
        "used": 1,
        "remaining": 1
      },
      "collections": {
        "limit": 1,
        "used": 1,
        "remaining": 1
      }
    },
    "system_defaults": {
      "global_per_min": 1,
      "monthly_limit": 1,
      "route_per_min": 1
    },
    "user_overrides": {
      "key": "value"
    },
    "effective_limits": {
      "global_per_min": 1,
      "monthly_limit": 1,
      "route_per_min": 1
    },
    "usage": {
      "global_per_min": {
        "used": 1,
        "limit": 1,
        "remaining": 1
      },
      "monthly_limit": {
        "used": 1,
        "limit": 1,
        "remaining": 1
      },
      "routes": {
        "key": {
          "route_per_min": {
            "used": 1,
            "limit": 1,
            "remaining": 1
          },
          "monthly_limit": {
            "used": 1,
            "limit": 1,
            "remaining": 1
          }
        }
      }
    }
  }
}

Only superusers or the user themself may fetch these values.

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

string

required

User ID

Response

200

results

object

Show child attributes

results.storage_limits

object

Show child attributes

results.storage_limits.chunks

object

Show child attributes

results.storage_limits.chunks.limit

integer

default:0

Example:

1

results.storage_limits.chunks.used

integer

default:0

Example:

1

results.storage_limits.chunks.remaining

integer

default:0

Example:

1

results.storage_limits.documents

object

Show child attributes

results.storage_limits.documents.limit

integer

default:0

Example:

1

results.storage_limits.documents.used

integer

default:0

Example:

1

results.storage_limits.documents.remaining

integer

default:0

Example:

1

results.storage_limits.collections

object

Show child attributes

results.storage_limits.collections.limit

integer

default:0

Example:

1

results.storage_limits.collections.used

integer

default:0

Example:

1

results.storage_limits.collections.remaining

integer

default:0

Example:

1

results.system_defaults

object

Show child attributes

results.system_defaults.global_per_min

integer

default:0

Example:

1

results.system_defaults.monthly_limit

integer

default:0

Example:

1

results.system_defaults.route_per_min

integer

default:0

Example:

1

results.user_overrides

object

Show child attributes

results.user_overrides.key

string

Example:

"value"

results.effective_limits

object

Show child attributes

results.effective_limits.global_per_min

integer

default:0

Example:

1

results.effective_limits.monthly_limit

integer

default:0

Example:

1

results.effective_limits.route_per_min

integer

default:0

Example:

1

results.usage

object

Show child attributes

results.usage.global_per_min

object

Show child attributes

results.usage.global_per_min.limit

integer

default:0

Example:

1

results.usage.global_per_min.used

integer

default:0

Example:

1

results.usage.global_per_min.remaining

integer

default:0

Example:

1

results.usage.monthly_limit

object

Show child attributes

results.usage.monthly_limit.limit

integer

default:0

Example:

1

results.usage.monthly_limit.used

integer

default:0

Example:

1

results.usage.monthly_limit.remaining

integer

default:0

Example:

1

results.usage.routes

object

Show child attributes

results.usage.routes.key

object

Show child attributes

results.usage.routes.key.route_per_min

object

Show child attributes

results.usage.routes.key.route_per_min.limit

integer

default:0

Example:

1

results.usage.routes.key.route_per_min.used

integer

default:0

Example:

1

results.usage.routes.key.route_per_min.remaining

integer

default:0

Example:

1

results.usage.routes.key.monthly_limit

object

Show child attributes

results.usage.routes.key.monthly_limit.limit

integer

default:0

Example:

1

results.usage.routes.key.monthly_limit.used

integer

default:0

Example:

1

results.usage.routes.key.monthly_limit.remaining

integer

default:0

Example:

1

Get user details List user's collections

⌘I

IO Explorer

IO Intelligence

IO Cloud

Fetch User Limits

Authorizations

Path Parameters

Response