ダッシュボード・レポート管理 API

最終更新 2026/10/03

呼び出し方法は、Open APIドキュメントの呼び出し方法の説明を参照してください。

関連機能については、まずAE使用マニュアルのダッシュボードの部分を読むことをお勧めします：ダッシュボード

1. レポート管理

1. Rootアカウントのレポート一覧を照会

インターフェースURL

/open/manage-reports?token=xxx&projectId=0

リクエストメソッド

GET

Content-Type

application/json

リクエストQueryパラメータ

パラメータ名	サンプル値	パラメータタイプ	必須	パラメータの説明
token	xxx	String	はい	クエリキー
projectId	0	Integer	はい	プロジェクトID

成功レスポンスの例

{
  "data": {
    "reports": [
      {
        "createType": "MANUAL_CREATE",
        "dashboardIds": [],
        "reportDesc": "",
        "reportId": 34214,
        "reportModel": 0,
        "reportName": "event_3の合計回数(4)",
        "updateTime": "2021-02-04 16:44:03"
      },
      {
        "createType": "IMPORTED",
        "dashboardIds": [
          3015
        ],
        "reportDesc": "",
        "reportId": 25565,
        "reportModel": 0,
        "reportName": "ログイン回数-先月(1)",
        "updateTime": "2020-12-18 14:03:32"
      }
    ],
    "dashboards": [
      {
        "dashbord_id": 3015,
        "dashbord_name": "パフォーマンステスト"
      }
    ]
  },
  "return_code": 0,
  "return_message": "success"
}

パラメータ名	サンプル値	パラメータタイプ	パラメータの説明
data	-	Object	レスポンスデータ
data.dashboards	-	List	ダッシュボード情報
data.dashboards.dashbord_id	1440	Integer	ダッシュボードID
data.dashboards.dashbord_name	条件汎用フィルターダッシュボード	String	ダッシュボード名
data.reports	-	List	レポート情報
data.reports.createType	MANUAL_CREATE	String	レポートの作成方法： MANUAL_CREATE：手動作成 IMPORTED：ダッシュボードのインポートによる作成 COPIED：ダッシュボードのコピーによる作成
data.reports.dashboardIds	2378	Integer	ダッシュボードIDの集合（このレポートに関連するダッシュボードIDのリスト。空の場合、このレポートはどのダッシュボードにも配置されていません）
data.reports.reportDesc	-	Object	レポートの注釈
data.reports.reportId	4049	Integer	レポートID
data.reports.reportModel	0	Integer	分析モデル 0：イベント分析 1：リテンション分析 2：ファネル分析 3：ユーザープロパティ分析 4：フロー分析 5：分布分析
data.reports.reportName	直指	String	レポート名
data.reports.updateTime	2019-12-20 15:59:44	Date	更新日時
return_code	0	Integer	リターンコード
return_message	success	String	リターンメッセージ

2. プロジェクトのレポート一覧を照会

インターフェースURL

/open/list-project-reports?token=xxx&projectId=0

リクエストメソッド

GET

Content-Type

application/json

リクエストQueryパラメータ

パラメータ名	サンプル値	パラメータタイプ	必須	パラメータの説明
token	xxx	String	はい	クエリキー
projectId	0	Integer	はい	プロジェクトID

成功レスポンスの例

{
    "data": [
        {
            "reportId": 34214,
            "createType": "MANUAL_CREATE",
            "reportDesc": "ここにレポートの説明",
            "projectId": 0,
            "reportName": "ここにレポート名",
            "reportModel": "EVENT",
            "creator": {
                "openId": "UIODASBJ-Jiodas312",
                "loginName": "user1",
                "userName": "ユーザー1"
            },
            "dashboardIds": [
                109,
                91
            ]
        }
    ],
    "return_code": 0,
    "return_message": "success"
}

