analysis#
Autogenerated API
- argus_api.lib.eventfilters.v2.analysis.add_analysis_filter(name: str = None, description: str = None, customer: str = None, filters: dict = None, actions: dict = None, labels: str = None, enabled: 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 #
Adds an analysis filter (INTERNAL)
- Parameters
name (str) – The name of the filter
description (str) – A description of the filter
customer (str) – The shortname or ID of the customer the filter belongs to. To create a global filter set the value to ‘0’
filters (dict) –
actions (dict) –
labels (list) – A set of labels which can be used to categorize the filter
enabled (bool) – Whether or not the filter is enabled (default false)
json – return the response’s body as a
dict
parsed from json.True
by default. If set to false, the rawrequests.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
AuthenticationFailedException – on 401
AccessDeniedException – on 403
ValidationFailedException – on 412
ArgusException – on other status codes
- Returns
dictionary translated from JSON
- argus_api.lib.eventfilters.v2.analysis.delete_analysis_filter(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 #
Deletes an analysis filter (INTERNAL)
- Parameters
id (int) – ID of filter to delete
json – return the response’s body as a
dict
parsed from json.True
by default. If set to false, the rawrequests.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
AuthenticationFailedException – on 401
AccessDeniedException – on 403
ObjectNotFoundException – on 404
ArgusException – on other status codes
- Returns
dictionary translated from JSON
- argus_api.lib.eventfilters.v2.analysis.disable_analysis_filter(id: int, comment: str = 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 #
Disables an analysis filter (INTERNAL)
- Parameters
id (int) – ID of filter
comment (str) – A comment describing why the filter was enabled/disabled
json – return the response’s body as a
dict
parsed from json.True
by default. If set to false, the rawrequests.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
AuthenticationFailedException – on 401
AccessDeniedException – on 403
ObjectNotFoundException – on 404
ValidationFailedException – on 412
ArgusException – on other status codes
- Returns
dictionary translated from JSON
- argus_api.lib.eventfilters.v2.analysis.disable_analysis_filter_on_instance(filterID: int, instanceID: 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 #
Disables an analysis filter on instance (INTERNAL)
- Parameters
filterID (int) – ID of the filter
instanceID (int) – ID of the instance
json – return the response’s body as a
dict
parsed from json.True
by default. If set to false, the rawrequests.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
AuthenticationFailedException – on 401
AccessDeniedException – on 403
ObjectNotFoundException – on 404
ValidationFailedException – on 412
ArgusException – on other status codes
- Returns
dictionary translated from JSON
- argus_api.lib.eventfilters.v2.analysis.duplicate_analysis_filter(id: int, customer: str = 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 #
Duplicates an analysis filter (INTERNAL)
- Parameters
id (int) – ID of filter
customer (str) – The customer the duplicate should belong to (id or shortname). Use ‘0’ to create a global filter, If this field is not set the default is using the same customer as the original filter.
json – return the response’s body as a
dict
parsed from json.True
by default. If set to false, the rawrequests.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
AuthenticationFailedException – on 401
AccessDeniedException – on 403
ObjectNotFoundException – on 404
ArgusException – on other status codes
- Returns
dictionary translated from JSON
- argus_api.lib.eventfilters.v2.analysis.enable_analysis_filter(id: int, comment: str = 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 #
Enables an analysis filter (INTERNAL)
- Parameters
id (int) – ID of filter
comment (str) – A comment describing why the filter was enabled/disabled
json – return the response’s body as a
dict
parsed from json.True
by default. If set to false, the rawrequests.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
AuthenticationFailedException – on 401
AccessDeniedException – on 403
ObjectNotFoundException – on 404
ValidationFailedException – on 412
ArgusException – on other status codes
- Returns
dictionary translated from JSON
- argus_api.lib.eventfilters.v2.analysis.enable_analysis_filter_on_instance(filterID: int, instanceID: 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 #
Enables an analysis filter on instance (INTERNAL)
- Parameters
filterID (int) – ID of the filter
instanceID (int) – ID of the instance
json – return the response’s body as a
dict
parsed from json.True
by default. If set to false, the rawrequests.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
AuthenticationFailedException – on 401
AccessDeniedException – on 403
ObjectNotFoundException – on 404
ValidationFailedException – on 412
ArgusException – on other status codes
- Returns
dictionary translated from JSON
- argus_api.lib.eventfilters.v2.analysis.get_analysis_filter(id: int, revision: int = None, includeCode: 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 #
Gets an analysis filter (INTERNAL)
- Parameters
id (int) – ID of filter
revision (int) – The expected revision of the filter
includeCode (bool) – Whether to include code in AnnotationFilter
json – return the response’s body as a
dict
parsed from json.True
by default. If set to false, the rawrequests.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
AuthenticationFailedException – on 401
AccessDeniedException – on 403
ObjectNotFoundException – on 404
ValidationFailedException – on 412
ArgusException – on other status codes
- Returns
dictionary translated from JSON
- argus_api.lib.eventfilters.v2.analysis.get_analysis_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 #
Gets a analysis filters earlier revisions (INTERNAL)
- Parameters
id (int) – ID of filter to fetch revisions for
limit (int) – The max amount of revisions to return
offset (int) – The number of revisions to skip before returning
json – return the response’s body as a
dict
parsed from json.True
by default. If set to false, the rawrequests.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
AuthenticationFailedException – on 401
AccessDeniedException – on 403
ObjectNotFoundException – on 404
ArgusException – on other status codes
- Returns
dictionary translated from JSON
- argus_api.lib.eventfilters.v2.analysis.get_analysis_filter_status(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 #
Gets the status of a analysis filters instance statuses (INTERNAL)
- Parameters
id (int) – ID of filter
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 rawrequests.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
AuthenticationFailedException – on 401
AccessDeniedException – on 403
ObjectNotFoundException – on 404
ArgusException – on other status codes
- Returns
dictionary translated from JSON
- argus_api.lib.eventfilters.v2.analysis.list_analysis_filter(keywords: str = None, keywordFieldStrategy: str = None, timestampFieldStrategy: str = None, sortBy: str = None, keywordMatchStrategy: str = 'all', timestampMatchStrategy: str = 'all', limit: int = 25, startTimestamp: int = None, endTimestamp: int = None, includeCode: bool = None, 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 #
Simple search for analysis filters (INTERNAL)
- Parameters
keywords (list) – Search by keywords
keywordFieldStrategy (list) – Set field strategy for keyword search
timestampFieldStrategy (list) – Set field strategy for timestamp filtering
sortBy (list) – Field to sort by
keywordMatchStrategy (str) – Set match strategy for keyword search
timestampMatchStrategy (str) – Set match strategy for timestamp filtering
limit (int) – Limit result
startTimestamp (int) – Lower bound timestamp filter value
endTimestamp (int) – Upper bound timestamp filter value
includeCode (bool) – Whether to include code in results
offset (int) – Offset result
json – return the response’s body as a
dict
parsed from json.True
by default. If set to false, the rawrequests.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
AuthenticationFailedException – on 401
AccessDeniedException – on 403
ValidationFailedException – on 412
ArgusException – on other status codes
- Returns
dictionary translated from JSON
- argus_api.lib.eventfilters.v2.analysis.revert_analysis_filter(filterID: int, revisionID: int = None, comment: str = 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 #
Reverts an analysis filter to a previous revision (INTERNAL)
- Parameters
filterID (int) – ID of the filter to revert( must be the current version of a filter)
revisionID (int) – The ID of the filter to revert to. Must be a revision of the filter to revert
comment (str) – A comment describing why the filter was reverted
json – return the response’s body as a
dict
parsed from json.True
by default. If set to false, the rawrequests.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
AuthenticationFailedException – on 401
AccessDeniedException – on 403
ObjectNotFoundException – on 404
ValidationFailedException – on 412
ArgusException – on other status codes
- Returns
dictionary translated from JSON
- argus_api.lib.eventfilters.v2.analysis.revive_analysis_filter(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 #
Revives a deleted a analysis filter (INTERNAL)
- Parameters
id (int) – ID of filter
json – return the response’s body as a
dict
parsed from json.True
by default. If set to false, the rawrequests.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
AuthenticationFailedException – on 401
AccessDeniedException – on 403
ObjectNotFoundException – on 404
ValidationFailedException – on 412
ArgusException – on other status codes
- Returns
dictionary translated from JSON
- argus_api.lib.eventfilters.v2.analysis.search_analysis_filter(sortBy: str = None, keywords: str = None, keywordFieldStrategy: str = None, keywordMatchStrategy: str = None, filterID: int = None, customer: str = None, user: str = None, userFieldStrategy: str = None, userMatchStrategy: str = None, timeFieldStrategy: str = None, timeMatchStrategy: str = None, includeFlags: str = None, excludeFlags: str = None, subCriteria: dict = None, includeAscendingCustomers: bool = None, startTimestamp: int = None, endTimestamp: int = None, includeDeleted: bool = None, includeCode: bool = None, includeDescendingCustomers: bool = True, 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 #
Searches for analysis filters (INTERNAL)
- Parameters
sortBy (list) –
keywords (list) – Search for keywords against fields defined by keywordFieldStrategy
keywordFieldStrategy (list) – Defines which fields will be searched by keywords (default all supported fields) (default all)
keywordMatchStrategy (str) – Defines how strict different keywords should be matched (default match all keywords) (default all)
filterID (list) – Limit search to filters with the given IDs
customer (list) – Limit search to filters with the given customers, identified by id or shortname
user (list) – Search using users identified by id or shortname. If given a group, we will resolve all members of the group recursively
userFieldStrategy (list) – Defines which fields will be searched by user (default all supported fields) (default all)
userMatchStrategy (str) – Defines how strict different keywords should be matched (default match all keywords) (default all)
timeFieldStrategy (list) – Defines which timestamps will be included in the search (default lastUpdated) (default lastUpdated)
timeMatchStrategy (str) – Defines how strict to match against different timestamps (all/any) using start and end timestamp (default any) (default any)
includeFlags (list) – Flags to include
excludeFlags (list) – Flags to exclude
subCriteria (list) – The set of sub criteria to add to the search
includeAscendingCustomers (bool) – When limiting filters by customer, include filters of ascending customers (default is false)
startTimestamp (int) – Restrict to a time frame based on the set timeFieldStrategy (start timestamp) (default 0)
endTimestamp (int) – Restrict to a time frame based on the set timeFieldStrategy (end timestamp) (default 0)
includeDeleted (bool) – Set to true to include deleted filters (excluded by default). (default false)
includeCode (bool) – Whether or not to include code in the result object. The code is only returned if set to true (default false)
includeDescendingCustomers (bool) – When limiting filters by customer, include filters of descending customers (default is true) (default true)
limit (int) – Limit maximum amount of results (default 25)
offset (int) – Skip specified amount of results (default 0)
json – return the response’s body as a
dict
parsed from json.True
by default. If set to false, the rawrequests.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
AuthenticationFailedException – on 401
AccessDeniedException – on 403
ValidationFailedException – on 412
ArgusException – on other status codes
- Returns
dictionary translated from JSON
- argus_api.lib.eventfilters.v2.analysis.set_analysis_filter_log_level(id: int, logLevel: str = 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 #
Sets the log level of a analysis filter (INTERNAL)
- Parameters
id (int) – ID of filter
logLevel (str) – The new log level of the filter
json – return the response’s body as a
dict
parsed from json.True
by default. If set to false, the rawrequests.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
AuthenticationFailedException – on 401
AccessDeniedException – on 403
ObjectNotFoundException – on 404
ValidationFailedException – on 412
ArgusException – on other status codes
- Returns
dictionary translated from JSON
- argus_api.lib.eventfilters.v2.analysis.update_analysis_filter(id: int, name: str = None, description: str = None, filters: dict = None, actions: dict = None, removeLabels: str = None, addLabels: str = None, setLabels: str = None, comment: str = 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 #
Updates an analysis filter (INTERNAL)
- Parameters
id (int) – ID of filter
name (str) – The name of the filter
description (str) – A description of the filter
filters (dict) –
actions (dict) –
removeLabels (list) – A set of labels to remove from the filter. Will be applied before adding labels and ignore filters that are not present. Will throw an exception if used in conjunction with setLabels
addLabels (list) – A set of labels to add to the filter. Will be applied after removing labels. Will throw an exception if used in conjunction with setLabels
setLabels (list) – Replace the current set of labels with these. Will throw an exception if used in conjunction with addLabels or removeLabels
comment (str) – A comment describing why the filter was updated
json – return the response’s body as a
dict
parsed from json.True
by default. If set to false, the rawrequests.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
AuthenticationFailedException – on 401
AccessDeniedException – on 403
ObjectNotFoundException – on 404
ValidationFailedException – on 412
ArgusException – on other status codes
- Returns
dictionary translated from JSON