kintone APIドキュメント

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

目次

information

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

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

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

アプリ管理権限があるアプリの使用状況の一覧を取得します。
一度に取得できるアプリ数は、100件までです。

URL

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

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

HTTPメソッド

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

GET

必要なアクセス権

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

  • アプリの管理権限

リクエスト

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

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

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

ヘッダー
1
2
3

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

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

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

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
}

レスポンス

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

プロパティ
プロパティ名 型 説明
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 文字列 アプリ設定の最終更新日時
レスポンスの例
 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"
        }
    ]
}

サンプルコード

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

curlを使ったリクエスト
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
  }'
kintone REST APIリクエストを送信するAPIを使ったリクエスト
1
2
3
4
5

const body = {
  limit: 1
};

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