cyperf.StatisticsApi

All URIs are relative to http://localhost

Method	HTTP request	Description
create_plugins	POST /api/v2/stats/plugins
delete_plugins	DELETE /api/v2/stats/plugins/{pluginId}
get_plugins	GET /api/v2/stats/plugins
get_stats	GET /api/v2/results/{resultId}/stats
get_stats_by_id	GET /api/v2/results/{resultId}/stats/{statId}
poll_plugins_ingest	GET /api/v2/stats/plugins/operations/ingest/{id}
start_plugins_ingest	POST /api/v2/stats/plugins/operations/ingest

create_plugins

List[Plugin] create_plugins(plugin=plugin)

Create new plugins.

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.models.plugin import Plugin
from cyperf.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyperf.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.StatisticsApi(api_client)
    plugin = [cyperf.Plugin()] # List[Plugin] |  (optional)

    try:
        api_response = api_instance.create_plugins(plugin=plugin)
        print("The response of StatisticsApi->create_plugins:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling StatisticsApi->create_plugins: %s\n" % e)

Parameters

Name	Type	Description	Notes
plugin	List[Plugin]		[optional]

Return type

List[Plugin]

Authorization

OAuth2, OAuth2

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	Plugins created successfully.	-
400	Bad request	-
500	Unexpected error	-

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

delete_plugins

delete_plugins(plugin_id)

Delete a particular plugin.

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyperf.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.StatisticsApi(api_client)
    plugin_id = 'plugin_id_example' # str | The ID of the plugin.

    try:
        api_instance.delete_plugins(plugin_id)
    except Exception as e:
        print("Exception when calling StatisticsApi->delete_plugins: %s\n" % e)

Parameters

Name	Type	Description	Notes
plugin_id	str	The ID of the plugin.

Return type

void (empty response body)

Authorization

OAuth2, OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	The plugin was successfully deleted.	-
404	A plugin with the specified name was not found.	-
500	Unexpected error	-

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

get_plugins

GetPlugins200Response get_plugins(take=take, skip=skip)

List all the plugins.

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.models.get_plugins200_response import GetPlugins200Response
from cyperf.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyperf.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.StatisticsApi(api_client)
    take = 56 # int | The number of search results to return (optional)
    skip = 56 # int | The number of search results to skip (optional)

    try:
        api_response = api_instance.get_plugins(take=take, skip=skip)
        print("The response of StatisticsApi->get_plugins:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling StatisticsApi->get_plugins: %s\n" % e)

Parameters

Name	Type	Description	Notes
take	int	The number of search results to return	[optional]
skip	int	The number of search results to skip	[optional]

Return type

GetPlugins200Response

Authorization

OAuth2, OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The list of available plugins	-

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

get_stats

GetStats200Response get_stats(result_id, take=take, skip=skip)

Get all the available queries.

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.models.get_stats200_response import GetStats200Response
from cyperf.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyperf.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.StatisticsApi(api_client)
    result_id = 'result_id_example' # str | The ID of the result.
    take = 56 # int | The number of search results to return (optional)
    skip = 56 # int | The number of search results to skip (optional)

    try:
        api_response = api_instance.get_stats(result_id, take=take, skip=skip)
        print("The response of StatisticsApi->get_stats:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling StatisticsApi->get_stats: %s\n" % e)

Parameters

Name	Type	Description	Notes
result_id	str	The ID of the result.
take	int	The number of search results to return	[optional]
skip	int	The number of search results to skip	[optional]

Return type

GetStats200Response

Authorization

OAuth2, OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The available statistics views of the current result	-
400	Bad request	-
404	A result with the specified ID was not found.	-
500	Unexpected error	-

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

get_stats_by_id

StatsResult get_stats_by_id(result_id, stat_id, var_from=var_from, to=to, interval=interval, use_relative_time=use_relative_time)

Query statistics

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.models.stats_result import StatsResult
from cyperf.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyperf.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.StatisticsApi(api_client)
    result_id = 'result_id_example' # str | The ID of the result.
    stat_id = 'stat_id_example' # str | The ID of the stat.
    var_from = 56 # int | (optional) UNIX time in milliseconds or milliseconds from the test start (based on useRelativeTime flag) as the query interval start. Defaults to 'now-5m' (in milliseconds) for false useRelativeTime, and 0 otherwise. (optional)
    to = 56 # int | (optional) UNIX time in milliseconds or milliseconds from the test start (based on useRelativeTime flag) as the query interval end. Defaults to 'now-7s' (in milliseconds). (optional)
    interval = 56 # int | (optional) The interval used to aggregate the statistics snapshots (optional)
    use_relative_time = True # bool | (optional) Specifies if the from/to params use milliseconds from test start or UNIX time in milliseconds (optional)

    try:
        api_response = api_instance.get_stats_by_id(result_id, stat_id, var_from=var_from, to=to, interval=interval, use_relative_time=use_relative_time)
        print("The response of StatisticsApi->get_stats_by_id:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling StatisticsApi->get_stats_by_id: %s\n" % e)

Parameters

Name	Type	Description	Notes
result_id	str	The ID of the result.
stat_id	str	The ID of the stat.
var_from	int	(optional) UNIX time in milliseconds or milliseconds from the test start (based on useRelativeTime flag) as the query interval start. Defaults to 'now-5m' (in milliseconds) for false useRelativeTime, and 0 otherwise.	[optional]
to	int	(optional) UNIX time in milliseconds or milliseconds from the test start (based on useRelativeTime flag) as the query interval end. Defaults to 'now-7s' (in milliseconds).	[optional]
interval	int	(optional) The interval used to aggregate the statistics snapshots	[optional]
use_relative_time	bool	(optional) Specifies if the from/to params use milliseconds from test start or UNIX time in milliseconds	[optional]

Return type

StatsResult

Authorization

OAuth2, OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successfully queried the statistics	-
400	Bad request	-
404	A result with the specified ID was not found.	-
500	Unexpected error	-

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

poll_plugins_ingest

AsyncContext poll_plugins_ingest(id)

Get the state of an ongoing operation.

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.models.async_context import AsyncContext
from cyperf.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyperf.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.StatisticsApi(api_client)
    id = 56 # int | The ID of the async operation.

    try:
        api_response = api_instance.poll_plugins_ingest(id)
        print("The response of StatisticsApi->poll_plugins_ingest:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling StatisticsApi->poll_plugins_ingest: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	The ID of the async operation.

Return type

AsyncContext

Authorization

OAuth2, OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Details about the ongoing operation	-

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

start_plugins_ingest

AsyncContext start_plugins_ingest(ingest_operation=ingest_operation)

Ingest the plugin statistics.

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.models.async_context import AsyncContext
from cyperf.models.ingest_operation import IngestOperation
from cyperf.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyperf.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.StatisticsApi(api_client)
    ingest_operation = cyperf.IngestOperation() # IngestOperation |  (optional)

    try:
        api_response = api_instance.start_plugins_ingest(ingest_operation=ingest_operation)
        print("The response of StatisticsApi->start_plugins_ingest:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling StatisticsApi->start_plugins_ingest: %s\n" % e)

Parameters

Name	Type	Description	Notes
ingest_operation	IngestOperation		[optional]

Return type

AsyncContext

Authorization

OAuth2, OAuth2

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
202	Details about the operation that just started	-

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

Files

StatisticsApi.md

Latest commit

History

StatisticsApi.md

File metadata and controls

cyperf.StatisticsApi

create_plugins

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_plugins

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_plugins

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_stats

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_stats_by_id

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

poll_plugins_ingest

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

start_plugins_ingest

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details