カテゴリー内の他の記事

アプリのグラフ設定の取得

アプリのグラフの設定を取得します。

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 文字列   フィールドの名前に「言語ごとの名称」を設定している場合に、取得する名称の言語を指定します。
  • 日本語の名称を取得する場合:ja
  • 英語の名称を取得する場合:en
  • 中国語の名称を取得する場合:zh
  • ログインユーザーの言語設定で取得する場合:user*
    *ログインユーザーの言語設定が「Webブラウザの設定にしたがう」の場合、
    Accept-Languageヘッダがあればその設定が反映され、
    Accept-Languageヘッダがなければcybozu.com共通管理の「ローカライズの設定」で設定された言語で取得されます。
  • デフォルトの名称を取得する場合:default
省略すると、デフォルトの名称が取得されます。

リクエストの例

送信するリクエストは、パラメータの送信方法によって異なります。パラメータ「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 文字列
グラフの種類です。
  • BAR: 横棒グラフ
  • COLUMN: 縦棒グラフ
  • PIE: 円グラフ
  • LINE: 折れ線グラフ
  • PIVOT_TABLE: クロス集計表
  • TABLE: 表
  • AREA: 面グラフ
  • SPLINE: 曲線グラフ
  • SPLINE_AREA: 曲線面グラフ
reports.{グラフ名}.chartMode 文字列
グラフの表示モードです。
  • NORMAL: 集合 または積み上げなし
  • STACKED: 積み上げ
  • PERCENTAGE: 100%積み上げ
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 文字列
分類する項目の時間単位です。
  • YEAR: 年単位
  • QUARTER: 四半期単位
  • MONTH: 月単位
  • WEEK: 週単位
  • DAY: 日単位
  • HOUR: 1時間単位
  • MINUTE: 分単位
code で次のフィールドが指定された場合に返却されます。
  • 作成日時
  • 更新日時
  • 日時
  • 日付(YEAR, QUARTER, MONTH, WEEK, DAY のみ)
  • 時刻(HOUR, MINUTE のみ)
設定されている値が「--」(単位なし)の場合、
最小の時間単位が返却されます。
reports.{グラフ名}.aggregations 配列 集計方法を表すオブジェクトの配列です。
reports.{グラフ名}.aggregations[].type 文字列
集計方法の種類です。
  • COUNT: レコード数
  • SUM: 合計
  • AVERAGE: 平均
  • MAX: 最大
  • MIN: 最小
reports.{グラフ名}.aggregations[].code 文字列
集計対象のフィールドコードです。
type が COUNT の場合は返却されません。
reports.{グラフ名}.filterCond 文字列
絞り込み条件です。
クエリ形式で表されます。クエリ形式については、次のページを参照してください。
レコードの一括取得(クエリで条件を指定)
削除済みのユーザー、組織、グループが指定されている場合はエラーが返却されます。
reports.{グラフ名}.sorts 配列 ソートを表すオブジェクトの配列です。
reports.{グラフ名}.sorts[].by 文字列
ソートの対象です。
  • TOTAL: 集計値
  • GROUP1: 大項目
  • GROUP2: 中項目
  • GROUP3: 小項目
reports.{グラフ名}.sorts[].order 文字列
ソートの並び順です。
  • ASC: 昇順
  • DESC: 降順
reports.{グラフ名}.periodicReport オブジェクト
定期レポートの設定です。
定期レポートが設定されていない場合は null が返却されます。
reports.{グラフ名}.periodicReport.active 真偽値
定期レポートの実行状態です。
  • true: 実行中
  • false: 停止中
reports.{グラフ名}.periodicReport.period オブジェクト 定期レポートの集計間隔です。
reports.{グラフ名}.periodicReport.period.every 文字列
定期レポートの集計間隔の種類です。
  • YEAR: 毎年
  • QUARTER: 毎四半期
  • MONTH: 毎月
  • WEEK: 毎週
  • DAY: 毎日
  • HOUR: 毎時
reports.{グラフ名}.periodicReport.period.month 文字列
集計を実施する月です。
値は 1 から 12 の整数です。
every が YEAR の場合のみ返却されます。
reports.{グラフ名}.periodicReport.period.time 文字列
集計を実施する時刻です。
フォーマットは HH:mm 形式です。
every が YEAR、QUARTER、MONTH、WEEK、DAY の場合のみ返却されます。
reports.{グラフ名}.periodicReport.period.pattern 文字列
四半期の集計を実施する月です。
  • JAN_APR_JUL_OCT: 1月, 4月, 7月, 10月
  • FEB_MAY_AUG_NOV: 2月, 5月, 8月, 11月
  • MAR_JUN_SEP_DEC: 3月, 6月, 9月, 12月
every が QUARTER の時のみ返却されます。
reports.{グラフ名}.periodicReport.period.dayOfMonth 文字列
集計を実施する日です。
  • 1 から 31 の整数です。
  • END_OF_MONTH: 月末
    reports.{グラフ名}.periodicReport.period.every が QUARTER、MONTH の時のみ
every がYEAR、QUARTER、MONTH の時のみ返却されます。
reports.{グラフ名}.periodicReport.period.dayOfWeek 文字列
集計を実施する曜日です。
  • SUNDAY
  • MONDAY
  • TUESDAY
  • WEDNESDAY
  • THURSDAY
  • FRIDAY
  • SATURDAY
every が WEEK の時のみ返却れます。
reports.{グラフ名}.periodicReport.period.minute 文字列
集計を実施する分です。
0、10、20、30、40、50 のいずれかの値が返却されます。
every が HOUR の時のみ返却されます。
revision 文字列 アプリの設定のリビジョン番号です。

レスポンスの例

JavaScriptサンプル

kintone REST APIリクエストを送信する API を使ったリクエスト

XMLHttpRequest を使ったリクエスト

記事に関するフィードバック

記事のコメント欄は記事に対するフィードバックをする場となっております。
右の記事フィードバックのためのガイドを参照してコメントしてください。
記事のリンク切れなど、気になる点がある場合も、こちらのフォームからフィードバックいただけますと幸いです。

サインインしてコメントを残してください。