diff --git a/descriptions-next/api.github.com/api.github.com.2022-11-28.json b/descriptions-next/api.github.com/api.github.com.2022-11-28.json index b8cd6053c..c44fbd712 100644 --- a/descriptions-next/api.github.com/api.github.com.2022-11-28.json +++ b/descriptions-next/api.github.com/api.github.com.2022-11-28.json @@ -118213,7 +118213,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -118292,7 +118293,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ diff --git a/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml b/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml index 0c8bb9e6d..c52e266b6 100644 --- a/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml +++ b/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml @@ -85739,6 +85739,7 @@ components: - single_select - multi_select - true_false + - url description: The type of the value for the property examples: - single_select @@ -85796,6 +85797,7 @@ components: - single_select - multi_select - true_false + - url description: The type of the value for the property examples: - single_select diff --git a/descriptions-next/api.github.com/api.github.com.json b/descriptions-next/api.github.com/api.github.com.json index b8cd6053c..c44fbd712 100644 --- a/descriptions-next/api.github.com/api.github.com.json +++ b/descriptions-next/api.github.com/api.github.com.json @@ -118213,7 +118213,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -118292,7 +118293,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ diff --git a/descriptions-next/api.github.com/api.github.com.yaml b/descriptions-next/api.github.com/api.github.com.yaml index 0c8bb9e6d..c52e266b6 100644 --- a/descriptions-next/api.github.com/api.github.com.yaml +++ b/descriptions-next/api.github.com/api.github.com.yaml @@ -85739,6 +85739,7 @@ components: - single_select - multi_select - true_false + - url description: The type of the value for the property examples: - single_select @@ -85796,6 +85797,7 @@ components: - single_select - multi_select - true_false + - url description: The type of the value for the property examples: - single_select diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json index 63b69927a..b702ed92a 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json @@ -198189,7 +198189,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -198417,7 +198418,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -198563,7 +198565,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -198797,7 +198800,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -198991,7 +198995,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -199111,7 +199116,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -853135,7 +853141,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -854222,7 +854229,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -854809,7 +854817,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml index f798fa1b6..8e63da24f 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml @@ -41039,6 +41039,7 @@ paths: - single_select - multi_select - true_false + - url description: The type of the value for the property examples: - single_select @@ -41264,6 +41265,7 @@ paths: - single_select - multi_select - true_false + - url description: The type of the value for the property examples: - single_select diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json index 63b69927a..b702ed92a 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json @@ -198189,7 +198189,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -198417,7 +198418,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -198563,7 +198565,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -198797,7 +198800,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -198991,7 +198995,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -199111,7 +199116,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -853135,7 +853141,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -854222,7 +854229,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -854809,7 +854817,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml index f798fa1b6..8e63da24f 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml @@ -41039,6 +41039,7 @@ paths: - single_select - multi_select - true_false + - url description: The type of the value for the property examples: - single_select @@ -41264,6 +41265,7 @@ paths: - single_select - multi_select - true_false + - url description: The type of the value for the property examples: - single_select diff --git a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json index b1bdba9c4..66f5159f5 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json +++ b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json @@ -53501,7 +53501,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -53738,7 +53739,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -53896,7 +53898,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -54169,7 +54172,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -54371,7 +54375,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property.", "examples": [ @@ -54493,7 +54498,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -55321,7 +55327,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -55549,7 +55556,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -55695,7 +55703,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -55938,7 +55947,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -56155,7 +56165,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -56349,7 +56360,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -56469,7 +56481,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -166735,17 +166748,17 @@ } } }, - "/orgs/{org}/credential-authorizations": { + "/orgs/{org}/copilot/metrics/reports/organization-1-day": { "get": { - "summary": "List SAML SSO authorizations for an organization", - "description": "Lists all credential authorizations for an organization that uses SAML single sign-on (SSO). The credentials are either personal access tokens or SSH keys that organization members have authorized for the organization. For more information, see [About authentication with SAML single sign-on](https://docs.github.com/enterprise-cloud@latest//articles/about-authentication-with-saml-single-sign-on).\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "summary": "Get Copilot organization usage metrics for a specific day", + "description": "Use this endpoint to retrieve download links for the Copilot organization usage metrics report for a specific day. The report provides comprehensive usage data for Copilot features across the organization.\n\nThe report contains aggregated metrics for the specified day, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.\n\nThe response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/enterprise-cloud@latest//copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).", "tags": [ - "orgs" + "copilot" ], - "operationId": "orgs/list-saml-sso-authorizations", + "operationId": "copilot/copilot-organization-one-day-usage-metrics", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-saml-sso-authorizations-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-organization-usage-metrics-for-a-specific-day" }, "parameters": [ { @@ -166758,28 +166771,16 @@ } }, { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "Page token", - "in": "query", - "schema": { - "type": "integer" - } - }, - { - "name": "login", - "description": "Limits the list of credentials authorizations for an organization to a specific login", + "name": "day", + "description": "The day to request data for, in `YYYY-MM-DD` format.", "in": "query", + "required": true, "schema": { - "type": "string" + "type": "string", + "format": "date", + "examples": [ + "2025-10-13" + ] } } ], @@ -166789,206 +166790,870 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Credential Authorization", - "description": "Credential Authorization", - "type": "object", - "properties": { - "login": { - "type": "string", - "description": "User login that owns the underlying credential.", - "examples": [ - "monalisa" - ] - }, - "credential_id": { - "type": "integer", - "description": "Unique identifier for the authorization of the credential. Use this to revoke authorization of the underlying token or key.", - "examples": [ - 1 - ] - }, - "credential_type": { - "type": "string", - "description": "Human-readable description of the credential type.", - "examples": [ - "SSH Key" - ] - }, - "token_last_eight": { - "type": "string", - "description": "Last eight characters of the credential. Only included in responses with credential_type of personal access token.", - "examples": [ - "12345678" - ] - }, - "credential_authorized_at": { - "type": "string", - "format": "date-time", - "description": "Date when the credential was authorized for use.", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "scopes": { - "type": "array", - "description": "List of oauth scopes the token has been granted.", - "items": { - "type": "string" - }, - "examples": [ - "user", - "repo" - ] - }, - "fingerprint": { + "type": "object", + "title": "Copilot Metrics 1 Day Report", + "description": "Links to download the Copilot usage metrics report for an enterprise/organization for a specific day.", + "properties": { + "download_links": { + "type": "array", + "items": { "type": "string", - "description": "Unique string to distinguish the credential. Only included in responses with credential_type of SSH Key.", - "examples": [ - "jklmnop12345678" - ] - }, - "credential_accessed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Date when the credential was last accessed. May be null if it was never accessed", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "authorized_credential_id": { - "type": [ - "integer", - "null" - ], - "description": "The ID of the underlying token that was authorized by the user. This will remain unchanged across authorizations of the token.", - "examples": [ - 12345678 - ] - }, - "authorized_credential_title": { - "type": [ - "string", - "null" - ], - "description": "The title given to the ssh key. This will only be present when the credential is an ssh key.", - "examples": [ - "my ssh key" - ] - }, - "authorized_credential_note": { - "type": [ - "string", - "null" - ], - "description": "The note given to the token. This will only be present when the credential is a token.", - "examples": [ - "my token" - ] + "format": "uri" }, - "authorized_credential_expires_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The expiry for the token. This will only be present when the credential is a token." - } + "description": "The URLs to download the Copilot usage metrics report for the enterprise/organization for the specified day." }, - "required": [ - "login", - "credential_id", - "credential_type", - "credential_authorized_at", - "credential_accessed_at", - "authorized_credential_id" - ] - } + "report_day": { + "type": "string", + "format": "date", + "description": "The day of the report in `YYYY-MM-DD` format." + } + }, + "required": [ + "download_links", + "report_day" + ] }, "examples": { "default": { - "value": [ - { - "login": "octocat", - "credential_id": 161195, - "credential_type": "personal access token", - "token_last_eight": "71c3fc11", - "credential_authorized_at": "2011-01-26T19:06:43Z", - "credential_accessed_at": "2011-01-26T19:06:43Z", - "authorized_credential_expires_at": "2011-02-25T19:06:43Z", - "scopes": [ - "user", - "repo" - ] - }, - { - "login": "hubot", - "credential_id": 161196, - "credential_type": "personal access token", - "token_last_eight": "Ae178B4a", - "credential_authorized_at": "2019-03-29T19:06:43Z", - "credential_accessed_at": "2011-01-26T19:06:43Z", - "authorized_credential_expires_at": "2019-04-28T19:06:43Z", - "scopes": [ - "repo" - ] - } - ] + "value": { + "download_links": [ + "https://example.com/copilot-usage-report-1.json", + "https://example.com/copilot-usage-report-2.json" + ], + "report_day": "2025-07-01" + } } } } } - } - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "orgs" - } - } - }, - "/orgs/{org}/credential-authorizations/{credential_id}": { - "delete": { - "summary": "Remove a SAML SSO authorization for an organization", - "description": "Removes a credential authorization for an organization that uses SAML SSO. Once you remove someone's credential authorization, they will need to create a new personal access token or SSH key and authorize it for the organization they want to access.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "orgs" - ], - "operationId": "orgs/remove-saml-sso-authorization", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#remove-a-saml-sso-authorization-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } }, - { - "name": "credential_id", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - }, - "404": { - "description": "Resource not found", + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-usage-metrics" + } + } + }, + "/orgs/{org}/copilot/metrics/reports/organization-28-day/latest": { + "get": { + "summary": "Get Copilot organization usage metrics", + "description": "Use this endpoint to retrieve download links for the latest 28-day organization Copilot usage metrics report. The report provides comprehensive usage data for Copilot features across the organization.\n\nThe report contains aggregated metrics for the previous 28 days, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.\n\nThe response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/enterprise-cloud@latest//copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-organization-usage-metrics", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-organization-usage-metrics" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "Copilot Metrics 28 Day Report", + "description": "Links to download the latest Copilot usage metrics report for an enterprise/organization.", + "properties": { + "download_links": { + "type": "array", + "items": { + "type": "string", + "format": "uri" + }, + "description": "The URLs to download the latest Copilot usage metrics report for the enterprise/organization." + }, + "report_start_day": { + "type": "string", + "format": "date", + "description": "The start date of the report period in `YYYY-MM-DD` format." + }, + "report_end_day": { + "type": "string", + "format": "date", + "description": "The end date of the report period in `YYYY-MM-DD` format." + } + }, + "required": [ + "download_links", + "report_start_day", + "report_end_day" + ] + }, + "examples": { + "default": { + "value": { + "download_links": [ + "https://example.com/copilot-usage-report-1.json", + "https://example.com/copilot-usage-report-2.json" + ], + "report_start_day": "2025-07-01", + "report_end_day": "2025-07-28" + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-usage-metrics" + } + } + }, + "/orgs/{org}/copilot/metrics/reports/users-1-day": { + "get": { + "summary": "Get Copilot organization users usage metrics for a specific day", + "description": "Use this endpoint to retrieve download links for the Copilot organization user usage metrics report for a specific day. The report provides detailed user-level usage data and engagement metrics for Copilot features across the organization.\n\nThe report contains user-specific metrics for the specified day, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.\n\nReports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/enterprise-cloud@latest//copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-organization-users-one-day-usage-metrics", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-organization-users-usage-metrics-for-a-specific-day" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "day", + "description": "The day to request data for, in `YYYY-MM-DD` format.", + "in": "query", + "required": true, + "schema": { + "type": "string", + "format": "date", + "examples": [ + "2025-10-13" + ] + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "Copilot Metrics 1 Day Report", + "description": "Links to download the Copilot usage metrics report for an enterprise/organization for a specific day.", + "properties": { + "download_links": { + "type": "array", + "items": { + "type": "string", + "format": "uri" + }, + "description": "The URLs to download the Copilot usage metrics report for the enterprise/organization for the specified day." + }, + "report_day": { + "type": "string", + "format": "date", + "description": "The day of the report in `YYYY-MM-DD` format." + } + }, + "required": [ + "download_links", + "report_day" + ] + }, + "examples": { + "default": { + "value": { + "download_links": [ + "https://example.com/copilot-usage-report-1.json", + "https://example.com/copilot-usage-report-2.json" + ], + "report_day": "2025-07-01" + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-usage-metrics" + } + } + }, + "/orgs/{org}/copilot/metrics/reports/users-28-day/latest": { + "get": { + "summary": "Get Copilot organization users usage metrics", + "description": "Use this endpoint to retrieve download links for the latest 28-day organization users Copilot usage metrics report. The report provides detailed user-level usage data and engagement metrics for Copilot features across the organization.\n\nThe report contains user-specific metrics for the previous 28 days, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.\n\nReports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/enterprise-cloud@latest//copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-organization-users-usage-metrics", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-organization-users-usage-metrics" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "Copilot Metrics 28 Day Report", + "description": "Links to download the latest Copilot usage metrics report for an enterprise/organization.", + "properties": { + "download_links": { + "type": "array", + "items": { + "type": "string", + "format": "uri" + }, + "description": "The URLs to download the latest Copilot usage metrics report for the enterprise/organization." + }, + "report_start_day": { + "type": "string", + "format": "date", + "description": "The start date of the report period in `YYYY-MM-DD` format." + }, + "report_end_day": { + "type": "string", + "format": "date", + "description": "The end date of the report period in `YYYY-MM-DD` format." + } + }, + "required": [ + "download_links", + "report_start_day", + "report_end_day" + ] + }, + "examples": { + "default": { + "value": { + "download_links": [ + "https://example.com/copilot-usage-report-1.json", + "https://example.com/copilot-usage-report-2.json" + ], + "report_start_day": "2025-07-01", + "report_end_day": "2025-07-28" + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-usage-metrics" + } + } + }, + "/orgs/{org}/credential-authorizations": { + "get": { + "summary": "List SAML SSO authorizations for an organization", + "description": "Lists all credential authorizations for an organization that uses SAML single sign-on (SSO). The credentials are either personal access tokens or SSH keys that organization members have authorized for the organization. For more information, see [About authentication with SAML single sign-on](https://docs.github.com/enterprise-cloud@latest//articles/about-authentication-with-saml-single-sign-on).\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-saml-sso-authorizations", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-saml-sso-authorizations-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "Page token", + "in": "query", + "schema": { + "type": "integer" + } + }, + { + "name": "login", + "description": "Limits the list of credentials authorizations for an organization to a specific login", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Credential Authorization", + "description": "Credential Authorization", + "type": "object", + "properties": { + "login": { + "type": "string", + "description": "User login that owns the underlying credential.", + "examples": [ + "monalisa" + ] + }, + "credential_id": { + "type": "integer", + "description": "Unique identifier for the authorization of the credential. Use this to revoke authorization of the underlying token or key.", + "examples": [ + 1 + ] + }, + "credential_type": { + "type": "string", + "description": "Human-readable description of the credential type.", + "examples": [ + "SSH Key" + ] + }, + "token_last_eight": { + "type": "string", + "description": "Last eight characters of the credential. Only included in responses with credential_type of personal access token.", + "examples": [ + "12345678" + ] + }, + "credential_authorized_at": { + "type": "string", + "format": "date-time", + "description": "Date when the credential was authorized for use.", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "scopes": { + "type": "array", + "description": "List of oauth scopes the token has been granted.", + "items": { + "type": "string" + }, + "examples": [ + "user", + "repo" + ] + }, + "fingerprint": { + "type": "string", + "description": "Unique string to distinguish the credential. Only included in responses with credential_type of SSH Key.", + "examples": [ + "jklmnop12345678" + ] + }, + "credential_accessed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Date when the credential was last accessed. May be null if it was never accessed", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "authorized_credential_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the underlying token that was authorized by the user. This will remain unchanged across authorizations of the token.", + "examples": [ + 12345678 + ] + }, + "authorized_credential_title": { + "type": [ + "string", + "null" + ], + "description": "The title given to the ssh key. This will only be present when the credential is an ssh key.", + "examples": [ + "my ssh key" + ] + }, + "authorized_credential_note": { + "type": [ + "string", + "null" + ], + "description": "The note given to the token. This will only be present when the credential is a token.", + "examples": [ + "my token" + ] + }, + "authorized_credential_expires_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The expiry for the token. This will only be present when the credential is a token." + } + }, + "required": [ + "login", + "credential_id", + "credential_type", + "credential_authorized_at", + "credential_accessed_at", + "authorized_credential_id" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "login": "octocat", + "credential_id": 161195, + "credential_type": "personal access token", + "token_last_eight": "71c3fc11", + "credential_authorized_at": "2011-01-26T19:06:43Z", + "credential_accessed_at": "2011-01-26T19:06:43Z", + "authorized_credential_expires_at": "2011-02-25T19:06:43Z", + "scopes": [ + "user", + "repo" + ] + }, + { + "login": "hubot", + "credential_id": 161196, + "credential_type": "personal access token", + "token_last_eight": "Ae178B4a", + "credential_authorized_at": "2019-03-29T19:06:43Z", + "credential_accessed_at": "2011-01-26T19:06:43Z", + "authorized_credential_expires_at": "2019-04-28T19:06:43Z", + "scopes": [ + "repo" + ] + } + ] + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, + "/orgs/{org}/credential-authorizations/{credential_id}": { + "delete": { + "summary": "Remove a SAML SSO authorization for an organization", + "description": "Removes a credential authorization for an organization that uses SAML SSO. Once you remove someone's credential authorization, they will need to create a new personal access token or SSH key and authorize it for the organization they want to access.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/remove-saml-sso-authorization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#remove-a-saml-sso-authorization-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "credential_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -252535,7 +253200,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -252763,7 +253429,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -252909,7 +253576,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -253143,7 +253811,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -253337,7 +254006,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -253457,7 +254127,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -938606,7 +939277,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -939693,7 +940365,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -940280,7 +940953,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -1269451,7 +1270125,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -1270322,7 +1270997,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ diff --git a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml index 8b061d9cf..3e72060a0 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml +++ b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml @@ -19355,6 +19355,7 @@ paths: - single_select - multi_select - true_false + - url description: The type of the value for the property examples: - single_select @@ -19594,6 +19595,7 @@ paths: - single_select - multi_select - true_false + - url description: The type of the value for the property. examples: - single_select @@ -19898,6 +19900,7 @@ paths: - single_select - multi_select - true_false + - url description: The type of the value for the property examples: - single_select @@ -20145,6 +20148,7 @@ paths: - single_select - multi_select - true_false + - url description: The type of the value for the property examples: - single_select @@ -43246,6 +43250,156 @@ paths: enabledForGitHubApps: true category: copilot subcategory: copilot-metrics + "/orgs/{org}/copilot/metrics/reports/organization-1-day": + get: + summary: Get Copilot organization usage metrics for a specific day + description: |- + Use this endpoint to retrieve download links for the Copilot organization usage metrics report for a specific day. The report provides comprehensive usage data for Copilot features across the organization. + + The report contains aggregated metrics for the specified day, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time. + + The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed. + + Organization owners and authorized users with fine-grained "View Organization Copilot Metrics" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + For more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/enterprise-cloud@latest//copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations). + tags: + - copilot + operationId: copilot/copilot-organization-one-day-usage-metrics + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-organization-usage-metrics-for-a-specific-day + parameters: + - *85 + - *118 + responses: + '200': + description: Response + content: + application/json: + schema: *119 + examples: + default: *120 + '500': *38 + '403': *27 + '404': *6 + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: copilot + subcategory: copilot-usage-metrics + "/orgs/{org}/copilot/metrics/reports/organization-28-day/latest": + get: + summary: Get Copilot organization usage metrics + description: |- + Use this endpoint to retrieve download links for the latest 28-day organization Copilot usage metrics report. The report provides comprehensive usage data for Copilot features across the organization. + + The report contains aggregated metrics for the previous 28 days, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time. + + The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed. + + Organization owners and authorized users with fine-grained "View Organization Copilot Metrics" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + For more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/enterprise-cloud@latest//copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations). + tags: + - copilot + operationId: copilot/copilot-organization-usage-metrics + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-organization-usage-metrics + parameters: + - *85 + responses: + '200': + description: Response + content: + application/json: + schema: *121 + examples: + default: *122 + '500': *38 + '403': *27 + '404': *6 + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: copilot + subcategory: copilot-usage-metrics + "/orgs/{org}/copilot/metrics/reports/users-1-day": + get: + summary: Get Copilot organization users usage metrics for a specific day + description: |- + Use this endpoint to retrieve download links for the Copilot organization user usage metrics report for a specific day. The report provides detailed user-level usage data and engagement metrics for Copilot features across the organization. + + The report contains user-specific metrics for the specified day, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement. + + Reports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed. + + Organization owners and authorized users with fine-grained "View Organization Copilot Metrics" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + For more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/enterprise-cloud@latest//copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations). + tags: + - copilot + operationId: copilot/copilot-organization-users-one-day-usage-metrics + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-organization-users-usage-metrics-for-a-specific-day + parameters: + - *85 + - *118 + responses: + '200': + description: Response + content: + application/json: + schema: *119 + examples: + default: *120 + '500': *38 + '403': *27 + '404': *6 + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: copilot + subcategory: copilot-usage-metrics + "/orgs/{org}/copilot/metrics/reports/users-28-day/latest": + get: + summary: Get Copilot organization users usage metrics + description: |- + Use this endpoint to retrieve download links for the latest 28-day organization users Copilot usage metrics report. The report provides detailed user-level usage data and engagement metrics for Copilot features across the organization. + + The report contains user-specific metrics for the previous 28 days, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement. + + Reports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed. + + Organization owners and authorized users with fine-grained "View Organization Copilot Metrics" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + For more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/enterprise-cloud@latest//copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations). + tags: + - copilot + operationId: copilot/copilot-organization-users-usage-metrics + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-organization-users-usage-metrics + parameters: + - *85 + responses: + '200': + description: Response + content: + application/json: + schema: *121 + examples: + default: *122 + '500': *38 + '403': *27 + '404': *6 + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: copilot + subcategory: copilot-usage-metrics "/orgs/{org}/credential-authorizations": get: summary: List SAML SSO authorizations for an organization diff --git a/descriptions-next/ghec/dereferenced/ghec.deref.json b/descriptions-next/ghec/dereferenced/ghec.deref.json index b1bdba9c4..66f5159f5 100644 --- a/descriptions-next/ghec/dereferenced/ghec.deref.json +++ b/descriptions-next/ghec/dereferenced/ghec.deref.json @@ -53501,7 +53501,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -53738,7 +53739,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -53896,7 +53898,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -54169,7 +54172,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -54371,7 +54375,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property.", "examples": [ @@ -54493,7 +54498,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -55321,7 +55327,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -55549,7 +55556,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -55695,7 +55703,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -55938,7 +55947,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -56155,7 +56165,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -56349,7 +56360,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -56469,7 +56481,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -166735,17 +166748,17 @@ } } }, - "/orgs/{org}/credential-authorizations": { + "/orgs/{org}/copilot/metrics/reports/organization-1-day": { "get": { - "summary": "List SAML SSO authorizations for an organization", - "description": "Lists all credential authorizations for an organization that uses SAML single sign-on (SSO). The credentials are either personal access tokens or SSH keys that organization members have authorized for the organization. For more information, see [About authentication with SAML single sign-on](https://docs.github.com/enterprise-cloud@latest//articles/about-authentication-with-saml-single-sign-on).\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "summary": "Get Copilot organization usage metrics for a specific day", + "description": "Use this endpoint to retrieve download links for the Copilot organization usage metrics report for a specific day. The report provides comprehensive usage data for Copilot features across the organization.\n\nThe report contains aggregated metrics for the specified day, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.\n\nThe response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/enterprise-cloud@latest//copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).", "tags": [ - "orgs" + "copilot" ], - "operationId": "orgs/list-saml-sso-authorizations", + "operationId": "copilot/copilot-organization-one-day-usage-metrics", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-saml-sso-authorizations-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-organization-usage-metrics-for-a-specific-day" }, "parameters": [ { @@ -166758,28 +166771,16 @@ } }, { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "Page token", - "in": "query", - "schema": { - "type": "integer" - } - }, - { - "name": "login", - "description": "Limits the list of credentials authorizations for an organization to a specific login", + "name": "day", + "description": "The day to request data for, in `YYYY-MM-DD` format.", "in": "query", + "required": true, "schema": { - "type": "string" + "type": "string", + "format": "date", + "examples": [ + "2025-10-13" + ] } } ], @@ -166789,206 +166790,870 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Credential Authorization", - "description": "Credential Authorization", - "type": "object", - "properties": { - "login": { - "type": "string", - "description": "User login that owns the underlying credential.", - "examples": [ - "monalisa" - ] - }, - "credential_id": { - "type": "integer", - "description": "Unique identifier for the authorization of the credential. Use this to revoke authorization of the underlying token or key.", - "examples": [ - 1 - ] - }, - "credential_type": { - "type": "string", - "description": "Human-readable description of the credential type.", - "examples": [ - "SSH Key" - ] - }, - "token_last_eight": { - "type": "string", - "description": "Last eight characters of the credential. Only included in responses with credential_type of personal access token.", - "examples": [ - "12345678" - ] - }, - "credential_authorized_at": { - "type": "string", - "format": "date-time", - "description": "Date when the credential was authorized for use.", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "scopes": { - "type": "array", - "description": "List of oauth scopes the token has been granted.", - "items": { - "type": "string" - }, - "examples": [ - "user", - "repo" - ] - }, - "fingerprint": { + "type": "object", + "title": "Copilot Metrics 1 Day Report", + "description": "Links to download the Copilot usage metrics report for an enterprise/organization for a specific day.", + "properties": { + "download_links": { + "type": "array", + "items": { "type": "string", - "description": "Unique string to distinguish the credential. Only included in responses with credential_type of SSH Key.", - "examples": [ - "jklmnop12345678" - ] - }, - "credential_accessed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Date when the credential was last accessed. May be null if it was never accessed", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "authorized_credential_id": { - "type": [ - "integer", - "null" - ], - "description": "The ID of the underlying token that was authorized by the user. This will remain unchanged across authorizations of the token.", - "examples": [ - 12345678 - ] - }, - "authorized_credential_title": { - "type": [ - "string", - "null" - ], - "description": "The title given to the ssh key. This will only be present when the credential is an ssh key.", - "examples": [ - "my ssh key" - ] - }, - "authorized_credential_note": { - "type": [ - "string", - "null" - ], - "description": "The note given to the token. This will only be present when the credential is a token.", - "examples": [ - "my token" - ] + "format": "uri" }, - "authorized_credential_expires_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The expiry for the token. This will only be present when the credential is a token." - } + "description": "The URLs to download the Copilot usage metrics report for the enterprise/organization for the specified day." }, - "required": [ - "login", - "credential_id", - "credential_type", - "credential_authorized_at", - "credential_accessed_at", - "authorized_credential_id" - ] - } + "report_day": { + "type": "string", + "format": "date", + "description": "The day of the report in `YYYY-MM-DD` format." + } + }, + "required": [ + "download_links", + "report_day" + ] }, "examples": { "default": { - "value": [ - { - "login": "octocat", - "credential_id": 161195, - "credential_type": "personal access token", - "token_last_eight": "71c3fc11", - "credential_authorized_at": "2011-01-26T19:06:43Z", - "credential_accessed_at": "2011-01-26T19:06:43Z", - "authorized_credential_expires_at": "2011-02-25T19:06:43Z", - "scopes": [ - "user", - "repo" - ] - }, - { - "login": "hubot", - "credential_id": 161196, - "credential_type": "personal access token", - "token_last_eight": "Ae178B4a", - "credential_authorized_at": "2019-03-29T19:06:43Z", - "credential_accessed_at": "2011-01-26T19:06:43Z", - "authorized_credential_expires_at": "2019-04-28T19:06:43Z", - "scopes": [ - "repo" - ] - } - ] + "value": { + "download_links": [ + "https://example.com/copilot-usage-report-1.json", + "https://example.com/copilot-usage-report-2.json" + ], + "report_day": "2025-07-01" + } } } } } - } - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "orgs" - } - } - }, - "/orgs/{org}/credential-authorizations/{credential_id}": { - "delete": { - "summary": "Remove a SAML SSO authorization for an organization", - "description": "Removes a credential authorization for an organization that uses SAML SSO. Once you remove someone's credential authorization, they will need to create a new personal access token or SSH key and authorize it for the organization they want to access.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "orgs" - ], - "operationId": "orgs/remove-saml-sso-authorization", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#remove-a-saml-sso-authorization-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } }, - { - "name": "credential_id", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - }, - "404": { - "description": "Resource not found", + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-usage-metrics" + } + } + }, + "/orgs/{org}/copilot/metrics/reports/organization-28-day/latest": { + "get": { + "summary": "Get Copilot organization usage metrics", + "description": "Use this endpoint to retrieve download links for the latest 28-day organization Copilot usage metrics report. The report provides comprehensive usage data for Copilot features across the organization.\n\nThe report contains aggregated metrics for the previous 28 days, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.\n\nThe response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/enterprise-cloud@latest//copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-organization-usage-metrics", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-organization-usage-metrics" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "Copilot Metrics 28 Day Report", + "description": "Links to download the latest Copilot usage metrics report for an enterprise/organization.", + "properties": { + "download_links": { + "type": "array", + "items": { + "type": "string", + "format": "uri" + }, + "description": "The URLs to download the latest Copilot usage metrics report for the enterprise/organization." + }, + "report_start_day": { + "type": "string", + "format": "date", + "description": "The start date of the report period in `YYYY-MM-DD` format." + }, + "report_end_day": { + "type": "string", + "format": "date", + "description": "The end date of the report period in `YYYY-MM-DD` format." + } + }, + "required": [ + "download_links", + "report_start_day", + "report_end_day" + ] + }, + "examples": { + "default": { + "value": { + "download_links": [ + "https://example.com/copilot-usage-report-1.json", + "https://example.com/copilot-usage-report-2.json" + ], + "report_start_day": "2025-07-01", + "report_end_day": "2025-07-28" + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-usage-metrics" + } + } + }, + "/orgs/{org}/copilot/metrics/reports/users-1-day": { + "get": { + "summary": "Get Copilot organization users usage metrics for a specific day", + "description": "Use this endpoint to retrieve download links for the Copilot organization user usage metrics report for a specific day. The report provides detailed user-level usage data and engagement metrics for Copilot features across the organization.\n\nThe report contains user-specific metrics for the specified day, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.\n\nReports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/enterprise-cloud@latest//copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-organization-users-one-day-usage-metrics", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-organization-users-usage-metrics-for-a-specific-day" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "day", + "description": "The day to request data for, in `YYYY-MM-DD` format.", + "in": "query", + "required": true, + "schema": { + "type": "string", + "format": "date", + "examples": [ + "2025-10-13" + ] + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "Copilot Metrics 1 Day Report", + "description": "Links to download the Copilot usage metrics report for an enterprise/organization for a specific day.", + "properties": { + "download_links": { + "type": "array", + "items": { + "type": "string", + "format": "uri" + }, + "description": "The URLs to download the Copilot usage metrics report for the enterprise/organization for the specified day." + }, + "report_day": { + "type": "string", + "format": "date", + "description": "The day of the report in `YYYY-MM-DD` format." + } + }, + "required": [ + "download_links", + "report_day" + ] + }, + "examples": { + "default": { + "value": { + "download_links": [ + "https://example.com/copilot-usage-report-1.json", + "https://example.com/copilot-usage-report-2.json" + ], + "report_day": "2025-07-01" + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-usage-metrics" + } + } + }, + "/orgs/{org}/copilot/metrics/reports/users-28-day/latest": { + "get": { + "summary": "Get Copilot organization users usage metrics", + "description": "Use this endpoint to retrieve download links for the latest 28-day organization users Copilot usage metrics report. The report provides detailed user-level usage data and engagement metrics for Copilot features across the organization.\n\nThe report contains user-specific metrics for the previous 28 days, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.\n\nReports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/enterprise-cloud@latest//copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-organization-users-usage-metrics", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-organization-users-usage-metrics" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "Copilot Metrics 28 Day Report", + "description": "Links to download the latest Copilot usage metrics report for an enterprise/organization.", + "properties": { + "download_links": { + "type": "array", + "items": { + "type": "string", + "format": "uri" + }, + "description": "The URLs to download the latest Copilot usage metrics report for the enterprise/organization." + }, + "report_start_day": { + "type": "string", + "format": "date", + "description": "The start date of the report period in `YYYY-MM-DD` format." + }, + "report_end_day": { + "type": "string", + "format": "date", + "description": "The end date of the report period in `YYYY-MM-DD` format." + } + }, + "required": [ + "download_links", + "report_start_day", + "report_end_day" + ] + }, + "examples": { + "default": { + "value": { + "download_links": [ + "https://example.com/copilot-usage-report-1.json", + "https://example.com/copilot-usage-report-2.json" + ], + "report_start_day": "2025-07-01", + "report_end_day": "2025-07-28" + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-usage-metrics" + } + } + }, + "/orgs/{org}/credential-authorizations": { + "get": { + "summary": "List SAML SSO authorizations for an organization", + "description": "Lists all credential authorizations for an organization that uses SAML single sign-on (SSO). The credentials are either personal access tokens or SSH keys that organization members have authorized for the organization. For more information, see [About authentication with SAML single sign-on](https://docs.github.com/enterprise-cloud@latest//articles/about-authentication-with-saml-single-sign-on).\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-saml-sso-authorizations", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-saml-sso-authorizations-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "Page token", + "in": "query", + "schema": { + "type": "integer" + } + }, + { + "name": "login", + "description": "Limits the list of credentials authorizations for an organization to a specific login", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Credential Authorization", + "description": "Credential Authorization", + "type": "object", + "properties": { + "login": { + "type": "string", + "description": "User login that owns the underlying credential.", + "examples": [ + "monalisa" + ] + }, + "credential_id": { + "type": "integer", + "description": "Unique identifier for the authorization of the credential. Use this to revoke authorization of the underlying token or key.", + "examples": [ + 1 + ] + }, + "credential_type": { + "type": "string", + "description": "Human-readable description of the credential type.", + "examples": [ + "SSH Key" + ] + }, + "token_last_eight": { + "type": "string", + "description": "Last eight characters of the credential. Only included in responses with credential_type of personal access token.", + "examples": [ + "12345678" + ] + }, + "credential_authorized_at": { + "type": "string", + "format": "date-time", + "description": "Date when the credential was authorized for use.", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "scopes": { + "type": "array", + "description": "List of oauth scopes the token has been granted.", + "items": { + "type": "string" + }, + "examples": [ + "user", + "repo" + ] + }, + "fingerprint": { + "type": "string", + "description": "Unique string to distinguish the credential. Only included in responses with credential_type of SSH Key.", + "examples": [ + "jklmnop12345678" + ] + }, + "credential_accessed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Date when the credential was last accessed. May be null if it was never accessed", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "authorized_credential_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the underlying token that was authorized by the user. This will remain unchanged across authorizations of the token.", + "examples": [ + 12345678 + ] + }, + "authorized_credential_title": { + "type": [ + "string", + "null" + ], + "description": "The title given to the ssh key. This will only be present when the credential is an ssh key.", + "examples": [ + "my ssh key" + ] + }, + "authorized_credential_note": { + "type": [ + "string", + "null" + ], + "description": "The note given to the token. This will only be present when the credential is a token.", + "examples": [ + "my token" + ] + }, + "authorized_credential_expires_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The expiry for the token. This will only be present when the credential is a token." + } + }, + "required": [ + "login", + "credential_id", + "credential_type", + "credential_authorized_at", + "credential_accessed_at", + "authorized_credential_id" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "login": "octocat", + "credential_id": 161195, + "credential_type": "personal access token", + "token_last_eight": "71c3fc11", + "credential_authorized_at": "2011-01-26T19:06:43Z", + "credential_accessed_at": "2011-01-26T19:06:43Z", + "authorized_credential_expires_at": "2011-02-25T19:06:43Z", + "scopes": [ + "user", + "repo" + ] + }, + { + "login": "hubot", + "credential_id": 161196, + "credential_type": "personal access token", + "token_last_eight": "Ae178B4a", + "credential_authorized_at": "2019-03-29T19:06:43Z", + "credential_accessed_at": "2011-01-26T19:06:43Z", + "authorized_credential_expires_at": "2019-04-28T19:06:43Z", + "scopes": [ + "repo" + ] + } + ] + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, + "/orgs/{org}/credential-authorizations/{credential_id}": { + "delete": { + "summary": "Remove a SAML SSO authorization for an organization", + "description": "Removes a credential authorization for an organization that uses SAML SSO. Once you remove someone's credential authorization, they will need to create a new personal access token or SSH key and authorize it for the organization they want to access.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/remove-saml-sso-authorization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#remove-a-saml-sso-authorization-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "credential_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -252535,7 +253200,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -252763,7 +253429,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -252909,7 +253576,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -253143,7 +253811,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -253337,7 +254006,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -253457,7 +254127,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -938606,7 +939277,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -939693,7 +940365,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -940280,7 +940953,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -1269451,7 +1270125,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -1270322,7 +1270997,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ diff --git a/descriptions-next/ghec/dereferenced/ghec.deref.yaml b/descriptions-next/ghec/dereferenced/ghec.deref.yaml index 8b061d9cf..3e72060a0 100644 --- a/descriptions-next/ghec/dereferenced/ghec.deref.yaml +++ b/descriptions-next/ghec/dereferenced/ghec.deref.yaml @@ -19355,6 +19355,7 @@ paths: - single_select - multi_select - true_false + - url description: The type of the value for the property examples: - single_select @@ -19594,6 +19595,7 @@ paths: - single_select - multi_select - true_false + - url description: The type of the value for the property. examples: - single_select @@ -19898,6 +19900,7 @@ paths: - single_select - multi_select - true_false + - url description: The type of the value for the property examples: - single_select @@ -20145,6 +20148,7 @@ paths: - single_select - multi_select - true_false + - url description: The type of the value for the property examples: - single_select @@ -43246,6 +43250,156 @@ paths: enabledForGitHubApps: true category: copilot subcategory: copilot-metrics + "/orgs/{org}/copilot/metrics/reports/organization-1-day": + get: + summary: Get Copilot organization usage metrics for a specific day + description: |- + Use this endpoint to retrieve download links for the Copilot organization usage metrics report for a specific day. The report provides comprehensive usage data for Copilot features across the organization. + + The report contains aggregated metrics for the specified day, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time. + + The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed. + + Organization owners and authorized users with fine-grained "View Organization Copilot Metrics" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + For more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/enterprise-cloud@latest//copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations). + tags: + - copilot + operationId: copilot/copilot-organization-one-day-usage-metrics + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-organization-usage-metrics-for-a-specific-day + parameters: + - *85 + - *118 + responses: + '200': + description: Response + content: + application/json: + schema: *119 + examples: + default: *120 + '500': *38 + '403': *27 + '404': *6 + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: copilot + subcategory: copilot-usage-metrics + "/orgs/{org}/copilot/metrics/reports/organization-28-day/latest": + get: + summary: Get Copilot organization usage metrics + description: |- + Use this endpoint to retrieve download links for the latest 28-day organization Copilot usage metrics report. The report provides comprehensive usage data for Copilot features across the organization. + + The report contains aggregated metrics for the previous 28 days, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time. + + The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed. + + Organization owners and authorized users with fine-grained "View Organization Copilot Metrics" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + For more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/enterprise-cloud@latest//copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations). + tags: + - copilot + operationId: copilot/copilot-organization-usage-metrics + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-organization-usage-metrics + parameters: + - *85 + responses: + '200': + description: Response + content: + application/json: + schema: *121 + examples: + default: *122 + '500': *38 + '403': *27 + '404': *6 + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: copilot + subcategory: copilot-usage-metrics + "/orgs/{org}/copilot/metrics/reports/users-1-day": + get: + summary: Get Copilot organization users usage metrics for a specific day + description: |- + Use this endpoint to retrieve download links for the Copilot organization user usage metrics report for a specific day. The report provides detailed user-level usage data and engagement metrics for Copilot features across the organization. + + The report contains user-specific metrics for the specified day, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement. + + Reports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed. + + Organization owners and authorized users with fine-grained "View Organization Copilot Metrics" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + For more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/enterprise-cloud@latest//copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations). + tags: + - copilot + operationId: copilot/copilot-organization-users-one-day-usage-metrics + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-organization-users-usage-metrics-for-a-specific-day + parameters: + - *85 + - *118 + responses: + '200': + description: Response + content: + application/json: + schema: *119 + examples: + default: *120 + '500': *38 + '403': *27 + '404': *6 + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: copilot + subcategory: copilot-usage-metrics + "/orgs/{org}/copilot/metrics/reports/users-28-day/latest": + get: + summary: Get Copilot organization users usage metrics + description: |- + Use this endpoint to retrieve download links for the latest 28-day organization users Copilot usage metrics report. The report provides detailed user-level usage data and engagement metrics for Copilot features across the organization. + + The report contains user-specific metrics for the previous 28 days, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement. + + Reports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed. + + Organization owners and authorized users with fine-grained "View Organization Copilot Metrics" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + For more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/enterprise-cloud@latest//copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations). + tags: + - copilot + operationId: copilot/copilot-organization-users-usage-metrics + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-organization-users-usage-metrics + parameters: + - *85 + responses: + '200': + description: Response + content: + application/json: + schema: *121 + examples: + default: *122 + '500': *38 + '403': *27 + '404': *6 + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: copilot + subcategory: copilot-usage-metrics "/orgs/{org}/credential-authorizations": get: summary: List SAML SSO authorizations for an organization diff --git a/descriptions-next/ghec/ghec.2022-11-28.json b/descriptions-next/ghec/ghec.2022-11-28.json index 6230349b8..7cf250cc8 100644 --- a/descriptions-next/ghec/ghec.2022-11-28.json +++ b/descriptions-next/ghec/ghec.2022-11-28.json @@ -28415,6 +28415,216 @@ } } }, + "/orgs/{org}/copilot/metrics/reports/organization-1-day": { + "get": { + "summary": "Get Copilot organization usage metrics for a specific day", + "description": "Use this endpoint to retrieve download links for the Copilot organization usage metrics report for a specific day. The report provides comprehensive usage data for Copilot features across the organization.\n\nThe report contains aggregated metrics for the specified day, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.\n\nThe response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/enterprise-cloud@latest//copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-organization-one-day-usage-metrics", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-organization-usage-metrics-for-a-specific-day" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/day" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-usage-metrics-1-day-report" + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-usage-metrics-1-day-report" + } + } + } + } + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-usage-metrics" + } + } + }, + "/orgs/{org}/copilot/metrics/reports/organization-28-day/latest": { + "get": { + "summary": "Get Copilot organization usage metrics", + "description": "Use this endpoint to retrieve download links for the latest 28-day organization Copilot usage metrics report. The report provides comprehensive usage data for Copilot features across the organization.\n\nThe report contains aggregated metrics for the previous 28 days, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.\n\nThe response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/enterprise-cloud@latest//copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-organization-usage-metrics", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-organization-usage-metrics" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-usage-metrics-28-day-report" + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-usage-metrics-28-day-report" + } + } + } + } + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-usage-metrics" + } + } + }, + "/orgs/{org}/copilot/metrics/reports/users-1-day": { + "get": { + "summary": "Get Copilot organization users usage metrics for a specific day", + "description": "Use this endpoint to retrieve download links for the Copilot organization user usage metrics report for a specific day. The report provides detailed user-level usage data and engagement metrics for Copilot features across the organization.\n\nThe report contains user-specific metrics for the specified day, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.\n\nReports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/enterprise-cloud@latest//copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-organization-users-one-day-usage-metrics", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-organization-users-usage-metrics-for-a-specific-day" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/day" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-usage-metrics-1-day-report" + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-usage-metrics-1-day-report" + } + } + } + } + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-usage-metrics" + } + } + }, + "/orgs/{org}/copilot/metrics/reports/users-28-day/latest": { + "get": { + "summary": "Get Copilot organization users usage metrics", + "description": "Use this endpoint to retrieve download links for the latest 28-day organization users Copilot usage metrics report. The report provides detailed user-level usage data and engagement metrics for Copilot features across the organization.\n\nThe report contains user-specific metrics for the previous 28 days, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.\n\nReports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/enterprise-cloud@latest//copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-organization-users-usage-metrics", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-organization-users-usage-metrics" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-usage-metrics-28-day-report" + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-usage-metrics-28-day-report" + } + } + } + } + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-usage-metrics" + } + } + }, "/orgs/{org}/credential-authorizations": { "get": { "summary": "List SAML SSO authorizations for an organization", @@ -127912,7 +128122,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -128005,7 +128216,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property.", "examples": [ @@ -128168,7 +128380,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -128247,7 +128460,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ diff --git a/descriptions-next/ghec/ghec.2022-11-28.yaml b/descriptions-next/ghec/ghec.2022-11-28.yaml index d10c1dc86..4a87526d0 100644 --- a/descriptions-next/ghec/ghec.2022-11-28.yaml +++ b/descriptions-next/ghec/ghec.2022-11-28.yaml @@ -20531,6 +20531,176 @@ paths: enabledForGitHubApps: true category: copilot subcategory: copilot-metrics + "/orgs/{org}/copilot/metrics/reports/organization-1-day": + get: + summary: Get Copilot organization usage metrics for a specific day + description: |- + Use this endpoint to retrieve download links for the Copilot organization usage metrics report for a specific day. The report provides comprehensive usage data for Copilot features across the organization. + + The report contains aggregated metrics for the specified day, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time. + + The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed. + + Organization owners and authorized users with fine-grained "View Organization Copilot Metrics" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + For more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/enterprise-cloud@latest//copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations). + tags: + - copilot + operationId: copilot/copilot-organization-one-day-usage-metrics + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-organization-usage-metrics-for-a-specific-day + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/day" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-usage-metrics-1-day-report" + examples: + default: + "$ref": "#/components/examples/copilot-usage-metrics-1-day-report" + '500': + "$ref": "#/components/responses/internal_error" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: copilot + subcategory: copilot-usage-metrics + "/orgs/{org}/copilot/metrics/reports/organization-28-day/latest": + get: + summary: Get Copilot organization usage metrics + description: |- + Use this endpoint to retrieve download links for the latest 28-day organization Copilot usage metrics report. The report provides comprehensive usage data for Copilot features across the organization. + + The report contains aggregated metrics for the previous 28 days, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time. + + The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed. + + Organization owners and authorized users with fine-grained "View Organization Copilot Metrics" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + For more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/enterprise-cloud@latest//copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations). + tags: + - copilot + operationId: copilot/copilot-organization-usage-metrics + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-organization-usage-metrics + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-usage-metrics-28-day-report" + examples: + default: + "$ref": "#/components/examples/copilot-usage-metrics-28-day-report" + '500': + "$ref": "#/components/responses/internal_error" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: copilot + subcategory: copilot-usage-metrics + "/orgs/{org}/copilot/metrics/reports/users-1-day": + get: + summary: Get Copilot organization users usage metrics for a specific day + description: |- + Use this endpoint to retrieve download links for the Copilot organization user usage metrics report for a specific day. The report provides detailed user-level usage data and engagement metrics for Copilot features across the organization. + + The report contains user-specific metrics for the specified day, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement. + + Reports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed. + + Organization owners and authorized users with fine-grained "View Organization Copilot Metrics" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + For more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/enterprise-cloud@latest//copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations). + tags: + - copilot + operationId: copilot/copilot-organization-users-one-day-usage-metrics + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-organization-users-usage-metrics-for-a-specific-day + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/day" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-usage-metrics-1-day-report" + examples: + default: + "$ref": "#/components/examples/copilot-usage-metrics-1-day-report" + '500': + "$ref": "#/components/responses/internal_error" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: copilot + subcategory: copilot-usage-metrics + "/orgs/{org}/copilot/metrics/reports/users-28-day/latest": + get: + summary: Get Copilot organization users usage metrics + description: |- + Use this endpoint to retrieve download links for the latest 28-day organization users Copilot usage metrics report. The report provides detailed user-level usage data and engagement metrics for Copilot features across the organization. + + The report contains user-specific metrics for the previous 28 days, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement. + + Reports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed. + + Organization owners and authorized users with fine-grained "View Organization Copilot Metrics" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + For more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/enterprise-cloud@latest//copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations). + tags: + - copilot + operationId: copilot/copilot-organization-users-usage-metrics + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-organization-users-usage-metrics + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-usage-metrics-28-day-report" + examples: + default: + "$ref": "#/components/examples/copilot-usage-metrics-28-day-report" + '500': + "$ref": "#/components/responses/internal_error" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: copilot + subcategory: copilot-usage-metrics "/orgs/{org}/credential-authorizations": get: summary: List SAML SSO authorizations for an organization @@ -92499,6 +92669,7 @@ components: - single_select - multi_select - true_false + - url description: The type of the value for the property examples: - single_select @@ -92564,6 +92735,7 @@ components: - single_select - multi_select - true_false + - url description: The type of the value for the property. examples: - single_select @@ -92680,6 +92852,7 @@ components: - single_select - multi_select - true_false + - url description: The type of the value for the property examples: - single_select @@ -92737,6 +92910,7 @@ components: - single_select - multi_select - true_false + - url description: The type of the value for the property examples: - single_select diff --git a/descriptions-next/ghec/ghec.json b/descriptions-next/ghec/ghec.json index 6230349b8..7cf250cc8 100644 --- a/descriptions-next/ghec/ghec.json +++ b/descriptions-next/ghec/ghec.json @@ -28415,6 +28415,216 @@ } } }, + "/orgs/{org}/copilot/metrics/reports/organization-1-day": { + "get": { + "summary": "Get Copilot organization usage metrics for a specific day", + "description": "Use this endpoint to retrieve download links for the Copilot organization usage metrics report for a specific day. The report provides comprehensive usage data for Copilot features across the organization.\n\nThe report contains aggregated metrics for the specified day, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.\n\nThe response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/enterprise-cloud@latest//copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-organization-one-day-usage-metrics", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-organization-usage-metrics-for-a-specific-day" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/day" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-usage-metrics-1-day-report" + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-usage-metrics-1-day-report" + } + } + } + } + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-usage-metrics" + } + } + }, + "/orgs/{org}/copilot/metrics/reports/organization-28-day/latest": { + "get": { + "summary": "Get Copilot organization usage metrics", + "description": "Use this endpoint to retrieve download links for the latest 28-day organization Copilot usage metrics report. The report provides comprehensive usage data for Copilot features across the organization.\n\nThe report contains aggregated metrics for the previous 28 days, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.\n\nThe response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/enterprise-cloud@latest//copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-organization-usage-metrics", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-organization-usage-metrics" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-usage-metrics-28-day-report" + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-usage-metrics-28-day-report" + } + } + } + } + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-usage-metrics" + } + } + }, + "/orgs/{org}/copilot/metrics/reports/users-1-day": { + "get": { + "summary": "Get Copilot organization users usage metrics for a specific day", + "description": "Use this endpoint to retrieve download links for the Copilot organization user usage metrics report for a specific day. The report provides detailed user-level usage data and engagement metrics for Copilot features across the organization.\n\nThe report contains user-specific metrics for the specified day, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.\n\nReports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/enterprise-cloud@latest//copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-organization-users-one-day-usage-metrics", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-organization-users-usage-metrics-for-a-specific-day" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/day" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-usage-metrics-1-day-report" + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-usage-metrics-1-day-report" + } + } + } + } + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-usage-metrics" + } + } + }, + "/orgs/{org}/copilot/metrics/reports/users-28-day/latest": { + "get": { + "summary": "Get Copilot organization users usage metrics", + "description": "Use this endpoint to retrieve download links for the latest 28-day organization users Copilot usage metrics report. The report provides detailed user-level usage data and engagement metrics for Copilot features across the organization.\n\nThe report contains user-specific metrics for the previous 28 days, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.\n\nReports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/enterprise-cloud@latest//copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-organization-users-usage-metrics", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-organization-users-usage-metrics" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-usage-metrics-28-day-report" + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-usage-metrics-28-day-report" + } + } + } + } + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-usage-metrics" + } + } + }, "/orgs/{org}/credential-authorizations": { "get": { "summary": "List SAML SSO authorizations for an organization", @@ -127912,7 +128122,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -128005,7 +128216,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property.", "examples": [ @@ -128168,7 +128380,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ @@ -128247,7 +128460,8 @@ "string", "single_select", "multi_select", - "true_false" + "true_false", + "url" ], "description": "The type of the value for the property", "examples": [ diff --git a/descriptions-next/ghec/ghec.yaml b/descriptions-next/ghec/ghec.yaml index d10c1dc86..4a87526d0 100644 --- a/descriptions-next/ghec/ghec.yaml +++ b/descriptions-next/ghec/ghec.yaml @@ -20531,6 +20531,176 @@ paths: enabledForGitHubApps: true category: copilot subcategory: copilot-metrics + "/orgs/{org}/copilot/metrics/reports/organization-1-day": + get: + summary: Get Copilot organization usage metrics for a specific day + description: |- + Use this endpoint to retrieve download links for the Copilot organization usage metrics report for a specific day. The report provides comprehensive usage data for Copilot features across the organization. + + The report contains aggregated metrics for the specified day, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time. + + The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed. + + Organization owners and authorized users with fine-grained "View Organization Copilot Metrics" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + For more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/enterprise-cloud@latest//copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations). + tags: + - copilot + operationId: copilot/copilot-organization-one-day-usage-metrics + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-organization-usage-metrics-for-a-specific-day + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/day" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-usage-metrics-1-day-report" + examples: + default: + "$ref": "#/components/examples/copilot-usage-metrics-1-day-report" + '500': + "$ref": "#/components/responses/internal_error" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: copilot + subcategory: copilot-usage-metrics + "/orgs/{org}/copilot/metrics/reports/organization-28-day/latest": + get: + summary: Get Copilot organization usage metrics + description: |- + Use this endpoint to retrieve download links for the latest 28-day organization Copilot usage metrics report. The report provides comprehensive usage data for Copilot features across the organization. + + The report contains aggregated metrics for the previous 28 days, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time. + + The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed. + + Organization owners and authorized users with fine-grained "View Organization Copilot Metrics" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + For more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/enterprise-cloud@latest//copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations). + tags: + - copilot + operationId: copilot/copilot-organization-usage-metrics + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-organization-usage-metrics + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-usage-metrics-28-day-report" + examples: + default: + "$ref": "#/components/examples/copilot-usage-metrics-28-day-report" + '500': + "$ref": "#/components/responses/internal_error" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: copilot + subcategory: copilot-usage-metrics + "/orgs/{org}/copilot/metrics/reports/users-1-day": + get: + summary: Get Copilot organization users usage metrics for a specific day + description: |- + Use this endpoint to retrieve download links for the Copilot organization user usage metrics report for a specific day. The report provides detailed user-level usage data and engagement metrics for Copilot features across the organization. + + The report contains user-specific metrics for the specified day, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement. + + Reports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed. + + Organization owners and authorized users with fine-grained "View Organization Copilot Metrics" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + For more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/enterprise-cloud@latest//copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations). + tags: + - copilot + operationId: copilot/copilot-organization-users-one-day-usage-metrics + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-organization-users-usage-metrics-for-a-specific-day + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/day" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-usage-metrics-1-day-report" + examples: + default: + "$ref": "#/components/examples/copilot-usage-metrics-1-day-report" + '500': + "$ref": "#/components/responses/internal_error" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: copilot + subcategory: copilot-usage-metrics + "/orgs/{org}/copilot/metrics/reports/users-28-day/latest": + get: + summary: Get Copilot organization users usage metrics + description: |- + Use this endpoint to retrieve download links for the latest 28-day organization users Copilot usage metrics report. The report provides detailed user-level usage data and engagement metrics for Copilot features across the organization. + + The report contains user-specific metrics for the previous 28 days, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement. + + Reports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed. + + Organization owners and authorized users with fine-grained "View Organization Copilot Metrics" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + For more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/enterprise-cloud@latest//copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations). + tags: + - copilot + operationId: copilot/copilot-organization-users-usage-metrics + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-organization-users-usage-metrics + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-usage-metrics-28-day-report" + examples: + default: + "$ref": "#/components/examples/copilot-usage-metrics-28-day-report" + '500': + "$ref": "#/components/responses/internal_error" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: copilot + subcategory: copilot-usage-metrics "/orgs/{org}/credential-authorizations": get: summary: List SAML SSO authorizations for an organization @@ -92499,6 +92669,7 @@ components: - single_select - multi_select - true_false + - url description: The type of the value for the property examples: - single_select @@ -92564,6 +92735,7 @@ components: - single_select - multi_select - true_false + - url description: The type of the value for the property. examples: - single_select @@ -92680,6 +92852,7 @@ components: - single_select - multi_select - true_false + - url description: The type of the value for the property examples: - single_select @@ -92737,6 +92910,7 @@ components: - single_select - multi_select - true_false + - url description: The type of the value for the property examples: - single_select