排序和篩選流量服務API中的回應

在流量服務API中執行清單(GET)請求時，您可以使用查詢參數來排序和篩選回應。 本指南提供如何針對不同使用案例使用這些參數的參考資料。

排序

您可以使用orderby查詢參數來排序回應。 可在API中排序下列資源：

• 連線
• 源連接
• 目標連線
• 流量
• 執行

若要使用參數，必須將其值設定為您要排序的特定屬性（例如?orderby=name）。 您可以在值的開頭加上升順序的加號(+)，或以下降順序的加號(-)。 如果未提供排序前置詞，則清單預設會以升序排序。

GET /flows?orderby=name
GET /flows?orderby=-name

您也可以使用"and"符號(&)，將排序參數與篩選參數結合。

GET /flows?property=state==enabled&orderby=createdAt

篩選

您可以使用property參數搭配機碼值運算式來篩選回應。 例如， ?property=id==12345僅傳回其id屬性恰好等於12345的資源。

只要已知該屬性的有效路徑，則可通常對實體中的任何屬性套用篩選。

返回源表名為的所有源連 lead接：

GET /sourceConnections?property=params.tableName==lead

傳回特定區段ID的所有流量：

GET /flows?property=transformations[].params.segmentSelectors.selectors[].value.id==5722a16f-5e1f-4732-91b6-3b03943f759a

合併篩選器

若多個property篩選器以"and"字元(&)分隔，則可納入查詢中。 合併篩選器時會假設為AND關係，這表示實體必須滿足所有篩選器，才能將其納入回應中。

傳回區段ID的所有已啟用流程：

GET /flows?property=transformations[].params.segmentSelectors.selectors[].value.id==5722a16f-5e1f-4732-91b6-3b03943f759a&property=state==enabled

篩選陣列屬性

您可以將[]附加至陣列屬性的名稱，以根據陣列內項目的屬性進行篩選。

與特定源連接關聯的返回流：

GET /flows?property=sourceConnectionIds[]==9874984,6980696

具有包含特定選擇器值ID之轉換的傳回流：

GET /flows?property=transformations[].params.segmentSelectors.selectors[].value.id==5722a16f-5e1f-4732-91b6-3b03943f759a

返回具有特定值的列的源 name 連接：

GET /sourceConnections?property=params.columns[].name==firstName

依區段ID篩選，以查找目的地的流程執行ID:

GET /runs?property=metrics.recordSummary.targetSummaries[].entitySummaries[].id==segment:068d6e2c-b546-4c73-bfb7-9a9d33375659

count

任何篩選查詢都可附加count查詢參數，其值為true，以傳回結果計數。 API回應包含count屬性，其值代表篩選項目總數的計數。 此呼叫不會傳回實際篩選的項目。

返回系統中已啟用流的計數：

GET /flows?property=state==enabled&count=true

對上述查詢的回應如下所示：

{
  "count": 95
}

可按資源篩選的屬性

根據要檢索的流服務實體，可以使用不同的屬性進行篩選。 下表劃分了篩選使用案例中常用的每個資源的根級別欄位。

connectionSpec

flowSpec

connection

sourceConnection

targetConnection

flow

run

後續步驟

本指南說明如何使用orderby和property查詢參數來排序和篩選流量服務API中的回應。 如需如何在Platform中使用API進行常見工作流程的逐步指南，請參閱sources和destinations檔案中的API教學課程。