Datasets - Execute Dax Queries

指定されたデータセットに対してデータ分析式 (DAX) クエリを実行します。 データセットは マイ ワークスペースに存在する必要があります。 応答は Apache Arrow 形式で返されます。

アクセス許可またはクエリ エラーの結果は次のようになります。

• XMLA endpoint feature is disabled. Turn on the tenant setting 'Allow XMLA endpoints and Analyze in Excel with on-premises semantic models' to enable this feature.などの応答エラー。
• エラーの詳細を含むレコード バッチを含む成功した HTTP 状態コード (200)。

Permissions

統合設定の下にあるテナント設定データセット実行クエリ REST API を有効にする必要があります。

ユーザーには、データセットの読み取りとビルドのアクセス許可が必要です。 詳細については、「 データセットアクセス許可の管理」を参照してください。

必要なスコープ

Dataset.ReadWrite.All または Dataset.Read.All

Limitations

• この API は、容量でホストされているデータセットでのみ使用できます。
• Azure Analysis Services でホストされているデータセット、またはオンプレミスの Azure Analysis Services モデルへのライブ接続を持つデータセットはサポートされていません。
• API 呼び出しごとに 1 つのクエリが、クエリに複数の evaluate ステートメントを含めることができます。
• クエリを実行するデータセットに関係なく、ユーザーごとに 1 分あたり 120 クエリ要求の制限があります。
• サービス プリンシパルを使用するには、[開発者設定] の [サービス プリンシパルによる Power BI API の使用をサービス プリンシパルに許可する] 設定が有効になっていることを確認します。 RLS を使用したセマンティック モデルの詳細については、 RLS の制限事項を参照してください。
• 現時点では、DAX クエリと INFO 関数のみがサポートされています。 MDX クエリと DMV クエリはサポートされていません。

応答形式

応答本文には、1 つ以上の連結された Apache Arrow IPC ストリームが含まれています。 各ストリームは、独自のスキーマとレコード バッチで自己完結型です。 応答を処理するには、 Apache Arrow クライアント ライブラリを使用します。

応答には、スキーマ レベルのメタデータ (方向スキーマのキーと値のペア) によって識別される、次の行セット型が含まれる場合があります。

• データ行セット: クエリ結果が含まれます。 特別なメタデータ キーはありません。 列名と型は、DAX クエリによって決まります。
• エラー行セット: スキーマ メタデータ内の IsError = true によって識別されます。 ErrorCode、ErrorMessage、ErrorDescription、ソースの場所の各フィールドの列が含まれます。 スキーマ メタデータには、 FaultCode (16 進数のエラー コード) と FaultString (エラー メッセージ) も含まれます。

応答でバッチを記録する場合は、圧縮LZ4_FRAME使用します。 pyarrow ライブラリはこれを自動的に処理します。 .NETの場合は、Apache.Arrow.Compression NuGet パッケージをインストールします。

次のPython例は、pyarrow を使用してデータを読み取り、エラーを確認する方法を示しています。

import io
import pyarrow as pa

# response = requests.post(url, headers=headers, json=request_body)
stream = io.BytesIO(response.content)
results = []

while stream.tell() < len(response.content):
    try:
        reader = pa.ipc.open_stream(stream)
        table = reader.read_all()
        metadata = {
            k.decode(): v.decode()
            for k, v in (reader.schema.metadata or {}).items()
        }
        if metadata.get("IsError") == "true":
            raise RuntimeError(
                f"Query error [{metadata.get('FaultCode')}]: "
                f"{metadata.get('FaultString')}"
            )
        else:
            results.append(table)
    except pa.ArrowInvalid:
        break

print(results[0].to_pandas())

.NETの場合は、ストリーム解析、エラー検出、LZ4 展開を処理するこの SDK の DaxQueryArrowResponseReader クラスを使用します。

POST https://api.powerbi.com/v1.0/myorg/datasets/{datasetId}/executeDaxQueries

URI パラメーター

要求本文

応答

例

Execute query with culture

POST https://api.powerbi.com/v1.0/myorg/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/executeDaxQueries

{
  "query": "EVALUATE ROW(\"Formatted Date\", FORMAT(DATE(2024, 12, 31), \"Long Date\"))",
  "culture": "en-US"
}

Execute query with custom data

POST https://api.powerbi.com/v1.0/myorg/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/executeDaxQueries

{
  "query": "EVALUATE FILTER('Sales', 'Sales'[Region] = CUSTOMDATA())",
  "customData": "North America"
}

Execute query with effective username

POST https://api.powerbi.com/v1.0/myorg/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/executeDaxQueries

{
  "query": "EVALUATE SUMMARIZECOLUMNS('Sales'[Region], \"Total\", SUM('Sales'[Amount]))",
  "effectiveUsername": "user@contoso.com",
  "roles": [
    "SalesRole"
  ],
  "queryTimeout": 300
}

Execute simple DAX query

POST https://api.powerbi.com/v1.0/myorg/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/executeDaxQueries

{
  "query": "EVALUATE VALUES('Product'[Category])",
  "queryTimeout": 600,
  "schemaOnly": false,
  "resultSetRowCountLimit": 100000
}

定義

DatasetExecuteDaxQueriesRequest

データセットに対してクエリを実行する要求