Utilities & Health

PreviousAPI Key Management NextExplanatory Notes

Last updated 3 months ago

Was this helpful?

Get User Stats

GET/user_stats

Authorization

Response

Successful Response

Body

org_name*Org Name

email_of_org_admins*Email Of Org Admins

org_id*Org Id

requests_since_last_utc_midnicht*Requests

requests_since_full_hour*Requests

requests_in_the_last_60_seconds*Requests

requests_in_parallel*Requests

Request

const response = await fetch('/user_stats', {
    method: 'GET',
    headers: {
      "x-api-key": "APIKeyHeader <apiKey>"
    },
});
const data = await response.json();

Response

{
  "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/health

Response

Successful Response

Body

status*HealthStatus

normaldegradedfailed

messageMessage

Request

const response = await fetch('/health', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Version

GET/version

Authorization

Response

Successful Response

Body

version*Version

Request

const response = await fetch('/version', {
    method: 'GET',
    headers: {
      "x-api-key": "APIKeyHeader <apiKey>"
    },
});
const data = await response.json();

Response

{
  "version": "1.2.3"
}