パラメータ名	サンプル値	パラメータタイプ	パラメータの説明
data	-	List	レスポンスデータ
data.reportId	34214	Long	レポートID
data.reportName	ここにレポート名	Integer	レポート名
data.reportDesc	ここにレポートの説明	String	レポートの説明
data.projectId	0	Integer	プロジェクトID
data.createType	MANUAL_CREATE	String	レポートの作成方法： MANUAL_CREATE：手動作成 IMPORTED：インポートによる作成 COPIED：コピーによる作成 SCENE_CREATE テンプレートに基づく作成 PACK_IMPORT プロジェクトのインポートによる作成
data.reportModel	EVENT	String	EVENT：イベント分析レポート RETENTION：リテンション分析レポート FUNNEL：ファネル分析レポート PROP_ANALYSIS：プロパティ分析レポート PATH_ANALYSIS：フロー分析レポート SQL：SQLレポート INTERVAL_ANALYSIS：インターバル分析レポート
data.creator	-	Object	レポート作成者
openId	UIODASBJ-Jiodas312	String	openId
loginName	user1	String	ログインアカウント
userName	ユーザー1	String	ニックネーム
data.dashboardIds	[109, 91]	List	ダッシュボードID
return_code	0	Integer	リターンコード
return_message	success	String	リターンメッセージ

3. レポートの一括削除

インターフェースURL

/open/report-batch-del?token=xxx&projectId=0

リクエストメソッド

POST

Content-Type

application/json

リクエストQueryパラメータ

パラメータ名	サンプル値	パラメータタイプ	必須	パラメータの説明
token	xxx	String	はい	クエリキー
projectId	0	String	はい	プロジェクトID

リクエストBodyパラメータ

{
    "reportIds": [
        34214
    ]
}

パラメータ名	サンプル値	パラメータタイプ	必須	パラメータの説明
reportIds	[34214]	List	いいえ	レポートIDリスト

成功レスポンスの例

{
    "return_code": 0,
    "return_message": "success"
}

パラメータ名	サンプル値	パラメータタイプ	パラメータの説明
return_code	0	String	リターンコード
return_message	success	String	リターンメッセージ

2. ダッシュボード管理

4. ダッシュボード・レポート管理/ダッシュボードのインポート

インターフェースURL

/open/import-dashboards?token=xxx&projectId=0&dashboardNameConflictPolicy=RENAME_CREATE&spaceDashboardPolicy=IN_EXISTED_SPACE_OR_CREATE_SPACE

リクエストメソッド

POST

Content-Type

application/json

リクエストQueryパラメータ

パラメータ名	サンプル値	パラメータタイプ	必須	パラメータの説明
token	xxx	String	はい	クエリキー
projectId	0	Integer	はい	プロジェクトID
dashboardNameConflictPolicy	RENAME_CREATE	String	はい	ダッシュボード名が競合した場合の処理方針。デフォルト値はRENAME_CREATE RENAME_CREATE：自動で名前を変更 SKIP：スキップ REPLACE：置換
spaceDashboardPolicy	IN_EXISTED_SPACE_OR_CREATE_SPACE	String	はい	共有スペースのダッシュボードの配置方針。デフォルト値はIN_EXISTED_SPACE_OR_CREATE_SPACE CREATE_SPACE：ダッシュボードを新規作成したスペースに配置 IN_EXISTED_SPACE_OR_CREATE_SPACE：ダッシュボードを既存の同名スペース、または新規作成したスペースに配置 IN_PRIVATE：マイダッシュボードに配置

成功レスポンスの例

{
    "data": {
        "boardCreateFailed": 1,
        "boardCreated": 1,
        "boardTotal": 2,
        "folderCreated": 1,
        "reportCreateFailed": 1,
        "reportCreated": 1,
        "reportTotal": 2
    },
    "return_code": 0,
    "return_message": "success"
}

パラメータ名	サンプル値	パラメータタイプ	パラメータの説明
data	-	Object	レスポンスデータ
data.boardCreateFailed	1	Integer	ダッシュボードの作成失敗数
data.boardCreated	1	Integer	ダッシュボードの作成成功数
data.boardTotal	2	Integer	ダッシュボードの総数
data.folderCreated	1	Integer	フォルダーの作成数
data.reportCreateFailed	1	Integer	レポートの作成失敗数
data.reportCreated	1	Integer	レポートの作成数
data.reportTotal	2	Integer	レポートの総数
return_code	0	Integer	リターンコード
return_message	success	String	リターンメッセージ

