> For the complete documentation index, see [llms.txt](https://docs.hypersolutions.co/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.hypersolutions.co/api-reference/usage-statistics.md).

# Usage & Status Codes

### Checking your usage

Use the Usage API to monitor your remaining quota and consumption:

## Get usage statistics

> Retrieves detailed usage statistics for all products and plans associated with the API key

```json
{"openapi":"3.0.0","info":{"title":"JustHyped Usage Statistics API","version":"1.0.0"},"servers":[{"url":"https://api.hypersolutions.co","description":"Main server for usage statistics"}],"paths":{"/usage":{"get":{"summary":"Get usage statistics","description":"Retrieves detailed usage statistics for all products and plans associated with the API key","operationId":"getUsageStatistics","parameters":[{"in":"header","name":"x-api-key","required":true,"schema":{"type":"string"},"description":"Your API key for authentication"}],"responses":{"200":{"description":"OK Usage statistics successfully retrieved","content":{"application/json":{"schema":{"type":"object","properties":{"balanceEuro":{"type":"number","format":"float","description":"Current balance in Euros"},"plans":{"type":"array","description":"List of plans with their usage statistics","items":{"type":"object","properties":{"expiresAt":{"type":"string","format":"date-time","description":"ISO 8601 date when this plan expires"},"requestsUsed":{"type":"integer","description":"Number of requests used from this plan"},"requestsQuota":{"type":"integer","description":"Total number of requests allocated to this plan"},"requestsRemaining":{"type":"integer","description":"Number of requests remaining (quota - used)"},"product":{"type":"string","description":"Name of the product (e.g., \"akamai\", \"datadome\", \"incapsula\")"},"numRequests":{"type":"integer","description":"Total number of requests for this plan"}}}}}}}}},"401":{"description":"Unauthorized - API key is missing or invalid","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message"}}}}}},"403":{"description":"Forbidden - API key is disabled","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message"}}}}}}}}}}}
```

### Status codes

These are the responses the Hyper Solutions API itself returns:

| Status | Means                          | Fix                                                                                                                                                           |
| ------ | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `200`  | Payload generated successfully | Replay the returned payload and `headers` object on the target                                                                                                |
| `401`  | Missing or invalid API key     | Check the `x-api-key` header and your key at [hypersolutions.co/keys](https://hypersolutions.co/keys). See [Authentication](/api-reference/authentication.md) |

{% hint style="info" %}
Compress your request bodies, some sensor payloads are large. The SDKs auto-compress bodies over 1000 bytes. See [Compression](/api-reference/compression.md).
{% endhint %}
