Clarification on GitHub Copilot Metrics API

[njp000]

Select Topic Area

Question

Body

Hello,

I would like some clarification regarding specific metrics in the GitHub Copilot Metrics API. I am currently using VSCode as my IDE.

Here's an example response from the API:

{
  "copilot_ide_chat": {
    "editors": [
      {
        "name": "vscode",
        "models": [
          {
            "name": "default",
            "total_chats": 3,
            "is_custom_model": false,
            "total_engaged_users": 1,
            "total_chat_copy_events": 0,
            "total_chat_insertion_events": 0
          }
        ],
        "total_engaged_users": 1
      },
      {
        "name": "JetBrains",
        "models": [
          {
            "name": "default",
            "total_chats": 6,
            "is_custom_model": false,
            "total_engaged_users": 1,
            "total_chat_copy_events": 2,
            "total_chat_insertion_events": 2
          }
        ],
        "total_engaged_users": 1
      }
    ],
    "total_engaged_users": 2
  }
}

I have a few questions based on the response schema and metric descriptions:

1. Metric: total_engaged_users
   Description: "The number of users who prompted Copilot Chat in the specified editor."

   Question: Does this metric count only interactions in the Chat view, or does it also include Quick Chat and Inline Chat?

2. Metric: total_chat_insertion_events
   Description: "The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor."

   Question: Does this include interactions such as 'Apply in Editor,' 'Insert at Cursor,' 'Insert into Terminal,' or 'Insert into New File'?

3. Metric: total_chat_copy_events
   Description: "The number of times users copied a code suggestion from Copilot Chat using the keyboard or the 'Copy' UI element, for the given editor."

   Question: Does this count every Ctrl+C action if repeated multiple times?
   Question: Does it continue counting if I repeatedly click the 'Copy' UI element?

Thank you for your help in clarifying these points!

Best regards,
njp000