エラーレスポンスの例

{
    "return_code": -3004,
    "return_message": "無効なプロジェクト"
}

パラメータ名	サンプル値	パラメータタイプ	パラメータの説明
return_code	-3004	String	リターンコード
return_message	無効なプロジェクト	String	リターンメッセージ

5. スペースのダッシュボードの削除

注意

ダッシュボードがAPI呼び出し元によって作成されたものである場合は、そのダッシュボードを削除します。それ以外の場合は、ダッシュボードをスペースから作成者のプライベートディレクトリに移動します。

インターフェースURL

/open/delete-dashboard-from-space?token=xxx&projectId=0&dashboardId=1&spaceId=1

リクエストメソッド

POST

Content-Type

application/json

リクエストQueryパラメータ

パラメータ名	サンプル値	パラメータタイプ	必須	パラメータの説明
token	xxx	String	はい	クエリキー
projectId	0	Integer	はい	プロジェクトID
dashboardId	1	Integer	はい	ダッシュボードID
spaceId	1	Integer	はい	スペースID

成功レスポンスの例

{
    "return_code": 0,
    "return_message": "success"
}

パラメータ名	サンプル値	パラメータタイプ	パラメータの説明
return_code	0	Integer	リターンコード
return_message	success	String	リターンメッセージ

エラーレスポンスの例

{
    "return_code": -1008,
    "return_message": "パラメータエラー、dashboard not in space"
}

パラメータ名	サンプル値	パラメータタイプ	パラメータの説明
return_code	-1008	Integer	リターンコード
return_message	パラメータエラー、dashboard not in space	String	リターンメッセージ

3. スペース管理

6. スペースIDとダッシュボード一覧を照会

インターフェースURL

/open/get-space-dashboards-by-space-name?token=xxx&projectId=377&spaceName=b

リクエストメソッド

GET

Content-Type

application/json

リクエストQueryパラメータ

パラメータ名	サンプル値	パラメータタイプ	必須	パラメータの説明
token	xxx	String	はい	クエリキー
projectId	377	Integer	はい	プロジェクトID
spaceName	b	String	はい	スペース名

成功レスポンスの例

{
    "data": {
        "dashboards": [
            {
                "dashbordId": 3590,
                "dashbordName": "lzm"
            }
        ],
        "spaceId": 31
    },
    "return_code": 0,
    "return_message": "success"
}

パラメータ名	サンプル値	パラメータタイプ	パラメータの説明
data	-	Object	レスポンスデータ
data.dashboards	-	List	ダッシュボード情報
data.dashboards.dashbordId	3590	Integer	ダッシュボードID
data.dashboards.dashbordName	lzm	String	ダッシュボード名
data.spaceId	31	Integer	スペースID
return_code	0	Integer	リターンコード
return_message	success	String	リターンメッセージ

エラーレスポンスの例

{
    "return_code": -1006,
    "return_message": "操作する権限がありません(view space dashboards)"
}

パラメータ名	サンプル値	パラメータタイプ	パラメータの説明
return_code	-1006	Integer	リターンコード
return_message	操作する権限がありません(view space dashboards)	String	リターンメッセージ

7. スペースIDとメンバー権限一覧を照会

インターフェースURL

/open/get-space-members-by-space-name?token=xxx&projectId=377&spaceName=b

リクエストメソッド

GET

Content-Type

application/json

リクエストQueryパラメータ

パラメータ名	サンプル値	パラメータタイプ	必須	パラメータの説明
token	xxx	String	はい	クエリキー
projectId	377	Integer	はい	プロジェクトID
spaceName	b	String	はい	スペース名

成功レスポンスの例

