Utilities & Health

PreviousAPI Key Management NextExplanatory Notes

Last updated 5 months ago

Was this helpful?

Get User Stats

get

Authorizations

Responses

application/json

objectoptional

application/json

get

GET /user_stats HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Accept: */*

{
  "org_name": "text",
  "email_of_org_admins": [
    "text"
  ],
  "org_id": "text",
  "requests_since_last_utc_midnicht": {
    "used": 1,
    "soft_limit": 1,
    "hard_limit": 1
  },
  "requests_since_full_hour": {
    "used": 1,
    "soft_limit": 1,
    "hard_limit": 1
  },
  "requests_in_the_last_60_seconds": {
    "used": 1,
    "soft_limit": 1,
    "hard_limit": 1
  },
  "requests_in_parallel": {
    "used": 1,
    "soft_limit": 1,
    "hard_limit": 1
  }
}

Health

get

Responses

application/json

objectoptionalExample: {"message":"geo-information endpoints are currently not available.","status":"degraded"}

get

GET /health HTTP/1.1
Host: 
Accept: */*

200

Successful Response

{
  "message": "geo-information endpoints are currently not available.",
  "status": "degraded"
}

Version

get

Authorizations

Responses

application/json

objectoptionalExample: {"version":"1.2.3"}

get

GET /version HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Accept: */*

200

Successful Response

{
  "version": "1.2.3"
}