アプリの使用状況を取得する

固定リンクがコピーされました

このAPIはワイドコースでのみ利用できます。
ワイドコースとは

アプリ管理権限があるアプリの使用状況の一覧を取得します。

HTTPメソッド	GET
URL	https://sample.cybozu.com/k/v1/apps/statistics.json
認証	パスワード認証 , APIトークン認証 , セッション認証 , OAuth認証
Content-Type	application/json

リクエストパラメーター

固定リンクがコピーされました

パラメーター名	型	必須	説明
offset	数値または文字列	省略可	取得するアプリの先頭からスキップする数省略すると0が設定されます。
limit	数値または文字列	省略可	取得する件数 1から100までの整数を指定できます。省略すると100が設定されます。

レスポンスプロパティ

固定リンクがコピーされました

プロパティ名	型	説明
apps	配列	アプリ情報の一覧
apps[].id	数値または文字列	アプリID
apps[].name	文字列	アプリ名言語ごとにアプリ名を設定している場合、APIの実行ユーザーが設定している言語に応じたアプリ名が返ります。
apps[].space	オブジェクト	所属スペースの情報スペースに所属していないアプリでは、「null」が返ります。
apps[].space.id	数値または文字列	スペースID
apps[].space.name	文字列	スペース名
apps[].appGroup	文字列	アプリグループ
apps[].status	文字列	アプリのステータス次のいずれかが返ります。 `CHANGED` `NOT_ACTIVATED` `ACTIVATED`
apps[].recordUpdatedAt	文字列	最後に追加または編集されたレコードの日付 2021年1月のアップデートより前に作成され、その後に一度もレコードが追加または編集されていないアプリでは、アプリの作成日が返ります。
apps[].recordCount	数値または文字列	アプリ内のレコード数
apps[].fieldCount	数値または文字列	アプリ内のフィールド数
apps[].dailyRequestCount	数値または文字列	1日のAPIリクエスト数
apps[].storageUsage	数値または文字列	添付ファイルフィールドに添付されているファイルの合計サイズ単位はByteです。
apps[].customized	真偽値	アプリをカスタマイズしているかどうか次に当てはまる場合、「true」が返ります。 JavaScript / CSSによるカスタマイズプラグインによるカスタマイズ「カスタマイズ」形式の一覧が存在する
apps[].creator	オブジェクト	作成者の情報
apps[].creator.code	文字列	作成者のログイン名停止／削除済みユーザーの場合でも取得できます。
apps[].creator.name	文字列	作成者の表示名停止／削除済みユーザーの場合でも取得できます。
apps[].createdAt	文字列	作成日時
apps[].modifier	オブジェクト	アプリ設定の最終更新者の情報
apps[].modifier.code	文字列	更新者のログイン名停止／削除済みユーザーの場合でも取得できます。
apps[].modifier.name	文字列	更新者の表示名停止／削除済みユーザーの場合でも取得できます。
apps[].modifiedAt	文字列	アプリ設定の最終更新日時

必要なアクセス権

固定リンクがコピーされました

アプリの管理権限

サンプル

固定リンクがコピーされました

サンプルリクエスト

リクエストURL（URLにパラメーターを含める場合）

1

https\://sample.cybozu.com/k/v1/apps/statistics.json?offset=1&limit=1

リクエストヘッダー（URLにパラメーターを含める場合）

1
2
3


{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU="
}

リクエストヘッダーの詳細は共通仕様を参照してください。
kintone REST APIの共通仕様

リクエストURL（リクエストボディにパラメーターを含める場合）

1

https\://sample.cybozu.com/k/v1/apps/statistics.json

リクエストヘッダー（リクエストボディにパラメーターを含める場合）

1
2
3
4


{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU=",
  "Content-Type": "application/json"
}

リクエストヘッダーの詳細は共通仕様を参照してください。
kintone REST APIの共通仕様

リクエストボディ

1
2
3
4


{
  "offset": 0,
  "limit": 1
}

サンプルレスポンス

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30


{
    "apps": [
        {
            "id": "1",
            "name":"案件管理",
            "space" : {
                "id": "1",
                "name": "営業管理"
            },
            "appGroup": "Public",
            "status": "ACTIVATED",
            "recordUpdatedAt": "2023-12-04T05:45:36.000Z",
            "recordCount":"100",
            "fieldCount":"10",
            "dailyRequestCount":"1",
            "storageUsage":"47000000",
            "customized":true,
            "creator" : {
                "code": "tanaka",
                "name": "tanaka"
            },
           "createdAt": "2023-12-04T05:45:36.000Z",
           "modifier" : {
                "code": "tanaka",
                "name": "tanaka"
            },
           "modifiedAt": "2023-12-04T05:45:36.000Z"
        }
    ]
}

サンプルコード

kintone.api()を使ったリクエスト

kintone.api()の詳細は、次のページを参照してください。
kintone REST APIリクエストを送信する

1
2
3
4
5


const body = {
  limit: 1
};

await kintone.api(kintone.api.url('/k/v1/apps/statistics.json', true), 'GET', body);

curlを使ったリクエスト

ご利用の環境によって、curlのフォーマットは異なる場合があります。
詳細は、次のページを参照してください。
curlコマンドでkintone REST APIを実行してみよう/3.API実行

1
2
3
4
5
6


curl -X GET 'https://sample.cybozu.com/k/v1/apps/statistics.json' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=' \
  -H 'Content-Type: application/json' \
  -d '{
    "limit": 1
  }'

補足

固定リンクがコピーされました

一度に取得できるアプリ数は、100件までです。

kintone API

kintone APIドキュメント

アプリの使用状況を取得する

目次

リクエストパラメーター

レスポンスプロパティ

必要なアクセス権

サンプル

補足