API v3 ではフィルターを使用して特定の結果を取得できます。

GET /tickets APIでチケット一覧を取得する際のフィルターには特別な制限があります。詳細と利用可能なすべてのオプションについてはこちらの記事をご覧ください。

シンプルフィルター

シンプルフィルターを使用すると、特定のカラムの正確な値で結果をフィルタリングできます:

{"parameter":"value"}

このシンプルフィルターにより、例えばステータスが「新規」のチケットを取得できます:

_filters:{"status":"N"}

カンマで区切ることで、フィルター内に複数の条件を組み合わせることもできます。例えば、コンタクトから特定のIDの企業に属する男性を検索する場合:

_filters={"gender":"M","company_id":"123abc"}

シンプルフィルターでは、パラメーターの特定の値のみを検索でき、演算子の定義や日付範囲の使用はできません。演算子の定義や日付範囲での結果検索には、アドバンスドフィルターを使用してください。

アドバンスドフィルター

アドバンスドフィルターの形式では、シンプルフィルターの2つの値ではなく、3つの値が必要です:

[["parameter","operator","value"]]

演算子が使用されています。アドバンスドフィルターを使用すると、例えば今週作成されたチケットのみ、または削除されていないすべてのチケットを検索できます:

_filters=[["date_created","DP","TW"]]
_filters=[["status","NI","X,B"]]

カンマで区切ることで、複数の条件を1つのフィルターに組み合わせることもできます。例えば、先月作成されたすべての保留中チケットを検索する場合:

_filters=[["status","E","W"],["date_created","DP","LM"]]

アドバンスド検索で使用される演算子

すべてのアドバンスドフィルターで以下の演算子を使用できます:

ブール演算子
演算子 説明 使用例
L 類似（Like） [[“tags”,“L”,“3bg4”]]
NL 非類似（Not like） [[“field_player_id”,“NL”,“007”]]
E 等しい（Equals） [[“status”,“E”,“N”]]
NE 等しくない（Not equals） [[“field_player_id”,“NE”,“007”]]
CY いずれかを含む（Contains any of） [[“tags”,“CY”,“3bg4,9aue”]]
IN 含まれる（Is in） [[“departmentid”,“IN”,“8ld2hdk5,klt0srua”]]
NI 含まれない（Not in） [[“departmentid”,“NI”,“default,8ld2hdk5”]]
IE 空である（Is empty） [[“company_id”,“IE”,""]]
INE 空でない（Is not empty） [[“company_id”,“INE”,""]]
数値演算子
演算子 説明 使用例
= 等しい [[“id”,"=",“209”]]
> より大きい [[“id”,">",“200”]]
< より小さい [[“id”,"<",“51”]]
>= 以上 [[“id”,">=",“78”]]
<= 以下 [[“id”,"<=",“3”]]
日付・時刻演算子
演算子 説明 使用例
D= 日付が等しい [[“date_created”,“D=”,“2011-11-11”]]
D> 日付がより大きい [[“date_changed”,“D>”,“2023-01-01 13:00:00”]]
D< 日付がより小さい [[“date_created”,“D<”,“2022-12-31”]]
D>= 日付が以上 [[“last_activity”,“D>=”,“2023-12-24 7:00:00”]]
D<= 日付が以下 [[“date_resolved”,“D<=”,“2022-11-30”]]
T= 時刻が等しい
T> 時刻がより大きい
T< 時刻がより小さい
T>= 時刻が以上
T<= 時刻が以下
DP 日付範囲 [[“date_created”,“DP”,“TW”]]
日付範囲の値
値 説明 使用例
T 今日 [[“date_created”,“DP”,“T”]]
Y 昨日 [[“date_created”,“DP”,“Y”]]
L7D 過去7日間 [[“date_created”,“DP”,“L7D”]]
L30D 過去30日間 [[“date_created”,“DP”,“L30D”]]
L90D 過去90日間 [[“date_created”,“DP”,“L90D”]]
TW 今週 [[“date_created”,“DP”,“TW”]]
LW 先週 [[“date_created”,“DP”,“LW”]]
L2W 過去2週間 [[“date_created”,“DP”,“L2W”]]
LWW 先週の平日 [[“date_created”,“DP”,“LWW”]]
TM 今月 [[“date_created”,“DP”,“TM”]]
LM 先月 [[“date_created”,“DP”,“LM”]]
TY 今年 [[“date_created”,“DP”,“TY”]]
LY 昨年 [[“date_created”,“DP”,“LY”]]