説明
チケット別アクションログAPIは、アクション、アクションの所有者、タイムスタンプ、データ更新などの詳細を含む、チケット関連のアクション履歴を共有します。これにより、管理者およびカスタマーサービスリーダーは、チケットの過程を分析し、エスカレーションを管理し、エージェントのパフォーマンスを監査し、エージェントのアクションとチケットのライフサイクルを正確に把握できます。
エンドポイント:
https://api.helpshift.com/v2/<domain>/issues/<issue-id>/_audit_logs
メソッド:Get
パス変数:
| 変数 | 説明 | 例 |
| <domain> | ドメイン名 | amazon |
| <issue-id> | 監査ログを取得したいチケットの公開ID | 3423 |
たとえば、URLは次のようなものになるはずです。
https://api.helpshift.com/v2/amazon/issues/3423/_audit_logs
リクエストパラメータ:
| Param | 説明 | 必須ですか? | 例 |
| sort_order | 文字列値。このパラメータは、action_taken_atタイムスタンプでソート順を指定します。有効な値は、「asc」と「desc」(昇順と降順)です。 指定がない場合、デフォルトは降順です。 | いいえ | “asc“ |
| actions | 文字列のJson配列。このパラメーターは、チケットに対して行われたアクションを指定します。このパラメーターが渡されると、レスポンスにはそれらのアクションのログのみが含まれます。デフォルトでは、すべてのアクションのログが含まれます。 考えられるアクションのリストはこちらに記載されています。 | いいえ | create-issue,add-tags |
| since | Unixタイムスタンプ(ミリ秒単位)。このパラメータは、アクションが発生した時刻を指定します。この時刻以降の監査ログがチケットに対して取得されます。 | いいえ | 1754768308863 |
| until | Unixタイムスタンプ(ミリ秒単位)。このパラメータは、アクションが発生した時刻を指定します。この時刻までの監査ログがチケットに対して取得されます。 | いいえ | 1754868308000 |
| page | 要求されているページ番号を示す整数値。ページネーションに使用されます。 | いいえ | 3 |
| page_size | ページごとに返す最大結果数。値は1~500の間です。 何も渡されなかった場合、または上記の範囲外のものが渡された場合は、デフォルトである200がpage_sizeとして使用されます。 | いいえ | 50 |
応答:
| フィールド | 説明 |
| action_taken_at | アクションが実行されたときのタイムスタンプ |
| action | 実行されたアクション。例:create-issue、add-tags、resolveなど |
| actor | アクションを実行した人物を識別します。これは、アクターの名前、メール、および役割を含むJSONオブジェクトとして表されます。アクターがエンドユーザーの場合、uidフィールドも含まれる場合があります(利用可能な場合)。 注意: エンドユーザーの場合、名前、メールアドレス、または uid フィールドは、利用可能なデータによっては存在しない場合があります。 from_data アクションが発生する前のオブジェクトの状態 to_data アクションが発生した後のオブジェクトの状態 サンプル回答: |

