filter#

Autogenerated API

argus_api.lib.eventfilters.v1.filter.error_stats(includeDetails: bool = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Fetch filter error statistics (INTERNAL)

Parameters

  • includeDetails (bool) – If true, include detailed error statistics per processing node

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.eventfilters.v1.filter.get(id: int, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Fetch filter (INTERNAL)

Parameters

  • id (int) – ID of filter to fetch

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.eventfilters.v1.filter.hit_stats(period: int = 3600000, includeDetails: bool = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Fetch filter error statistics (INTERNAL)

Parameters

  • period (int) – Time period to fetch hit stats for (milliseconds)

  • includeDetails (bool) – If true, include details about hits per processing node

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.eventfilters.v1.filter.list(search: str = None, customerID: int = None, type: str = None, limit: int = 25, offset: int = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

List filters (INTERNAL)

Parameters

  • search (str) – Limit result to filters matching this searchstring

  • customerID (list) – Limit result to filters for this customerID

  • type (str) – Limit result to filters of this type

  • limit (int) – Limit result

  • offset (int) – Offset result

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.eventfilters.v1.filter.move_filter(id: int, customer: str = None, _global: bool = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Move an eventfilter to another customer (INTERNAL)

Parameters

  • id (int) – ID of event filter

  • customer (str) – ID or shortname of customer to move filter to. Required unless global is true.

  • global (bool) – Set to true to move filter to a global filter. If true, customer cannot be specified.

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.eventfilters.v1.filter.revisions(id: int, limit: int = 25, offset: int = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Fetch filter revisions by filter ID (INTERNAL)

Parameters

  • id (int) – Fetch revisions for filter with this ID

  • limit (int) – Limit result

  • offset (int) – Offset result

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.eventfilters.v1.filter.search(limit: int = None, offset: int = None, includeDeleted: bool = None, includeFlags: int = None, excludeFlags: int = None, customerID: int = None, type: str = None, description: str = None, searchString: str = None, labels: str = None, masterID: int = None, userID: int = None, filterID: int = None, associatedCaseID: int = None, hitPeriod: int = None, minimumHits: int = None, maximumHits: int = None, includeCreatedTimestamp: bool = None, includeLastUpdatedTimestamp: bool = None, excludeExpired: bool = None, excludeFuture: bool = None, excludeValid: bool = None, includeAscendingCustomers: bool = None, startTimestamp: int = None, endTimestamp: int = None, sortBy: str = None, includeDescendingCustomers: bool = True, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Search filters (INTERNAL)

Parameters

  • limit (int) – Limit results

  • offset (int) – Offset results

  • includeDeleted (bool) – Also include deleted objects (where implemented)

  • includeFlags (int) – Search objects with these flags set

  • excludeFlags (int) – Exclude objects with these flags set

  • customerID (list) – Limit result to objects belonging to these customers

  • type (str) – Limit search to filters of this type

  • description (str) – Match filters by words in description

  • searchString (str) – Match filters by words in entire filter configuration

  • labels (list) – Limit search to filters with any of these filters

  • masterID (int) – Limit search to revisions of this master ID (by default, revisions are excluded)

  • userID (list) – Limit search to filters created/updated by any of these users

  • filterID (list) – Limit search to these spesific filters

  • associatedCaseID (list) – Limit search to filters associated to any of the listed cases. AssociatedCaseID 0 will include filters not associated to a case.

  • hitPeriod (int) – When searching by filter hits, look at hits for this period (previous time period in milliseconds)

  • minimumHits (int) – Limit search to filters reporting at least this number of hits for the hit period (SLOW)

  • maximumHits (int) – Limit search to filters reporting at most this number of hits for the hit period (SLOW)

  • includeCreatedTimestamp (bool) – When limiting filters by time, include filters by created timestamp

  • includeLastUpdatedTimestamp (bool) – When limiting filters by time, include filters by last updated timestamp

  • excludeExpired (bool) – Exclude filters which are expired (validToTimestamp has passed)

  • excludeFuture (bool) – Exclude filters which are not yet active (validFromTimestamp is in the future)

  • excludeValid (bool) – Exclude filters which are currently valid

  • includeAscendingCustomers (bool) – When limiting filters by customer, include filters of ascending customers (default is false)

  • startTimestamp (int) – Search objects from this timestamp

  • endTimestamp (int) – Search objects until this timestamp

  • sortBy (list) – Order results by these properties (prefix with - to sort descending)

  • includeDescendingCustomers (bool) – When limiting filters by customer, include filters of descending customers (default is true) (default true)

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.eventfilters.v1.filter.set_log_level(id: int, level: str = None, instanceID: int = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → requests.models.Response#

Set log level for specified filter (INTERNAL)

Parameters

  • id (int) – ID of event filter

  • level (str) – Log level to be set for event filter

  • instanceID (int) – ID of component instance to set log level for event filter, if not provided will set across instances

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

requests.Response object