メインコンテンツへスキップ
GET
curl

概要

ユーザーのAMLモニタリングを切り替えるまたは企業のAMLモニタリングを切り替えるから開始した継続的なAMLモニタリングのジョブを返します。返される内容は、ジョブのステータス、結果ごとのカウンター、および処理済みのユーザーまたは企業1件につき1つのresultsエントリです。 20件を超えるプロファイルを選択した場合はバックグラウンドで実行され、切り替えリクエストはPENDINGのジョブとともに202を返します。statusがCOMPLETEDまたはFAILEDになるまで、このエンドポイントを数秒ごとにポーリングしてください。resultsはプロファイルが処理されるたびに処理順で追加され、ジョブがCOMPLETEDになった時点ですべて揃います。レコードごとの結果が記録されるのはAPIから開始したジョブのみで、Business Consoleから開始したジョブはカウンターのみを報告します。

ジョブのステータス

レコードごとのoutcomeの値は、トグルの各ページに記載されています。

権限

アプリケーションの有効なAPIキーであれば、どれでもこのエンドポイントを呼び出せます。ジョブはそれを作成したアプリケーションからのみ参照でき、他のアプリケーションが作成したjob_idでは404が返されます。

関連ページ

承認

x-api-key
string
header
必須

お客様のアプリケーションのAPIキーです。Business ConsoleのDevelopers -> API keysで取得できます。プライマリキーはフルアクセス権を持ちます。名前付きキーにはスコープを設定できます。リソースごとのアクセス権(なし、読み取り、書き込み)、一部のワークフローまたは承認済みセッションへの限定、IPアドレスのリストへの限定、有効期限の設定です。401は、キーが誤っている、失効している、または期限切れであることを意味します。403は、キーが送信されていない、キーにこのリソースやアクションへのアクセス権がない、またはIPリスト外のアドレスからリクエストが送信されたことを意味します。セッションのルートでの404は、セッションがキーのワークフローまたはステータスの対象外であることを意味します。メディアへのアクセス権がないキーでは、画像、動画、PDFのURLがnullで返されます。セッションの書き込み権限がないキーでは、セッションのリンクとトークンがnullで返されます。詳細は次を参照してください: https://docs.didit.me/console/api-keys

パスパラメータ

job_id
string<uuid>
必須

トグルエンドポイントが返したjob_idです。

レスポンス

ジョブです。

job_id
string<uuid>
status
enum<string>
利用可能なオプション:
PENDING,
PROCESSING,
COMPLETED,
FAILED
is_enabled
boolean

ジョブがモニタリングを有効にする場合はtrue、無効にする場合はfalseです。

target_type
enum<string>

ジョブが切り替えるプロファイルの種類。

利用可能なオプション:
user,
business
total
integer

ジョブが処理するプロフィール。

processed
integer

これまでに処理されたプロフィール。

outcomes
object

レコードごとの結果カウンターです。選択された各プロフィールは必ずいずれか1つのカウンターに集計され、黙ってスキップされるものはありません。

results
object[]

処理されたプロファイルごとに処理順で1エントリー。ジョブの実行中に増えていき、ステータスがCOMPLETEDになった時点で完全になります。APIから開始したジョブについて記録されます。Business Consoleから開始したジョブはカウンターのみを報告します。

error
string | null

ステータスがFAILEDの場合の汎用的な失敗メッセージ。詳細な原因はプラットフォーム側で保持されます。

created_at
string<date-time>
completed_at
string<date-time> | null
最終更新日 2026年11月1日