HirePlus Docs

Get usage statistics

GET
/v1/usage

Retrieve API usage statistics including daily breakdown for the last 7 days, credit balance, monthly spend, and remaining call estimates.

Authorization

ApiKeyAuth
x-api-key<token>

API key authentication. Pass your key in the x-api-key request header.

In: header

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://next.hireplus.ai/api/v1/usage"
{
  "period": {
    "start": "string",
    "end": "string"
  },
  "usage": {
    "today": 0,
    "this_month": 0,
    "all_time": 0
  },
  "daily_breakdown": {
    "property1": "string",
    "property2": "string"
  },
  "credits": {
    "balance": 0,
    "monthly_spend": 0,
    "monthly_cap": 0,
    "monthly_api_calls": 0,
    "monthly_api_call_cap": 0,
    "estimated_remaining_calls": 0
  }
}
{
  "error": "Invalid request parameters"
}
{
  "error": "Invalid or expired API key"
}
{
  "error": "API key does not have required scope"
}
{
  "error": "Resource not found"
}
{
  "error": "Rate limit exceeded. Max 100 requests per minute."
}
{
  "error": "Internal server error"
}

Get a skills gap analysis GET

Retrieve a single skills gap analysis by ID. Returns the full result including skill gaps, existing strengths, learning path, and career readiness timeline.

List analyses GET

Retrieve a paginated list of analyses. Supports optional status filtering. Returns analysis metadata with top-level scores.