Skip to content

インテグレーションを一覧表示

get

/cdi/integrations

このエンドポイントを使用して、既存のインテグレーションのリストを返します。

レート制限

This endpoint has a rate limit of 50 requests per minute.

クエリパラメーター

このエンドポイントを呼び出すたびに、10 個の項目が返されます。インテグレーションが 10 個を超えるリストの場合は、レスポンス例に示すように、Linkヘッダーを使用して次のページのデータを取得します。

パラメーター 必須 データ型 説明
cursor オプション 文字列 統合リストのページネーションを決定します。

リクエスト例

カーソルなし

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ステータスコードは次のレスポンスボディを返す可能性があります。

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 あなたのが有効であることを確認してください。

その他のステータスコードおよび関連するエラーメッセージについては、「致命的なエラーとレスポンス」を参照してください。

  GitHub でこのページを編集
「このページはどの程度役に立ちましたか?」
New Stuff!