Following the Copilot coding agent to Copilot cloud agent rename, the Copilot usage metrics API now includes a new used_copilot_cloud_agent field in user-level reports. This boolean field mirrors the existing used_copilot_coding_agent flag under the updated product name.

What’s new

Field Description
used_copilot_cloud_agent Whether the user had Copilot cloud agent activity during the reporting period (boolean, nullable)

The field is available in single-day and 28-day rolling window reports at both the enterprise and organization user levels. It returns the same value as the existing used_copilot_coding_agent field, which will be preserved for backward compatibility until August 1, 2026.

Why this matters

  • Integrations and dashboards can adopt the new field name to match the Copilot cloud agent branding without waiting for the legacy field to be removed.
  • Both fields coexist and return the same value, so you can transition at your own pace.
  • The new field appears in enterprise user and organization user reports for both 1-day and 28-day windows.

Important notes

  • These metrics are available to enterprise administrators and organization owners who have access to Copilot usage metrics through the REST API.
  • The existing used_copilot_coding_agent field continues to work and will not be deprecated until August 1, 2026.

Join the discussion within GitHub Community.