{
    "data": {
        "allAuthUserAuthority": "MEMBER",
        "authUserGroups": [
            {
                "authority": "ADMIN",
                "id": 1301,
                "name": "test1"
            }
        ],
        "authUsers": [
            {
                "authority": "ADMIN",
                "id": 1149,
                "name": "test2"
            }
        ],
        "creator": {
            "id": 928,
            "name": "test3"
        },
        "spaceId": 31
    },
    "return_code": 0,
    "return_message": "success"
}

パラメータ名	サンプル値	パラメータタイプ	パラメータの説明
data	-	Object	レスポンスデータ
data.allAuthUserAuthority	MEMBER	String	全メンバーの権限
data.authUserGroups	-	List	権限グループのリスト
data.authUserGroups.authority	ADMIN	String	権限
data.authUserGroups.id	1301	Integer	ユーザーID
data.authUserGroups.name	test1	String	ユーザー名
data.authUsers	-	List	ユーザーリスト
data.authUsers.authority	ADMIN	String	権限
data.authUsers.id	1149	Integer	ユーザーID
data.authUsers.name	test2	String	ユーザー名
data.creator	-	Object	作成者情報
data.creator.id	928	Integer	作成者のユーザーID
data.creator.name	test3	String	作成者の氏名
data.spaceId	31	Integer	スペースID
return_code	0	Integer	リターンコード
return_message	success	String	リターンメッセージ

エラーレスポンスの例

{
    "return_code": -1006,
    "return_message": "操作する権限がありません(view space members)"
}

パラメータ名	サンプル値	パラメータタイプ	パラメータの説明
return_code	-1006	Integer	リターンコード
return_message	操作する権限がありません(view space members)	String	リターンメッセージ

8. スペースメンバー権限リストの更新

スペース名やスペースのデフォルト権限の更新、スペースメンバーの権限の追加・変更、スペースメンバーグループの権限の追加・変更に使用できます

注意

送信したメンバー権限リストで、元のメンバーリスト全体が置き換えられます

インターフェースURL

/open/update-space?token=xxx&projectId=0&spaceId=0

リクエストメソッド

POST

Content-Type

application/json

リクエストQueryパラメータ

パラメータ名	サンプル値	パラメータタイプ	必須	パラメータの説明
token	xxx	String	はい	クエリキー
projectId	0	Integer	はい	プロジェクトID
spaceId	0	Integer	はい	スペースID

リクエストBodyパラメータ

{
  "allAuthUserAuthority": "MEMBER",
  "authUserGroups": [
    {
      "id": 99,
      "authority": "MEMBER",
      "name": "member99"
    }
  ],
  "authUsers": [
    {
      "id": 88,
      "authority": "ADMIN",
      "name": "admin88"
    }
  ],
  "spaceName": "spaceTest"
}

パラメータ名	サンプル値	パラメータタイプ	必須	パラメータの説明
allAuthUserAuthority	string	String	いいえ	全メンバーの権限 MEMBER：一般メンバー ADMIN：管理者
authUserGroups	-	List	いいえ	ユーザーグループリスト
authUserGroups.id	99	Integer	いいえ	ユーザーグループID
authUserGroups.name	MEMBER	String	いいえ	ユーザーグループ名
authUserGroups.authority	member99	String	いいえ	ユーザーグループの権限 MEMBER：一般メンバー ADMIN：管理者
authUsers	-	List	いいえ	ユーザーリスト
authUsers.id	88	Integer	いいえ	ユーザーID
authUsers.name	ADMIN	String	いいえ	ユーザーの氏名
authUsers.authority	admin88	String	いいえ	ユーザーの権限 MEMBER：一般メンバー ADMIN：管理者
spaceName	spaceTest	String	いいえ	スペース名

成功レスポンスの例

{
    "return_code": 0,
    "return_message": "success"
}

パラメータ名	サンプル値	パラメータタイプ	パラメータの説明
return_code	0	Integer	リターンコード
return_message	success	String	リターンメッセージ

エラーレスポンスの例

{
    "return_code": -1023,
    "return_message": "ダッシュボードスペースが存在しません"
}

