openapi_client.MonitoringUmbrellaPatternsApi

All URIs are relative to /dataservice

Method	HTTP request	Description
get_aggregation_data_by_query23	GET /statistics/fwall/aggregation
get_count25	GET /statistics/fwall/doccount
get_count_post25	POST /statistics/fwall/doccount
get_post_aggregation_app_data_by_query22	POST /statistics/fwall/app-agg/aggregation
get_post_aggregation_data_by_query22	POST /statistics/fwall/aggregation
get_post_stat_bulk_raw_data23	POST /statistics/fwall/page
get_stat_bulk_raw_data23	GET /statistics/fwall/page
get_stat_data_fields25	GET /statistics/fwall/fields
get_stat_data_raw_data22	GET /statistics/fwall
get_stat_data_raw_data_as_csv23	GET /statistics/fwall/csv
get_stat_query_fields25	GET /statistics/fwall/query/fields
get_stats_raw_data23	POST /statistics/fwall

get_aggregation_data_by_query23

{str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_aggregation_data_by_query23()

Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage

Example

import time
import openapi_client
from openapi_client.api import monitoring_umbrella_patterns_api
from pprint import pprint
# Defining the host is optional and defaults to /dataservice
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "/dataservice"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = monitoring_umbrella_patterns_api.MonitoringUmbrellaPatternsApi(api_client)
    query = "query_example" # str | Query filter (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        api_response = api_instance.get_aggregation_data_by_query23(query=query)
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling MonitoringUmbrellaPatternsApi->get_aggregation_data_by_query23: %s\n" % e)

Parameters

Name	Type	Description	Notes
query	str	Query filter	[optional]

Return type

{str: (bool, date, datetime, dict, float, int, list, str, none_type)}

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
400	Bad Request	-
403	Forbidden	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_count25

{str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_count25(query)

Get response count of a query

Example

import time
import openapi_client
from openapi_client.api import monitoring_umbrella_patterns_api
from pprint import pprint
# Defining the host is optional and defaults to /dataservice
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "/dataservice"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = monitoring_umbrella_patterns_api.MonitoringUmbrellaPatternsApi(api_client)
    query = "{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query

    # example passing only required values which don't have defaults set
    try:
        api_response = api_instance.get_count25(query)
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling MonitoringUmbrellaPatternsApi->get_count25: %s\n" % e)

Parameters

Name	Type	Description	Notes
query	str	Query

Return type

{str: (bool, date, datetime, dict, float, int, list, str, none_type)}

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
400	Bad Request	-
403	Forbidden	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_count_post25

{str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_count_post25()

Get response count of a query

Example

import time
import openapi_client
from openapi_client.api import monitoring_umbrella_patterns_api
from pprint import pprint
# Defining the host is optional and defaults to /dataservice
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "/dataservice"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = monitoring_umbrella_patterns_api.MonitoringUmbrellaPatternsApi(api_client)
    body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Query (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        api_response = api_instance.get_count_post25(body=body)
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling MonitoringUmbrellaPatternsApi->get_count_post25: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	{str: (bool, date, datetime, dict, float, int, list, str, none_type)}	Query	[optional]

Return type

{str: (bool, date, datetime, dict, float, int, list, str, none_type)}

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
400	Bad Request	-
403	Forbidden	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_post_aggregation_app_data_by_query22

{str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_aggregation_app_data_by_query22()

Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage

Example

import time
import openapi_client
from openapi_client.api import monitoring_umbrella_patterns_api
from pprint import pprint
# Defining the host is optional and defaults to /dataservice
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "/dataservice"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = monitoring_umbrella_patterns_api.MonitoringUmbrellaPatternsApi(api_client)
    body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        api_response = api_instance.get_post_aggregation_app_data_by_query22(body=body)
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling MonitoringUmbrellaPatternsApi->get_post_aggregation_app_data_by_query22: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	{str: (bool, date, datetime, dict, float, int, list, str, none_type)}	Stats query string	[optional]

Return type

{str: (bool, date, datetime, dict, float, int, list, str, none_type)}

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
400	Bad Request	-
403	Forbidden	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_post_aggregation_data_by_query22

{str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_aggregation_data_by_query22()

Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage

Example

import time
import openapi_client
from openapi_client.api import monitoring_umbrella_patterns_api
from pprint import pprint
# Defining the host is optional and defaults to /dataservice
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "/dataservice"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = monitoring_umbrella_patterns_api.MonitoringUmbrellaPatternsApi(api_client)
    body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        api_response = api_instance.get_post_aggregation_data_by_query22(body=body)
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling MonitoringUmbrellaPatternsApi->get_post_aggregation_data_by_query22: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	{str: (bool, date, datetime, dict, float, int, list, str, none_type)}	Stats query string	[optional]

Return type

{str: (bool, date, datetime, dict, float, int, list, str, none_type)}

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
400	Bad Request	-
403	Forbidden	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_post_stat_bulk_raw_data23

{str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_post_stat_bulk_raw_data23()

Get stats raw data

Example

import time
import openapi_client
from openapi_client.api import monitoring_umbrella_patterns_api
from pprint import pprint
# Defining the host is optional and defaults to /dataservice
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "/dataservice"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = monitoring_umbrella_patterns_api.MonitoringUmbrellaPatternsApi(api_client)
    scroll_id = "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" # str | ES scroll Id (optional)
    count = "10" # str | Result size (optional)
    body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        api_response = api_instance.get_post_stat_bulk_raw_data23(scroll_id=scroll_id, count=count, body=body)
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling MonitoringUmbrellaPatternsApi->get_post_stat_bulk_raw_data23: %s\n" % e)

Parameters

Name	Type	Description	Notes
scroll_id	str	ES scroll Id	[optional]
count	str	Result size	[optional]
body	{str: (bool, date, datetime, dict, float, int, list, str, none_type)}	Stats query string	[optional]

Return type

{str: (bool, date, datetime, dict, float, int, list, str, none_type)}

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
400	Bad Request	-
403	Forbidden	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_stat_bulk_raw_data23

{str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_bulk_raw_data23()

Get stats raw data

Example

import time
import openapi_client
from openapi_client.api import monitoring_umbrella_patterns_api
from pprint import pprint
# Defining the host is optional and defaults to /dataservice
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "/dataservice"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = monitoring_umbrella_patterns_api.MonitoringUmbrellaPatternsApi(api_client)
    query = "{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}" # str | Query string (optional)
    scroll_id = "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ==" # str | ES scroll Id (optional)
    count = "10" # str | Result size (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        api_response = api_instance.get_stat_bulk_raw_data23(query=query, scroll_id=scroll_id, count=count)
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling MonitoringUmbrellaPatternsApi->get_stat_bulk_raw_data23: %s\n" % e)

Parameters

Name	Type	Description	Notes
query	str	Query string	[optional]
scroll_id	str	ES scroll Id	[optional]
count	str	Result size	[optional]

Return type

{str: (bool, date, datetime, dict, float, int, list, str, none_type)}

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
400	Bad Request	-
403	Forbidden	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_stat_data_fields25

{str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_data_fields25()

Get fields and type

Example

import time
import openapi_client
from openapi_client.api import monitoring_umbrella_patterns_api
from pprint import pprint
# Defining the host is optional and defaults to /dataservice
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "/dataservice"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = monitoring_umbrella_patterns_api.MonitoringUmbrellaPatternsApi(api_client)

    # example, this endpoint has no required or optional parameters
    try:
        api_response = api_instance.get_stat_data_fields25()
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling MonitoringUmbrellaPatternsApi->get_stat_data_fields25: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

{str: (bool, date, datetime, dict, float, int, list, str, none_type)}

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
400	Bad Request	-
403	Forbidden	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_stat_data_raw_data22

{str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_data_raw_data22()

Get stats raw data

Example

import time
import openapi_client
from openapi_client.api import monitoring_umbrella_patterns_api
from pprint import pprint
# Defining the host is optional and defaults to /dataservice
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "/dataservice"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = monitoring_umbrella_patterns_api.MonitoringUmbrellaPatternsApi(api_client)
    query = "{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query string (optional)
    page = 1 # int | page number (optional)
    page_size = 1 # int | page size (optional)
    sort_by = "sortBy_example" # str | sort by(emp:entry_time) (optional)
    sort_order = "sortOrder_example" # str | sort order(emp:asc、ASC、Asc、desc、Desc、DESC) (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        api_response = api_instance.get_stat_data_raw_data22(query=query, page=page, page_size=page_size, sort_by=sort_by, sort_order=sort_order)
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling MonitoringUmbrellaPatternsApi->get_stat_data_raw_data22: %s\n" % e)

Parameters

Name	Type	Description	Notes
query	str	Query string	[optional]
page	int	page number	[optional]
page_size	int	page size	[optional]
sort_by	str	sort by(emp:entry_time)	[optional]
sort_order	str	sort order(emp:asc、ASC、Asc、desc、Desc、DESC)	[optional]

Return type

{str: (bool, date, datetime, dict, float, int, list, str, none_type)}

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
400	Bad Request	-
403	Forbidden	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_stat_data_raw_data_as_csv23

str get_stat_data_raw_data_as_csv23()

Get raw data with optional query as CSV

Example

import time
import openapi_client
from openapi_client.api import monitoring_umbrella_patterns_api
from pprint import pprint
# Defining the host is optional and defaults to /dataservice
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "/dataservice"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = monitoring_umbrella_patterns_api.MonitoringUmbrellaPatternsApi(api_client)
    query = "{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1000,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"],"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}" # str | Query string (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        api_response = api_instance.get_stat_data_raw_data_as_csv23(query=query)
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling MonitoringUmbrellaPatternsApi->get_stat_data_raw_data_as_csv23: %s\n" % e)

Parameters

Name	Type	Description	Notes
query	str	Query string	[optional]

Return type

str

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/csv

HTTP response details

Status code	Description	Response headers
200	Success	-
400	Bad Request	-
403	Forbidden	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_stat_query_fields25

{str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stat_query_fields25()

Get query fields

Example

import time
import openapi_client
from openapi_client.api import monitoring_umbrella_patterns_api
from pprint import pprint
# Defining the host is optional and defaults to /dataservice
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "/dataservice"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = monitoring_umbrella_patterns_api.MonitoringUmbrellaPatternsApi(api_client)

    # example, this endpoint has no required or optional parameters
    try:
        api_response = api_instance.get_stat_query_fields25()
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling MonitoringUmbrellaPatternsApi->get_stat_query_fields25: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

{str: (bool, date, datetime, dict, float, int, list, str, none_type)}

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
400	Bad Request	-
403	Forbidden	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_stats_raw_data23

{str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_stats_raw_data23()

Get stats raw data

Example

import time
import openapi_client
from openapi_client.api import monitoring_umbrella_patterns_api
from pprint import pprint
# Defining the host is optional and defaults to /dataservice
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "/dataservice"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = monitoring_umbrella_patterns_api.MonitoringUmbrellaPatternsApi(api_client)
    page = 1 # int | page number (optional)
    page_size = 1 # int | page size (optional)
    sort_by = "sortBy_example" # str | sort by (optional)
    sort_order = "sortOrder_example" # str | sort order (optional)
    body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Stats query string (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        api_response = api_instance.get_stats_raw_data23(page=page, page_size=page_size, sort_by=sort_by, sort_order=sort_order, body=body)
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling MonitoringUmbrellaPatternsApi->get_stats_raw_data23: %s\n" % e)

Parameters

Name	Type	Description	Notes
page	int	page number	[optional]
page_size	int	page size	[optional]
sort_by	str	sort by	[optional]
sort_order	str	sort order	[optional]
body	{str: (bool, date, datetime, dict, float, int, list, str, none_type)}	Stats query string	[optional]

Return type

{str: (bool, date, datetime, dict, float, int, list, str, none_type)}

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
400	Bad Request	-
403	Forbidden	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

MonitoringUmbrellaPatternsApi.md

Latest commit

History

MonitoringUmbrellaPatternsApi.md

File metadata and controls

openapi_client.MonitoringUmbrellaPatternsApi

get_aggregation_data_by_query23

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_count25

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_count_post25

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_post_aggregation_app_data_by_query22

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_post_aggregation_data_by_query22

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_post_stat_bulk_raw_data23

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_stat_bulk_raw_data23

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_stat_data_fields25

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_stat_data_raw_data22

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_stat_data_raw_data_as_csv23

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_stat_query_fields25

Example

Parameters