リストの統合
get
/cdi/integrations
既存の統合のリストを返すには、このエンドポイントを使う。
note:
このエンドポイントを使用するには、cdi.integration_list
権限を持つ API キーを生成する必要があります。
レート制限
クエリーパラメーター
このエンドポイントを呼び出すと、10個のアイテムが返される。10を超える統合のあるリストについては、応答の例に示すように、Link
ヘッダーを使用して次のページのデータを取得します。
パラメーター | required | データ型 | 説明 |
---|---|---|---|
cursor |
オプション | string | 統合リストのページネーションを決定する。 |
リクエスト例
カーソルなし
1
2
3
curl --location --request GET 'https://rest.iad-03.braze.com/cdi/integrations' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'
カーソル付き
1
2
3
curl --location --request GET 'https://rest.iad-03.braze.com/cdi/integrations?cursor=c2tpcDow' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'
応答
成功応答の例
ステータスコード 200
は、次の応答本文を返す可能性があります。
note:
Link
ヘッダーは、統合の合計が10以下の場合は存在しません。カーソルのない呼び出しでは、prev
は表示されません。項目の最後のページを見ると、next
は表示されません。
1
Link: </cdi/integrations?cursor=c2tpcDow>; rel="prev",</cdi/integrations?cursor=c2tpcDoxMDA=>; rel="next"
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
"results": [
{
"integration_id": (string) integration ID,
"app_group_id": (string) app group ID,
"integration_name": (string) integration name,
"integration_type": (string) integration type,
"integration_status": (string) integration status,
"contact_emails": (string) contact email(s),
"last_updated_at": (string) last timestamp that was synced in ISO 8601,
"warehouse_type": (string) data warehouse type,
"last_job_start_time": (string) timestamp of the last sync run in ISO 8601,
"last_job_status": (string) status of the last sync run,
"next_scheduled_run": (string) timestamp of the next scheduled sync in ISO 8601,
},
],
"message": "success"
}
トラブルシューティング
以下の表は、返される可能性のあるエラーと、それに関連するトラブルシューティングの手順を示したものである。
エラー | トラブルシューティング |
---|---|
400 Invalid cursor |
cursor が有効であることを確認する。 |
その他のステータスコードと関連するエラーメッセージについては、致命的なエラーとレスポンスを参照してください。
New Stuff!