Skip to content

Latest commit

 

History

History
280 lines (210 loc) · 12.2 KB

TagApiControllerApi.md

File metadata and controls

280 lines (210 loc) · 12.2 KB
Raw

stcloud.TagApiControllerApi

All URIs are relative to /

Method HTTP request Description
get_tag_names_using_get GET /spm-reports/api/v3/apps/{appIds}/tagNames Gets tag names for the given application identifiers appearing in the given time frame.
get_tags_grouped_by_id_using_get1 GET /spm-reports/api/v3/apps/{appIds}/grouped Gets tag names grouped by application id.
get_using_get GET /spm-reports/api/v3/apps/{appIds}/metrics/filters Gets values for specified tags for the given application identifiers appearing in the given time frame.
get_using_get3 GET /spm-reports/api/v3/apps/{appIds}/tags Gets values for specified tags for the given application identifiers appearing in the given time frame.

get_tag_names_using_get

TagNamesResponse get_tag_names_using_get(app_ids, _from=_from, to=to, metrics=metrics, logs=logs, events=events, rum=rum)

Gets tag names for the given application identifiers appearing in the given time frame.

Example

from __future__ import print_function
import time
import stcloud
from stcloud.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = stcloud.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = stcloud.TagApiControllerApi(stcloud.ApiClient(configuration))
app_ids = 'app_ids_example' # str | appIds
_from = 789 # int | from (optional)
to = 789 # int | to (optional)
metrics = true # bool | metrics (optional) (default to true)
logs = true # bool | logs (optional) (default to true)
events = false # bool | events (optional) (default to false)
rum = true # bool | rum (optional) (default to true)

try:
    # Gets tag names for the given application identifiers appearing in the given time frame.
    api_response = api_instance.get_tag_names_using_get(app_ids, _from=_from, to=to, metrics=metrics, logs=logs, events=events, rum=rum)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TagApiControllerApi->get_tag_names_using_get: %s\n" % e)

Parameters

Name Type Description Notes
app_ids str appIds
_from int from [optional]
to int to [optional]
metrics bool metrics [optional] [default to true]
logs bool logs [optional] [default to true]
events bool events [optional] [default to false]
rum bool rum [optional] [default to true]

Return type

TagNamesResponse

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

get_tags_grouped_by_id_using_get1

TagsGroupedResponse get_tags_grouped_by_id_using_get1(app_ids, tag, _from=_from, to=to, metrics=metrics, logs=logs, events=events, rum=rum)

Gets tag names grouped by application id.

Example

from __future__ import print_function
import time
import stcloud
from stcloud.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = stcloud.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = stcloud.TagApiControllerApi(stcloud.ApiClient(configuration))
app_ids = 'app_ids_example' # str | appIds
tag = ['tag_example'] # list[str] | tag
_from = 789 # int | from (optional)
to = 789 # int | to (optional)
metrics = true # bool | metrics (optional) (default to true)
logs = true # bool | logs (optional) (default to true)
events = false # bool | events (optional) (default to false)
rum = true # bool | rum (optional) (default to true)

try:
    # Gets tag names grouped by application id.
    api_response = api_instance.get_tags_grouped_by_id_using_get1(app_ids, tag, _from=_from, to=to, metrics=metrics, logs=logs, events=events, rum=rum)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TagApiControllerApi->get_tags_grouped_by_id_using_get1: %s\n" % e)

Parameters

Name Type Description Notes
app_ids str appIds
tag list[str] tag
_from int from [optional]
to int to [optional]
metrics bool metrics [optional] [default to true]
logs bool logs [optional] [default to true]
events bool events [optional] [default to false]
rum bool rum [optional] [default to true]

Return type

TagsGroupedResponse

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

get_using_get

dict(str, Dimension) get_using_get(app_ids, tag, _from=_from, to=to, metrics=metrics, logs=logs, events=events, rum=rum)

Gets values for specified tags for the given application identifiers appearing in the given time frame.

Example

from __future__ import print_function
import time
import stcloud
from stcloud.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = stcloud.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = stcloud.TagApiControllerApi(stcloud.ApiClient(configuration))
app_ids = 'app_ids_example' # str | appIds
tag = ['tag_example'] # list[str] | tag
_from = 789 # int | from (optional)
to = 789 # int | to (optional)
metrics = true # bool | metrics (optional) (default to true)
logs = true # bool | logs (optional) (default to true)
events = false # bool | events (optional) (default to false)
rum = true # bool | rum (optional) (default to true)

try:
    # Gets values for specified tags for the given application identifiers appearing in the given time frame.
    api_response = api_instance.get_using_get(app_ids, tag, _from=_from, to=to, metrics=metrics, logs=logs, events=events, rum=rum)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TagApiControllerApi->get_using_get: %s\n" % e)

Parameters

Name Type Description Notes
app_ids str appIds
tag list[str] tag
_from int from [optional]
to int to [optional]
metrics bool metrics [optional] [default to true]
logs bool logs [optional] [default to true]
events bool events [optional] [default to false]
rum bool rum [optional] [default to true]

Return type

dict(str, Dimension)

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

get_using_get3

dict(str, Dimension) get_using_get3(app_ids, tag, _from=_from, to=to, metrics=metrics, logs=logs, events=events, rum=rum)

Gets values for specified tags for the given application identifiers appearing in the given time frame.

Example

from __future__ import print_function
import time
import stcloud
from stcloud.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = stcloud.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = stcloud.TagApiControllerApi(stcloud.ApiClient(configuration))
app_ids = 'app_ids_example' # str | appIds
tag = ['tag_example'] # list[str] | tag
_from = 789 # int | from (optional)
to = 789 # int | to (optional)
metrics = true # bool | metrics (optional) (default to true)
logs = true # bool | logs (optional) (default to true)
events = false # bool | events (optional) (default to false)
rum = true # bool | rum (optional) (default to true)

try:
    # Gets values for specified tags for the given application identifiers appearing in the given time frame.
    api_response = api_instance.get_using_get3(app_ids, tag, _from=_from, to=to, metrics=metrics, logs=logs, events=events, rum=rum)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TagApiControllerApi->get_using_get3: %s\n" % e)

Parameters

Name Type Description Notes
app_ids str appIds
tag list[str] tag
_from int from [optional]
to int to [optional]
metrics bool metrics [optional] [default to true]
logs bool logs [optional] [default to true]
events bool events [optional] [default to false]
rum bool rum [optional] [default to true]

Return type

dict(str, Dimension)

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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