LogicMonitorのRESTAPIを使用して、LogicMonitorレポートグループに関する情報をプログラムで取得できます。 レポートグループのリストを取得することも、特定のレポートグループの詳細を取得することもできます。
すべてのAPI呼び出しと同様に、 認証が必要です.
レポートのリストを返します
HTTPメソッド:GET
URI:/ report / groups
リクエストパラメータ: デフォルトでは、50のレポートグループのリストが返されます。 リクエストに並べ替え、フィルター、フィールド、サイズ、オフセットのパラメーターを含めて、応答に含まれるデータとそのフォーマット方法を制御できます。 すべてのクエリパラメータは、必要に応じてURLエンコードする必要があることに注意してください。 さらに、クエリパラメータはリソースパスの一部とは見なされず、LMv1認証署名の計算に含めるべきではないことに注意してください。
プロパティ
|
構文
|
説明
|
URIの例
|
sort |
sort = {+または-} property |
昇順(+)または降順(-)のいずれかで指定されたプロパティで応答を並べ替えます |
/ report / groups?sort = + name |
filter
|
filter = property {operator} value |
指定された演算子と値に従って応答をフィルタリングします。 *を使用して複数の文字に一致させることができることに注意してください。「。」を使用できます。 オブジェクト内の値(カスタムプロパティなど)をフィルタリングする文字。複数のフィルターはコンマで区切ることができます。
演算子は次のとおりです。
- 以上: >:
- 以下: <:
- 大なり記号: >
- 未満: <
- 等しくない: !:
- 等しい: :
- 含まれていません: !~
- 以下の構成です: ~
|
/ report / groups?filter = name:Prod%20alerts |
フィールド |
fields = {コンマで区切られたプロパティのリスト} |
応答をフィルタリングして、各オブジェクトの次のフィールドのみを含めます |
/ report / groups?fields = name、reportsCount |
サイズ |
size = integer |
表示する結果の数。 最大は1000です。 |
/ report / groups?size = 5 |
オフセット |
offset = integer |
表示された結果を相殺する結果の数 |
/ report / groups?offset = 2 |