セグメント一覧取得APIを開発したい

セグメント一覧取得APIとは

本APIの概要

セグメント一覧取得APIとは、貴社の基幹システム/アプリケーションとb→dashを繋ぐことでb→dash管理画面上の複数のセグメントデータの情報を一覧で取得することができるAPIです。

貴社の基幹システム/アプリケーションに直接セグメントの情報を一覧で取得したい場合は、本API仕様書をご参照のもと貴社開発環境に実装してください。

本APIで取得できるb→dash管理画面上のデータ

b→dash管理画面と同等の操作

セグメント一覧取得APIで一覧取得できるセグメントの情報は、以下のb→dash管理画面（「セグメント一覧画面」「セグメント詳細画面」）で確認できる「セグメント名」「ステータス」「最終更新日時」「セグメントで利用しているデータファイルのID」と、各セグメント詳細画面のURLから確認できる「セグメントファイルID」の5項目になります。

セグメント一覧画面（セグメント名/ステータス/最終更新日時）の例

セグメント詳細画面（セグメントで利用しているデータファイルのID）の例

セグメント詳細画面URL（セグメントファイルID）の例

本API利用にあたっての前提事項

事前準備

セグメント用データの作成

セグメント一覧取得APIを利用する事前準備として、b→dash管理画面上でセグメント用データを作成する必要があります。

セグメントアプリ上でセグメント用データの作成がまだ完了していない場合は「セグメントを作成したい」をご参照の上、設定を完了させてください。

共通仕様

APIでは、b→dash APIの共通仕様も参照する必要があります。共通仕様の詳細については「b→dash APIの共通仕様を知りたい」をご参照ください。

セグメント一覧取得APIの仕様

処理フロー図

セグメント一覧取得APIの処理フロー図は以下になります。

セグメント一覧取得リクエスト

〇セグメント一覧取得APIのURI

〇リクエスト形式

GET https://api.smart-bdash.com/api/v1/segments

セグメント一覧取得レスポンス

リクエストに成功すると、下記のレスポンス形式でセグメント一覧APIのレスポンスが返されます

〇レスポンスボディパラメータ

【レスポンスボディサンプル】

{
  "result": {
    "code": 200,
    "segments": [
      {
        "id": "10001",
        "name": "セグメントＡ",
        "status": 1,
        "datafile_ids": [1],
        "lastmodified": "2022/06/30 07:00:00"
      },
      {
        "id": "10002",
        "name": "セグメントＢ",
        "status": 2,
        "datafile_ids": [1,2,3],
        "lastmodified": "2021/12/31 23:59:59"
      }
    ]
  }
}