-
-
Notifications
You must be signed in to change notification settings - Fork 599
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add Copilot Usage API Documentation detailing endpoints for retrievin…
…g usage summaries.
- Loading branch information
1 parent
3698933
commit 956fe9e
Showing
1 changed file
with
80 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,80 @@ | ||
# Copilot Usage API Documentation | ||
[Back to the navigation](../README.md) | ||
|
||
## Overview | ||
|
||
The Copilot Usage API provides endpoints to retrieve usage summaries for organizations and enterprises. | ||
|
||
**Note**: This endpoint is in beta and is subject to change. | ||
|
||
## Endpoints | ||
|
||
### Organization Usage Summary | ||
|
||
Retrieve the usage summary for a specific organization. | ||
|
||
**Method:** `GET` | ||
|
||
**Endpoint:** `/orgs/{organization}/copilot/usage` | ||
|
||
**Parameters:** | ||
- `organization` (string): The name of the organization. | ||
- `params` (array, optional): Additional query parameters. | ||
|
||
**Example:** | ||
```php | ||
$usage = $client->api('copilotUsage')->orgUsageSummary('KnpLabs'); | ||
``` | ||
|
||
### Organization Team Usage Summary | ||
|
||
Retrieve the usage summary for a specific team within an organization. | ||
|
||
**Method:** `GET` | ||
|
||
**Endpoint:** `/orgs/{organization}/team/{team}/copilot/usage` | ||
|
||
**Parameters:** | ||
- `organization` (string): The name of the organization. | ||
- `team` (string): The name of the team. | ||
- `params` (array, optional): Additional query parameters. | ||
|
||
**Example:** | ||
```php | ||
$usage = $client->api('copilotUsage')->orgTeamUsageSummary('KnpLabs', 'developers'); | ||
``` | ||
|
||
### Enterprise Usage Summary | ||
|
||
Retrieve the usage summary for a specific enterprise. | ||
|
||
**Method:** `GET` | ||
|
||
**Endpoint:** `/enterprises/{enterprise}/copilot/usage` | ||
|
||
**Parameters:** | ||
- `enterprise` (string): The name of the enterprise. | ||
- `params` (array, optional): Additional query parameters. | ||
|
||
**Example:** | ||
```php | ||
$usage = $client->api('copilotUsage')->enterpriseUsageSummary('KnpLabs'); | ||
``` | ||
|
||
### Enterprise Team Usage Summary | ||
|
||
Retrieve the usage summary for a specific team within an enterprise. | ||
|
||
**Method:** `GET` | ||
|
||
**Endpoint:** `/enterprises/{enterprise}/team/{team}/copilot/usage` | ||
|
||
**Parameters:** | ||
- `enterprise` (string): The name of the enterprise. | ||
- `team` (string): The name of the team. | ||
- `params` (array, optional): Additional query parameters. | ||
|
||
**Example:** | ||
```php | ||
$usage = $client->api('copilotUsage')->enterpriseTeamUsageSummary('KnpLabs', 'developers'); | ||
``` |