アプリのグラフの設定を取得します。
同名のグラフがアプリに存在する場合、この API を実行するとエラーが発生します。
URI
URIは、運用環境の設定を取得する場合と、動作テスト環境の設定を取得する場合とで異なります。
運用環境の設定を取得する場合
https://(サブドメイン名).cybozu.com/k/v1/app/reports.json
ゲストスペースのアプリの場合：https://(サブドメイン名).cybozu.com/k/guest/(スペースのID)/v1/app/reports.json
動作テスト環境の設定を取得する場合
https://(サブドメイン名).cybozu.com/k/v1/preview/app/reports.json
ゲストスペースのアプリの場合：https://(サブドメイン名).cybozu.com/k/guest/(スペースのID)/v1/preview/app/reports.json
HTTPメソッド
GET
必要なアクセス権
アプリ管理権限
リクエストパラメータ
| パラメータ名 | 指定する値 | 必須 | 説明 |
|---|---|---|---|
| app | 数値または文字列 | 必須 | アプリのIDを指定します。 |
| lang | 文字列 | フィールドの名前に「言語ごとの名称」を設定している場合に、取得する名称の言語を指定します。
|
リクエストの例
送信するリクエストは、パラメータの送信方法によって異なります。パラメータ「app」と「lang」を指定したリクエストの例は、次のとおりです。
URLにパラメータを含める場合
GET /k/v1/app/reports.json?app=1&lang=ja HTTP/1.1
Host: example.cybozu.com:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
リクエストボディにパラメーターを含める場合
ヘッダ
GET /k/v1/app/reports.json HTTP/1.1
Host: example.cybozu.com:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
ボディ
レスポンスパラメータ
| パラメータ名 | 値の種類 | 説明 |
|---|---|---|
| reports | オブジェクト |
グラフの情報を表すオブジェクトです。
キーとなるグラフ名は言語設定によらず、常にデフォルトの名称で返却されます。
|
| reports.{グラフ名}.chartType | 文字列 |
グラフの種類です。
|
| reports.{グラフ名}.chartMode | 文字列 |
グラフの表示モードです。
chartType が横棒グラフ（BAR）または縦棒グラフ（COLUMN）の場合、 NORMAL は集合を表します。
chartType が面グラフ（AREA）または曲線面グラフ（SPLINE_AREA）の場合、NORMAL は積み上げなしを表します。
それ以外の chartType では chartMode は返却されません。
|
| reports.{グラフ名}.id | 文字列 |
グラフのIDです。 |
| reports.{グラフ名}.name | 文字列 |
グラフ名です。
lang を指定した時は言語ごとの名称で設定された値になります。
|
| reports.{グラフ名}.index | 文字列 | グラフの並び順です。0から始まります。 |
| reports.{グラフ名}.groups | 配列 |
分類する項目を表すオブジェクトの配列です。
設定されている項目のみ返却されます。順番は上から大項目・中項目・小項目です。
|
| reports.{グラフ名}.groups[].code | 文字列 | 分類する項目のフィールドコードです。 |
| reports.{グラフ名}.groups[].per | 文字列 |
分類する項目の時間単位です。
code で次のフィールドが指定された場合に返却されます。
設定されている値が「--」（単位なし）の場合、
最小の時間単位が返却されます。
|
| reports.{グラフ名}.aggregations | 配列 | 集計方法を表すオブジェクトの配列です。 |
| reports.{グラフ名}.aggregations[].type | 文字列 |
集計方法の種類です。
|
| reports.{グラフ名}.aggregations[].code | 文字列 |
集計対象のフィールドコードです。
type が COUNT の場合は返却されません。
|
| reports.{グラフ名}.filterCond | 文字列 |
絞り込み条件です。
クエリ形式で表されます。クエリ形式については、次のページを参照してください。レコードの一括取得（クエリで条件を指定） 削除済みのユーザー、組織、グループが指定されている場合はエラーが返却されます。
|
| reports.{グラフ名}.sorts | 配列 | ソートを表すオブジェクトの配列です。 |
| reports.{グラフ名}.sorts[].by | 文字列 |
ソートの対象です。
|
| reports.{グラフ名}.sorts[].order | 文字列 |
ソートの並び順です。
|
| reports.{グラフ名}.periodicReport | オブジェクト |
定期レポートの設定です。
定期レポートが設定されていない場合は null が返却されます。
|
| reports.{グラフ名}.periodicReport.active | 真偽値 |
定期レポートの実行状態です。
|
| reports.{グラフ名}.periodicReport.period | オブジェクト | 定期レポートの集計間隔です。 |
| reports.{グラフ名}.periodicReport.period.every | 文字列 |
定期レポートの集計間隔の種類です。
|
| reports.{グラフ名}.periodicReport.period.month | 文字列 |
集計を実施する月です。
値は 1 から 12 の整数です。
every が YEAR の場合のみ返却されます。
|
| reports.{グラフ名}.periodicReport.period.time | 文字列 |
集計を実施する時刻です。
フォーマットは HH:mm 形式です。
every が YEAR、QUARTER、MONTH、WEEK、DAY の場合のみ返却されます。
|
| reports.{グラフ名}.periodicReport.period.pattern | 文字列 |
四半期の集計を実施する月です。
every が QUARTER の時のみ返却されます。
|
| reports.{グラフ名}.periodicReport.period.dayOfMonth | 文字列 |
集計を実施する日です。
every がYEAR、QUARTER、MONTH の時のみ返却されます。
|
| reports.{グラフ名}.periodicReport.period.dayOfWeek | 文字列 |
集計を実施する曜日です。
every が WEEK の時のみ返却れます。
|
| reports.{グラフ名}.periodicReport.period.minute | 文字列 |
集計を実施する分です。
0、10、20、30、40、50 のいずれかの値が返却されます。
every が HOUR の時のみ返却されます。
|
| revision | 文字列 | アプリの設定のリビジョン番号です。 |
レスポンスの例
JavaScriptサンプル
kintone REST APIリクエストを送信する API を使ったリクエスト
XMLHttpRequest を使ったリクエスト
記事に関するフィードバック
記事のコメント欄は記事に対するフィードバックをする場となっております。
右の記事フィードバックのためのガイドを参照してコメントしてください。
記事のリンク切れなど、気になる点がある場合も、こちらのフォームからフィードバックいただけますと幸いです。