スパイラル サポートサイト

powered by SPIRAL PLACE®

HOME > 機能 > ハイレベルAPI>sumtable(集計表)

sumtable(集計表)


集計表は、指定したDBのデータから、集計表とグラフを作成し、Webページに表示する機能です。 APIを使うことで、アクセス権限をマイエリアに設定された集計表のデータを取得することが可能です。詳しくは集計表・グラフを参照して下さい。

sumtable/data


集計表データを取得します。ただし、同一アカウント内でステータスが「集計中」の集計表が存在する場合は集計が出来ません。
○:必須、△:選択必須


リクエストパラメータ


パラメータ必須説明文字種長
spiral_api_tokenAPIトークン半角英数字
passkeyepoch秒。APIトークンシークレットとpasskeyで署名を作成する。
署名の有効期限チェックにも使用する。有効期限は作成してから30分。
int
signature署名半角英数字
jsessionidマイエリアにログインした際のセッションID半角英数大文字
auto_login_cookieマイエリアにログインした際のaluto_login_cookieの値半角英数字記号
totalizer_title集計表タイトル(集計表設定から取得可能)半角英数字, アンスコ, ハイフン 16文字以内
my_area_titleマイエリアのタイトル半角英数字, アンスコ, ハイフン 16文字以内
history集計履歴(省略時および0を指定時は最新の集計データを返す。
集計表履歴番号を指定する(%usr:totalizer_<集計表タイトル>:n のnの部分の値)
int (0以上)
terminal_ip_addressエンドユーザ(末端)のIPアドレスIPアドレス仕様


レスポンス


パラメータ説明文字種長
code応答コードint
message応答メッセージ半角英数字記号
header_x一覧表ヘッダ(X軸)。カラム名の配列(例: ['カラム1','カラム2'])
header_y一覧表ヘッダ(Y軸)。行名の配列(例:['行1','行2'])。クロス集計の場合のみ返す
data表のデータ値。行×列の2次元配列、または行×列×(度数/割合)の3次元配列(クロス集計(度数/割合))
jsessionid有効なセッションのID半角英数字
auto_login_cookiejsessionidが送信されない、もしくは無効なjsessionidが送信された場合で自動ログインが成功した場合、有効な自動ログイン用のCookieが返される。半角英数字記号
auto_login_limitauto_login_cookieにより自動ロクインできる有効期限のエポック秒int

sumtable/count


集計を実行します。
ただし、対象の集計表が最後に集計されてから10分間未満の場合はエラーを返し、集計不可となります。
集計は非同期で行われます。
なお、管理画面上では集計者は『API(トークンタイトル)』として記録されます。(タイトルなしの場合は『API』のみ)
○:必須、△:選択必須


リクエストパラメータ


パラメータ必須説明文字種長
spiral_api_tokenAPIトークン半角英数字
passkeyepoch秒。APIトークンシークレットとpasskeyで署名を作成する。
署名の有効期限チェックにも使用する。
有効期限は作成してから30分。
int
signature署名半角英数字
jsessionidマイエリアにログインした際のセッションID半角英数大文字
auto_login_cookieマイエリアにログインした際のaluto_login_cookieの値半角英数字記号
totalizer_title集計表タイトル(集計表設定から取得可能)半角英数字, アンスコ, ハイフン 16文字以内
my_area_titleマイエリアのタイトル半角英数字, アンスコ, ハイフン 16文字以内
terminal_ip_addressエンドユーザ(末端)のIPアドレスIPアドレス仕様


レスポンス


パラメータ説明文字種長
code応答コード(集計中の集計や、集計後10分未満の集計はエラーコード803が返る)int
message応答メッセージ半角英数字記号
jsessionid有効なセッションのID半角英数字
auto_login_cookiejsessionidが送信されない、もしくは無効なjsessionidが
送信された場合で自動ログインが成功した場合、有効な自動ログイン用の
Cookieが返される。
半角英数字記号
auto_login_limitauto_login_cookieにより自動ロクインできる有効期限のエポック秒int

sumtable/status


集計表のステータスを取得します。
○:必須、△:選択必須


リクエストパラメータ


パラメータ必須説明文字種長
spiral_api_tokenAPIトークン半角英数字
passkeyepoch秒。APIトークンシークレットとpasskeyで署名を作成する。
署名の有効期限チェックにも使用する。
有効期限は作成してから30分。
int
signature署名半角英数字
jsessionidマイエリアにログインした際のセッションID半角英数大文字
auto_login_cookieマイエリアにログインした際のaluto_login_cookieの値半角英数字記号
totalizer_title集計表タイトル(集計表設定から取得可能)半角英数字, アンスコ, ハイフン 16文字以内
my_area_titleマイエリアのタイトル半角英数字, アンスコ, ハイフン 16文字以内
terminal_ip_addressエンドユーザ(末端)のIPアドレスIPアドレス仕様


レスポンス


パラメータ説明文字種長
code応答コード(集計中の集計や、集計後10分未満の集計はエラーコード803が返る)int
message応答メッセージ半角英数字記号
status最後に行った集計のステータス
0:未集計 1:集計中 2:集計完了 3:集計失敗(時間超過) 4:集計失敗(エラー)
int (1〜5)
count_date最終集計日時YYYY/MM/DD hh:mm
history最終集計履歴番号int (1以上)
who最終集計者半角英数字
jsessionid有効なセッションのID半角英数字
auto_login_cookiejsessionidが送信されない、もしくは無効なjsessionidが送信された場合で
自動ログインが成功した場合、有効な自動ログイン用のCookieが返される。
半角英数字記号
auto_login_limitauto_login_cookieにより自動ロクインできる有効期限のエポック秒int

フロー・操作画面と各パラメータの関連性


以下は操作画面において各パラメータが何を指すのかを示しています。


操作画面との関連性