Skip to content

ジョブ同期ステータスの一覧

get

/cdi/integrations/{integration_id}/job_sync_status

このエンドポイントを使用して、指定された統合の過去の同期ステータスの一覧を返します。

レート制限

このエンドポイントには、1分あたり100リクエストのレート制限があります。

パスパラメーター

パラメーター 必須 データタイプ 説明
integration_id 必須 文字列 統合 ID。

クエリパラメーター

このエンドポイントへの各呼び出しでは、10件のアイテムが返されます。10件を超える同期がある統合については、以下の応答例に示すように、Link ヘッダーを使用して次のページのデータを取得してください。

パラメーター 必須 データタイプ 説明
cursor オプション 文字列 同期ステータスのページネーションを決定します。

リクエスト例

カーソルなし

1
2
3
curl --location --request GET 'https://rest.iad-03.braze.com/cdi/integrations/00000000-0000-0000-0000-000000000000/job_sync_status' \
--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/00000000-0000-0000-0000-000000000000/job_sync_status?cursor=c2tpcDow' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'

応答

成功応答の例

ステータスコード 200 は、以下の応答本文を返す可能性があります。

1
Link: </cdi/integrations/00000000-0000-0000-0000-000000000000/job_sync_status?cursor=c2tpcDow>; rel="prev",</cdi/integrations00000000-0000-0000-0000-000000000000/job_sync_status?cursor=c2tpcDoxMDA=>; rel="next"
1
2
3
4
5
6
7
8
9
10
11
12
13
{
  "results": [
    {
        "job_status": (string) status of the sync, see below for explanation of different statuses,
        "sync_start_time": (string) time the sync started in ISO 8601,
        "sync_finish_time": (string) time the sync finished in ISO 8601,
        "last_timestamp_synced": (string) last UPDATED_AT timestamp processed by the sync in ISO 8601,
        "rows_synced": (integer) number of rows successfully synced to Braze,
        "rows_failed_with_errors": (integer) number of rows failed because of errors
    }
  ],
  "message": "success"
}
job_status 説明
running ジョブは現在実行中です。
success すべての行が正常に同期されました。
partial 一部の行はエラーのため同期に失敗しました。
error 行は同期されませんでした。
config_error 統合設定にエラーがありました。統合のセットアップを確認してください。

トラブルシューティング

以下のテーブルに、返される可能性のあるエラーと、関連するトラブルシューティングステップを示します。

エラー トラブルシューティング
400 Invalid cursor cursor が有効であることを確認してください。
400 Invalid integration ID integration_id が有効であることを確認してください。

その他のステータスコードと関連するエラーメッセージについては、致命的なエラーと応答を参照してください。

New Stuff!