Usage

GET

/v1/usage

Get detailed usage statistics for your account.

Query Parameters

Parameter	Type	Required	Description
`period`	string	No	Time period: `day`, `week`, `month`, `all` (default: `month`)
`breakdown`	string	No	Breakdown type: `endpoint`, `day`, `key`

Examples

Get Current Usage

curl https://api.hypersave.io/v1/usage \
  -H "Authorization: Bearer YOUR_API_KEY"

Get Usage by Endpoint

curl "https://api.hypersave.io/v1/usage?breakdown=endpoint" \
  -H "Authorization: Bearer YOUR_API_KEY"

Get Daily Breakdown

curl "https://api.hypersave.io/v1/usage?breakdown=day&period=month" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

Basic Usage

{
  "success": true,
  "usage": {
    "period": "month",
    "startDate": "2024-01-01T00:00:00Z",
    "endDate": "2024-01-31T23:59:59Z",
    "summary": {
      "totalRequests": 4521,
      "successfulRequests": 4498,
      "failedRequests": 23,
      "averageLatencyMs": 245
    },
    "limits": {
      "requestsPerHour": 1000,
      "monthlyRequests": 100000,
      "usedPercentage": 4.5
    },
    "storage": {
      "memoryCount": 1523,
      "totalSizeMb": 234,
      "limitMb": 10000,
      "usedPercentage": 2.34
    }
  }
}

Usage by Endpoint

{
  "success": true,
  "usage": {
    "period": "month",
    "byEndpoint": [
      {
        "endpoint": "/v1/save",
        "requests": 1200,
        "percentage": 26.5,
        "avgLatencyMs": 450
      },
      {
        "endpoint": "/v1/ask",
        "requests": 1800,
        "percentage": 39.8,
        "avgLatencyMs": 1200
      },
      {
        "endpoint": "/v1/search",
        "requests": 950,
        "percentage": 21.0,
        "avgLatencyMs": 180
      },
      {
        "endpoint": "/v1/memories",
        "requests": 571,
        "percentage": 12.7,
        "avgLatencyMs": 85
      }
    ]
  }
}

Daily Breakdown

{
  "success": true,
  "usage": {
    "period": "month",
    "daily": [
      {
        "date": "2024-01-01",
        "requests": 145,
        "successful": 143,
        "failed": 2
      },
      {
        "date": "2024-01-02",
        "requests": 189,
        "successful": 189,
        "failed": 0
      },
      {
        "date": "2024-01-03",
        "requests": 167,
        "successful": 165,
        "failed": 2
      }
    ]
  }
}

Response Fields

Field	Type	Description
`totalRequests`	number	Total API requests
`successfulRequests`	number	Successful requests (2xx)
`failedRequests`	number	Failed requests (4xx, 5xx)
`averageLatencyMs`	number	Average response time
`usedPercentage`	number	Percentage of limit used

Usage statistics are updated in real-time. For detailed historical data, use the Platform dashboard.

Monitoring Your Usage

Track your usage to avoid hitting limits:

async function checkUsage() {
  const response = await fetch('https://api.hypersave.io/v1/usage', {
    headers: { 'Authorization': 'Bearer YOUR_API_KEY' }
  });
  const { usage } = await response.json();
 
  if (usage.limits.usedPercentage > 80) {
    console.warn('Warning: Approaching monthly limit');
  }
 
  return usage;
}

Error Response

Rate Limited

{
  "success": false,
  "error": "RATE_LIMITED",
  "message": "Rate limit exceeded",
  "retryAfter": 3600,
  "usage": {
    "requestsThisHour": 1000,
    "limit": 1000
  }
}

Profile Overview