View Source GitHub.Copilot (GitHub REST API Client v0.3.3)
Provides API endpoints related to copilot
Link to this section Summary
Functions
Add teams to the Copilot subscription for an organization
Add users to the Copilot subscription for an organization
Remove teams from the Copilot subscription for an organization
Remove users from the Copilot subscription for an organization
Get Copilot seat information and settings for an organization
Get Copilot seat assignment details for a user
List all Copilot seat assignments for an organization
Get a summary of Copilot usage for enterprise members
Get a summary of Copilot usage for organization members
Get a summary of Copilot usage for a team
Link to this section Types
@type list_copilot_seats_200_json_resp() :: %{ __info__: map(), seats: [GitHub.Copilot.SeatDetails.t()] | nil, total_seats: integer() | nil }
Link to this section Functions
@spec add_copilot_seats_for_teams(String.t(), map(), keyword()) :: {:ok, map()} | {:error, GitHub.Error.t()}
Add teams to the Copilot subscription for an organization
Note: This endpoint is in beta and is subject to change.
Purchases a GitHub Copilot seat for all users within each specified team. The organization will be billed accordingly. For more information about Copilot pricing, see "Pricing for GitHub Copilot".
Only organization owners can configure GitHub Copilot in their organization.
In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. For more information about setting up a Copilot subscription, see "Setting up a Copilot subscription for your organization". For more information about setting a suggestion matching policy, see "Configuring suggestion matching policies for GitHub Copilot in your organization".
OAuth app tokens and personal access tokens (classic) need the manage_billing:copilot scope to use this endpoint.
resources
Resources
@spec add_copilot_seats_for_users(String.t(), map(), keyword()) :: {:ok, map()} | {:error, GitHub.Error.t()}
Add users to the Copilot subscription for an organization
Note: This endpoint is in beta and is subject to change.
Purchases a GitHub Copilot seat for each user specified. The organization will be billed accordingly. For more information about Copilot pricing, see "Pricing for GitHub Copilot".
Only organization owners can configure GitHub Copilot in their organization.
In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. For more information about setting up a Copilot subscription, see "Setting up a Copilot subscription for your organization". For more information about setting a suggestion matching policy, see "Configuring suggestion matching policies for GitHub Copilot in your organization".
OAuth app tokens and personal access tokens (classic) need the manage_billing:copilot scope to use this endpoint.
resources
Resources
@spec cancel_copilot_seat_assignment_for_teams(String.t(), map(), keyword()) :: {:ok, map()} | {:error, GitHub.Error.t()}
Remove teams from the Copilot subscription for an organization
Note: This endpoint is in beta and is subject to change.
Cancels the Copilot seat assignment for all members of each team specified. This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.
For more information about Copilot pricing, see "Pricing for GitHub Copilot".
For more information about disabling access to Copilot Business or Enterprise, see "Revoking access to GitHub Copilot for specific users in your organization".
Only organization owners can configure GitHub Copilot in their organization.
OAuth app tokens and personal access tokens (classic) need the manage_billing:copilot scope to use this endpoint.
resources
Resources
@spec cancel_copilot_seat_assignment_for_users(String.t(), map(), keyword()) :: {:ok, map()} | {:error, GitHub.Error.t()}
Remove users from the Copilot subscription for an organization
Note: This endpoint is in beta and is subject to change.
Cancels the Copilot seat assignment for each user specified. This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.
For more information about Copilot pricing, see "Pricing for GitHub Copilot".
For more information about disabling access to Copilot Business or Enterprise, see "Revoking access to GitHub Copilot for specific users in your organization".
Only organization owners can configure GitHub Copilot in their organization.
OAuth app tokens and personal access tokens (classic) need the manage_billing:copilot scope to use this endpoint.
resources
Resources
@spec get_copilot_organization_details( String.t(), keyword() ) :: {:ok, GitHub.Copilot.OrganizationDetails.t()} | {:error, GitHub.Error.t()}
Get Copilot seat information and settings for an organization
Note: This endpoint is in beta and is subject to change.
Gets information about an organization's Copilot subscription, including seat breakdown and code matching policies. To configure these settings, go to your organization's settings on GitHub.com. For more information, see "Managing policies for Copilot in your organization".
Only organization owners can configure and view details about the organization's Copilot Business subscription.
OAuth app tokens and personal access tokens (classic) need the manage_billing:copilot scope to use this endpoint.
resources
Resources
@spec get_copilot_seat_details_for_user(String.t(), String.t(), keyword()) :: {:ok, GitHub.Copilot.SeatDetails.t()} | {:error, GitHub.Error.t()}
Get Copilot seat assignment details for a user
Note: This endpoint is in beta and is subject to change.
Gets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot.
Organization owners can view GitHub Copilot seat assignment details for members in their organization.
OAuth app tokens and personal access tokens (classic) need the manage_billing:copilot scope to use this endpoint.
resources
Resources
@spec list_copilot_seats( String.t(), keyword() ) :: {:ok, map()} | {:error, GitHub.Error.t()}
List all Copilot seat assignments for an organization
Note: This endpoint is in beta and is subject to change.
Lists all Copilot seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle).
Only organization owners can configure and view details about the organization's Copilot Business or Enterprise subscription.
OAuth app tokens and personal access tokens (classic) need the manage_billing:copilot scope to use this endpoint.
options
Options
page: The page number of the results to fetch. For more information, see "Using pagination in the REST API."per_page: The number of results per page (max 100). For more information, see "Using pagination in the REST API."
resources
Resources
@spec usage_metrics_for_enterprise( String.t(), keyword() ) :: {:ok, [GitHub.Copilot.UsageMetrics.t()]} | {:error, GitHub.Error.t()}
Get a summary of Copilot usage for enterprise members
Note: This endpoint is in beta and is subject to change.
You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE for all users across organizations with access to Copilot within your enterprise, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. See the response schema tab for detailed metrics definitions.
The response contains metrics for the prior 28 days. Usage metrics are processed once per day for the previous day, and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, they must have telemetry enabled in their IDE.
Only the owners and billing managers of enterprises with a Copilot Business or Enterprise subscription can view Copilot usage metrics for the enterprise.
OAuth app tokens and personal access tokens (classic) need the copilot, manage_billing:copilot, admin:enterprise, or manage_billing:enterprise scope to use this endpoint.
options
Options
since: Show usage metrics since this date. This is a timestamp in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ). Maximum value is 28 days ago.until: Show usage metrics until this date. This is a timestamp in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ) and should not preceed thesincedate if it is passed.page: The page number of the results to fetch. For more information, see "Using pagination in the REST API."per_page: The number of days of metrics to display per page (max 28). For more information, see "Using pagination in the REST API."
resources
Resources
@spec usage_metrics_for_org( String.t(), keyword() ) :: {:ok, [GitHub.Copilot.UsageMetrics.t()]} | {:error, GitHub.Error.t()}
Get a summary of Copilot usage for organization members
Note: This endpoint is in beta and is subject to change.
You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE across an organization, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. See the response schema tab for detailed metrics definitions.
The response contains metrics for the prior 28 days. Usage metrics are processed once per day for the previous day, and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, they must have telemetry enabled in their IDE.
Copilot Business or Copilot Enterprise organization owners, and owners and billing managers of their parent enterprises, can view Copilot usage metrics.
OAuth app tokens and personal access tokens (classic) need the copilot, manage_billing:copilot, admin:org, admin:enterprise, or manage_billing:enterprise scope to use this endpoint.
options
Options
since: Show usage metrics since this date. This is a timestamp in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ). Maximum value is 28 days ago.until: Show usage metrics until this date. This is a timestamp in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ) and should not preceed thesincedate if it is passed.page: The page number of the results to fetch. For more information, see "Using pagination in the REST API."per_page: The number of days of metrics to display per page (max 28). For more information, see "Using pagination in the REST API."
resources
Resources
@spec usage_metrics_for_team(String.t(), String.t(), keyword()) :: {:ok, [GitHub.Copilot.UsageMetrics.t()]} | {:error, GitHub.Error.t()}
Get a summary of Copilot usage for a team
Note: This endpoint is in beta and is subject to change.
You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE for users within a team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. See the response schema tab for detailed metrics definitions.
The response contains metrics for the prior 28 days. Usage metrics are processed once per day for the previous day, and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, they must have telemetry enabled in their IDE.
Note: This endpoint will only return results for a given day if the team had five or more members on that day.
Copilot Business or Copilot Enterprise organization owners for the organization that contains this team, and owners and billing managers of their parent enterprises, can view Copilot usage metrics for a team.
OAuth app tokens and personal access tokens (classic) need the copilot, manage_billing:copilot, admin:org, admin:enterprise, or manage_billing:enterprise scope to use this endpoint.
options
Options
since: Show usage metrics since this date. This is a timestamp in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ). Maximum value is 28 days ago.until: Show usage metrics until this date. This is a timestamp in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ) and should not preceed thesincedate if it is passed.page: The page number of the results to fetch. For more information, see "Using pagination in the REST API."per_page: The number of days of metrics to display per page (max 28). For more information, see "Using pagination in the REST API."