[ベータ版]データマート定義一覧取得
    • PDF

    [ベータ版]データマート定義一覧取得

    • PDF

    Article summary

    Get
    /api/datamart_definitions

    [注意]ベータ版のAPIエンドポイントであるため、リクエスト・レスポンスデータが変更される可能性があります。
    データマート定義一覧を取得します。

    Security
    API Key
    Header parameter nameAuthorization

    認証キーとなるAPI KEYをAuthorization: Token {{API KEY}}の形式でヘッダーにセットします。
    API KEYがabc123の場合は、Authorization: Token abc123とします。
    API KEYの作成方法は、trocco APIについてを参照ください。

    Query parameters
    limit
    integer (int64)

    取得するデータマート定義の最大件数を指定します。

    Maximum200
    Default"50"
    cursor
    string

    取得するデータマート定義一覧の最初のレコードを示すページネーションカーソルを指定します。
    レスポンスに含まれるnext_cursorをセットすると、後続のデータマート定義一覧を取得できます。

    ExampleeyJpZCI6MjF9
    Responses
    200

    データマート定義一覧を返します。

    Expand All
    object
    items
    Array of object
    object
    id
    integer (int64)

    データマート定義IDです。

    Example1
    name
    string

    データマート定義名です。

    Exampletest
    description
    string

    メモです。

    Exampledesc
    data_warehouse_type
    string

    データウェアハウスタイプ名です。

    Valid values[ "bigquery", "redshift", "snowflake" ]
    Examplebigquery
    created_at
    string

    データマート定義の作成日時です。タイムゾーンはJST 日本時間(GMT+9)です。

    Example2023-08-23T03:00:00.000+09:00
    updated_at
    string

    データマート定義の更新日時です。タイムゾーンはJST 日本時間(GMT+9)です。

    Example2023-08-23T03:00:00.000+09:00
    next_cursor
    string

    後続のページネーションリクエストの取得開始レコードを示すカーソル値です。

    401

    Not authenticated.
    認証エラーです。API KEYをご確認ください。


    Was this article helpful?