部門別使用状況データの取得_Lingma_インテリジェントコーディングアシスタント - AI Coding Assistant Lingma

この API を呼び出して、部門における Lingma の使用状況データを取得します。

サポートされているエディション

Enterprise Dedicated Edition

サービスエンドポイントと承認情報

API リクエスト構文の <domain> を、エンドポイントに置き換えるサービスエンドポイントを取得します。
アクセストークンを取得します。
organizationId を取得します。 Lingma コンソールに移動し、[企業設定] > [組織] の下の [基本情報] ページで組織 ID を確認します。

製品	リソース	必要な権限
Lingma	部門別使用状況統計	読み取り専用

リクエスト構文

GET https://{domain}/oapi/v1/lingma/organizations/{organizationId}/departmentUsage

リクエストヘッダー

パラメーター	タイプ	必須	説明	例
x-yunxiao-token	string	はい	アクセストークン。	pt-0fh3**0fbG_35af**0484

リクエストパラメーター

パラメータ	タイプ	位置	必須	説明
`organizationId`	文字列	パス	はい	組織 ID です。
`departmentId`	文字列	クエリ	このガイドが、JavaScript から WordPress REST API を使用する方法を理解するのに役立つことを願っています。	部門 ID です。
`startTime`	文字列	クエリ	はい	YYYY-MM-DD 形式の開始日です。
`endTime`	文字列	クエリ	はい	YYYY-MM-DD 形式の終了日。
`page`	整数	クエリ	いいえ	ページ番号です。デフォルト値：1。
`perPage`	整数	クエリ	いいえ	1 ページあたりのエントリ数です。デフォルト値：100。

リクエスト例

curl -X 'GET' \
  'https://{domain}/oapi/v1/lingma/organizations/{organizationId}/departmentUsage?departmentId={departmentId}&startTime={startTime}&endTime={endTime}&page={page}&perPage={perPage}' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

レスポンスパラメーター

パラメーター	タイプ	説明
-	配列
-	オブジェクト
`activeDeveloper`	integer	アクティブユーザーの総数。
`activeDeveloperChat`	integer	指定された日付に Lingma のチャット機能を少なくとも 1 回トリガーしたアクティブユーザーの数。
`activeDeveloperCompletion`	integer	指定された日付に Lingma のコード補完機能を少なくとも 1 回トリガーしたアクティブユーザーの数。
`breakdown`	オブジェクト	Lingma の使用状況データの内訳。有効な値： `chatting` `coding` `completion`
`chatting`	配列	チャット機能に関する詳細データ。
-	オブジェクト
`activeDeveloper`	integer	アクティブユーザーの数。
`chatTurns`	integer	チャットの数。
`chatTurnsAccepted`	integer	承認されたチャットの数。
`chatType`	string	チャットのタイプ。有効な値： `CODE_GENERATE_COMMENT`：コメント生成 `GENERATE_TESTCASE`：単体テスト生成 `EXPLAIN_CODE`：コードの説明 `OPTIMIZE_CODE`：コードの最適化 `FREE_INPUT`：チャットその他の大文字でない文字列：カスタムコマンド
`ide`	string	統合開発環境 ( IDE )。 `jetbrains` や `vscode` など。
`coding`	配列	コード変更の統計情報。コード補完とチャットで承認および変更されたコード変更の数を含む。
-	オブジェクト
`acceptAssistantNewlineCount`	integer	その日に部門が承認したコード行数 (チャットと言語別を含む)。
`activeDeveloper`	integer	アクティブユーザーの数。
`language`	string	言語。
`linesAccepted`	integer	承認されたコード行数。
`linesChanged`	integer	変更されたコード行数。
`completion`	配列	コード補完機能に関する詳細データ。
-	オブジェクト
`activeDeveloper`	integer	アクティブユーザーの数。
`countAccepted`	integer	部門が承認したコード補完。
`countSuggested`	integer	Lingma が提案したコード補完。
`ide`	string	統合開発環境 ( IDE )。 `jetbrains` や `vscode` など。
`language`	string	言語。
`linesAccepted`	integer	承認されたコード行数。
`linesChanged`	integer	変更されたコード行数。
`date`	integer	日付。
`departmentId`	string	部門 ID。
`totalChatTurns`	integer	その日に部門が行ったチャットの数。
`totalChatTurnsAccepted`	integer	その日に部門が承認したチャットの数。
`totalCountAcceptedCompletion`	integer	その日に部門が承認したコード補完。
`totalCountSuggestedCompletion`	integer	その日に部門に提案されたコード補完。
`totalLinesAccepted`	integer	その日に部門が Ask、Edit、Agent モード、およびコード補完を通じて承認したコード行の総数。
`totalLinesAcceptedChat`	integer	その日に部門がチャットを通じて承認したコード行の総数。
`totalLinesAcceptedCompletion`	integer	その日に部門がコード補完を通じて承認したコード行の総数。
`totalLinesChanged`	integer	その日に部門が Ask、Edit、Agent モード、およびコード補完を通じて変更したコード行の総数。
`totalLinesSuggestedCompletion`	integer	その日に部門にコード補完を通じて提案されたコード行の総数。

レスポンス例

[
    {
        "activeDeveloper": 0, // アクティブな開発者
        "activeDeveloperChat": 0, // チャット中のアクティブな開発者
        "activeDeveloperCompletion": 0, // 補完中のアクティブな開発者
        "breakdown": { // 内訳
            "chatting": [ // チャット
                {
                    "activeDeveloper": 0, // アクティブな開発者
                    "chatTurns": 0, // チャットのターン数
                    "chatTurnsAccepted": 0, // 承認されたチャットのターン数
                    "chatType": "", // チャットの種類
                    "ide": "" // IDE
                }
            ],
            "coding": [ // コーディング
                {
                    "acceptAssistantNewlineCount": 0, // アシスタントが改行を受け入れた回数
                    "activeDeveloper": 0, // アクティブな開発者
                    "language": "", // 言語
                    "linesAccepted": 0, // 承認された行数
                    "linesChanged": 0 // 変更された行数
                }
            ],
            "completion": [ // 補完
                {
                    "activeDeveloper": 0, // アクティブな開発者
                    "countAccepted": 0, // 承認された回数
                    "countSuggested": 0, // 提案された回数
                    "ide": "", // IDE
                    "language": "", // 言語
                    "linesAccepted": 0, // 承認された行数
                    "linesChanged": 0 // 変更された行数
                }
            ]
        },
        "date": 0, // 日付
        "departmentId": "", // 部門ID
        "totalChatTurns": 0, // チャットの総ターン数
        "totalChatTurnsAccepted": 0, // 承認されたチャットの総ターン数
        "totalCountAcceptedCompletion": 0, // 補完の承認された総数
        "totalCountSuggestedCompletion": 0, // 補完の提案された総数
        "totalLinesAccepted": 0, // 承認された総行数
        "totalLinesAcceptedChat": 0, // チャットで承認された総行数
        "totalLinesAcceptedCompletion": 0, // 補完で承認された総行数
        "totalLinesChanged": 0, // 変更された総行数
        "totalLinesSuggestedCompletion": 0 // 補完で提案された総行数
    }
]

レスポンスヘッダー

パラメーター	説明	例
`x-next-page`	次のページ。	1
`x-per-page`	1 ページあたりのエントリ数。	100
`x-prev-page`	前のページ。	1
`x-total`	エントリの総数。	2
`x-total-pages`	ページの総数。	1

エラーコード

詳細については、「エラーコード」をご参照ください。

参考資料

詳細については、「OpenAPI 関連の問題」をご参照ください。