> For the complete documentation index, see [llms.txt](https://docs.validationcloud.io/v1/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.validationcloud.io/v1/about/admin-api-keys/usage.md).

# Usage

## Per-endpoint compute-unit usage

> Compute-unit series for a single endpoint, which must belong to the calling team. An endpoint owned by another team returns 404, indistinguishable from one that never existed; the team's own deleted endpoints remain readable. Defaults to the current calendar month (UTC) when from/to are omitted.

```json
{"openapi":"3.1.0","info":{"title":"Validation Cloud Node API — Admin API","version":"1.0.0"},"servers":[{"url":"/admin/v1"}],"security":[{"AdminApiKey":[]}],"components":{"securitySchemes":{"AdminApiKey":{"description":"Admin API key under the `ApiKey` scheme: `Authorization: ApiKey vc_adm_...`. Each key is bound to one team and carries a READ or WRITE scope; the usage endpoints require only READ.","in":"header","name":"Authorization","type":"apiKey"}},"schemas":{"admin.usageResponse":{"properties":{"compute_units":{"format":"int64","type":"integer"},"from":{"format":"date-time","type":"string"},"series":{"items":{"$ref":"#/components/schemas/admin.usagePoint"},"type":"array","uniqueItems":false},"to":{"format":"date-time","type":"string"}},"type":"object"},"admin.usagePoint":{"properties":{"compute_units":{"format":"int64","type":"integer"},"time":{"format":"date-time","type":"string"}},"type":"object"},"admin.errorEnvelope":{"properties":{"error":{"$ref":"#/components/schemas/admin.errorBody"}},"type":"object"},"admin.errorBody":{"properties":{"code":{"enum":["unauthorized","forbidden","invalid_request","not_found","endpoint_limit_reached","plan_not_eligible","rate_limited","internal_error"],"type":"string"},"message":{"type":"string"}},"type":"object"}}},"paths":{"/endpoints/{id}/usage":{"get":{"description":"Compute-unit series for a single endpoint, which must belong to the calling team. An endpoint owned by another team returns 404, indistinguishable from one that never existed; the team's own deleted endpoints remain readable. Defaults to the current calendar month (UTC) when from/to are omitted.","parameters":[{"description":"Endpoint UUID","in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"Inclusive window start, RFC3339","in":"query","name":"from","schema":{"format":"date-time","type":"string"}},{"description":"Exclusive window end, RFC3339","in":"query","name":"to","schema":{"format":"date-time","type":"string"}},{"description":"Bucket size. Max window per granularity: HOUR 7d, DAY 92d, WEEK/MONTH 366d; at most 750 buckets per request.","in":"query","name":"granularity","schema":{"default":"DAY","enum":["HOUR","DAY","WEEK","MONTH"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin.usageResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin.errorEnvelope"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin.errorEnvelope"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin.errorEnvelope"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin.errorEnvelope"}}},"description":"Internal Server Error"}},"summary":"Per-endpoint compute-unit usage","tags":["Usage"]}}}}
```

## Team-wide compute-unit usage

> Aggregated compute-unit usage for the team the admin key is bound to. Defaults to the current calendar month (UTC) when from/to are omitted.

```json
{"openapi":"3.1.0","info":{"title":"Validation Cloud Node API — Admin API","version":"1.0.0"},"servers":[{"url":"/admin/v1"}],"security":[{"AdminApiKey":[]}],"components":{"securitySchemes":{"AdminApiKey":{"description":"Admin API key under the `ApiKey` scheme: `Authorization: ApiKey vc_adm_...`. Each key is bound to one team and carries a READ or WRITE scope; the usage endpoints require only READ.","in":"header","name":"Authorization","type":"apiKey"}},"schemas":{"admin.usageResponse":{"properties":{"compute_units":{"format":"int64","type":"integer"},"from":{"format":"date-time","type":"string"},"series":{"items":{"$ref":"#/components/schemas/admin.usagePoint"},"type":"array","uniqueItems":false},"to":{"format":"date-time","type":"string"}},"type":"object"},"admin.usagePoint":{"properties":{"compute_units":{"format":"int64","type":"integer"},"time":{"format":"date-time","type":"string"}},"type":"object"},"admin.errorEnvelope":{"properties":{"error":{"$ref":"#/components/schemas/admin.errorBody"}},"type":"object"},"admin.errorBody":{"properties":{"code":{"enum":["unauthorized","forbidden","invalid_request","not_found","endpoint_limit_reached","plan_not_eligible","rate_limited","internal_error"],"type":"string"},"message":{"type":"string"}},"type":"object"}}},"paths":{"/usage":{"get":{"description":"Aggregated compute-unit usage for the team the admin key is bound to. Defaults to the current calendar month (UTC) when from/to are omitted.","parameters":[{"description":"Inclusive window start, RFC3339","in":"query","name":"from","schema":{"format":"date-time","type":"string"}},{"description":"Exclusive window end, RFC3339","in":"query","name":"to","schema":{"format":"date-time","type":"string"}},{"description":"Bucket size. Max window per granularity: HOUR 7d, DAY 92d, WEEK/MONTH 366d; at most 750 buckets per request.","in":"query","name":"granularity","schema":{"default":"DAY","enum":["HOUR","DAY","WEEK","MONTH"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin.usageResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin.errorEnvelope"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin.errorEnvelope"}}},"description":"Unauthorized"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin.errorEnvelope"}}},"description":"Internal Server Error"}},"summary":"Team-wide compute-unit usage","tags":["Usage"]}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.validationcloud.io/v1/about/admin-api-keys/usage.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.