パラメータ名	サンプル値	パラメータタイプ	パラメータの説明
return_code	-1023	Integer	リターンコード
return_message	ダッシュボードスペースが存在しません	String	リターンメッセージ

9. スペースの削除

インターフェースURL

/open/delete-space?token=xxx&projectId=0&spaceId=1

リクエストメソッド

POST

Content-Type

application/json

リクエストQueryパラメータ

パラメータ名	サンプル値	パラメータタイプ	必須	パラメータの説明
token	xxx	String	はい	クエリキー
projectId	0	Integer	はい	プロジェクトID
spaceId	1	Integer	はい	スペースID

成功レスポンスの例

{
    "return_code": 0,
    "return_message": "success"
}

パラメータ名	サンプル値	パラメータタイプ	パラメータの説明
return_code	0	Integer	リターンコード
return_message	success	String	リターンメッセージ

エラーレスポンスの例

{
    "return_code": -1023,
    "return_message": "ダッシュボードスペースが存在しません"
}

パラメータ名	サンプル値	パラメータタイプ	パラメータの説明
return_code	-1023	Integer	リターンコード
return_message	ダッシュボードスペースが存在しません	String	リターンメッセージ

4. ダッシュボードプッシュ

10. ダッシュボードプッシュの実行

プッシュ情報を設定済みのダッシュボードであれば、定期プッシュを有効にしているかどうかにかかわらず、APIからプッシュを実行できます。画面で設定したチャネル、内容、スタイル、およびダッシュボード作成者のデータ権限に基づいて、プッシュタスクが即時に実行されます。会社レベルとプロジェクトレベルのtokenのみ使用できます。

インターフェースURL

/open/dashboard/daily-report/exec

リクエストメソッド

POST

Content-Type

application/json

リクエストQueryパラメータ

パラメータ名	サンプル値	パラメータタイプ	必須	パラメータの説明
token	xxx	String	はい	クエリキー
dashboardId	1	Integer	はい	ダッシュボードID

tokenの種類の制限

ダッシュボードプッシュAPIは会社レベルとプロジェクトレベルのtokenでのみ使用でき、個人レベルのtokenには対応していません

成功レスポンスの例

{"return_code": 0,"return_message": "success"}

パラメータ名	サンプル値	パラメータタイプ	パラメータの説明
return_code	0	Integer	リターンコード
return_message	success	String	リターンメッセージ

エラーレスポンスの例

{"return_code": -1,"return_message": "有効なプッシュチャネルがありません。ダッシュボード-ダッシュボードプッシュで設定してください"}

パラメータ名	サンプル値	パラメータタイプ	パラメータの説明
return_code	-1	Integer	リターンコード
return_message	有効なプッシュチャネルがありません。ダッシュボード-ダッシュボードプッシュで設定してください	String	リターンメッセージ

このページは役に立ちましたか？

1. レポート管理​

1. Rootアカウントのレポート一覧を照会​

2. プロジェクトのレポート一覧を照会​

3. レポートの一括削除​

2. ダッシュボード管理​

4. ダッシュボード・レポート管理/ダッシュボードのインポート​

5. スペースのダッシュボードの削除​

3. スペース管理​

6. スペースIDとダッシュボード一覧を照会​

7. スペースIDとメンバー権限一覧を照会​

8. スペースメンバー権限リストの更新​

9. スペースの削除​

4. ダッシュボードプッシュ​

10. ダッシュボードプッシュの実行​

1. レポート管理

1. Rootアカウントのレポート一覧を照会

2. プロジェクトのレポート一覧を照会

3. レポートの一括削除

2. ダッシュボード管理

4. ダッシュボード・レポート管理/ダッシュボードのインポート

5. スペースのダッシュボードの削除

3. スペース管理

6. スペースIDとダッシュボード一覧を照会

7. スペースIDとメンバー権限一覧を照会

8. スペースメンバー権限リストの更新

9. スペースの削除

4. ダッシュボードプッシュ

10. ダッシュボードプッシュの実行