ジョブ同期ステータスのリスト

get

/cdi/integrations/{integration_id}/job_sync_status

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

note:

このエンドポイントを使用するには、cdi.integration_job_status 権限を持つ API キーを生成する必要があります。

レート制限

パスパラメーター

パラメータ required データ型説明

integration_id 必須文字列統合 ID。

クエリーパラメーター

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

パラメータ required データ型説明

cursor オプション文字列同期ステータスのページネーションを決定します。

例のリクエスト

カーソルなし

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'

カーソル付き

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 は、次の応答本文を返す可能性があります。

note:

Link ヘッダーは、合計10回以下の同期がある場合には存在しません。カーソルのない呼び出しでは、prev は表示されません。項目の最後のページを見ると、next は表示されません。

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"

{
  "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 が有効であることを確認します。

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

GitHub でこのページを編集

「このページはどの程度役に立ちましたか?」

GitHub でこのページを編集

New Stuff!