Skip to content

Latest commit

 

History

History
617 lines (427 loc) · 22.4 KB

SavedTracesSearchApi.md

File metadata and controls

617 lines (427 loc) · 22.4 KB
Raw

wavefront_api_client.SavedTracesSearchApi

All URIs are relative to https://YOUR_INSTANCE.wavefront.com

Method HTTP request Description
create_saved_traces_search POST /api/v2/savedtracessearch Create a search
default_app_map_search POST /api/v2/savedtracessearch/defaultTracesSearch Set default traces search at user level
default_customer_traces_search POST /api/v2/savedtracessearch/defaultCustomerTracesSearch Set default traces search at customer level
default_traces_search GET /api/v2/savedtracessearch/defaultTracesSearch Get default traces search for a user
delete_saved_traces_search DELETE /api/v2/savedtracessearch/{id} Delete a search
delete_saved_traces_search_for_user DELETE /api/v2/savedtracessearch/owned/{id} Delete a search belonging to the user
get_all_saved_traces_searches GET /api/v2/savedtracessearch Get all searches for a customer
get_all_saved_traces_searches_for_user GET /api/v2/savedtracessearch/owned Get all searches for a user
get_saved_traces_search GET /api/v2/savedtracessearch/{id} Get a specific search
update_saved_traces_search PUT /api/v2/savedtracessearch/{id} Update a search
update_saved_traces_search_for_user PUT /api/v2/savedtracessearch/owned/{id} Update a search belonging to the user

create_saved_traces_search

ResponseContainerSavedTracesSearch create_saved_traces_search(body=body)

Create a search

Example

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

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

# create an instance of the API class
api_instance = wavefront_api_client.SavedTracesSearchApi(wavefront_api_client.ApiClient(configuration))
body = wavefront_api_client.SavedTracesSearch() # SavedTracesSearch | Example Body:  <pre>{   \"name\": \"beachshirts shopping\",   \"searchFilters\": {     \"filters\": [       {         \"filterType\": \"OPERATION\",         \"values\": {           \"logicalValue\": [             [               \"beachshirts.\", \"shopping.\", \"'*\"             ]           ]         }       }     ]   } }</pre> (optional)

try:
    # Create a search
    api_response = api_instance.create_saved_traces_search(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SavedTracesSearchApi->create_saved_traces_search: %s\n" % e)

Parameters

Name Type Description Notes
body SavedTracesSearch Example Body: <pre>{ &quot;name&quot;: &quot;beachshirts shopping&quot;, &quot;searchFilters&quot;: { &quot;filters&quot;: [ { &quot;filterType&quot;: &quot;OPERATION&quot;, &quot;values&quot;: { &quot;logicalValue&quot;: [ [ &quot;beachshirts.&quot;, &quot;shopping.&quot;, &quot;'*&quot; ] ] } } ] } }</pre> [optional]

Return type

ResponseContainerSavedTracesSearch

Authorization

api_key

HTTP request headers

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

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

default_app_map_search

ResponseContainerString default_app_map_search(default_traces_search=default_traces_search)

Set default traces search at user level

Example

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

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

# create an instance of the API class
api_instance = wavefront_api_client.SavedTracesSearchApi(wavefront_api_client.ApiClient(configuration))
default_traces_search = 'default_traces_search_example' # str |  (optional)

try:
    # Set default traces search at user level
    api_response = api_instance.default_app_map_search(default_traces_search=default_traces_search)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SavedTracesSearchApi->default_app_map_search: %s\n" % e)

Parameters

Name Type Description Notes
default_traces_search str [optional]

Return type

ResponseContainerString

Authorization

api_key

HTTP request headers

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

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

default_customer_traces_search

ResponseContainerString default_customer_traces_search(default_traces_search=default_traces_search)

Set default traces search at customer level

Example

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

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

# create an instance of the API class
api_instance = wavefront_api_client.SavedTracesSearchApi(wavefront_api_client.ApiClient(configuration))
default_traces_search = 'default_traces_search_example' # str |  (optional)

try:
    # Set default traces search at customer level
    api_response = api_instance.default_customer_traces_search(default_traces_search=default_traces_search)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SavedTracesSearchApi->default_customer_traces_search: %s\n" % e)

Parameters

Name Type Description Notes
default_traces_search str [optional]

Return type

ResponseContainerString

Authorization

api_key

HTTP request headers

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

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

default_traces_search

ResponseContainerDefaultSavedTracesSearch default_traces_search()

Get default traces search for a user

Example

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

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

# create an instance of the API class
api_instance = wavefront_api_client.SavedTracesSearchApi(wavefront_api_client.ApiClient(configuration))

try:
    # Get default traces search for a user
    api_response = api_instance.default_traces_search()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SavedTracesSearchApi->default_traces_search: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

ResponseContainerDefaultSavedTracesSearch

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]

delete_saved_traces_search

ResponseContainerSavedTracesSearch delete_saved_traces_search(id)

Delete a search

Example

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

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

# create an instance of the API class
api_instance = wavefront_api_client.SavedTracesSearchApi(wavefront_api_client.ApiClient(configuration))
id = 'id_example' # str | 

try:
    # Delete a search
    api_response = api_instance.delete_saved_traces_search(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SavedTracesSearchApi->delete_saved_traces_search: %s\n" % e)

Parameters

Name Type Description Notes
id str

Return type

ResponseContainerSavedTracesSearch

Authorization

api_key

HTTP request headers

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

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

delete_saved_traces_search_for_user

ResponseContainerSavedTracesSearch delete_saved_traces_search_for_user(id)

Delete a search belonging to the user

Example

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

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

# create an instance of the API class
api_instance = wavefront_api_client.SavedTracesSearchApi(wavefront_api_client.ApiClient(configuration))
id = 'id_example' # str | 

try:
    # Delete a search belonging to the user
    api_response = api_instance.delete_saved_traces_search_for_user(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SavedTracesSearchApi->delete_saved_traces_search_for_user: %s\n" % e)

Parameters

Name Type Description Notes
id str

Return type

ResponseContainerSavedTracesSearch

Authorization

api_key

HTTP request headers

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

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

get_all_saved_traces_searches

ResponseContainerPagedSavedTracesSearch get_all_saved_traces_searches(offset=offset, limit=limit)

Get all searches for a customer

Example

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

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

# create an instance of the API class
api_instance = wavefront_api_client.SavedTracesSearchApi(wavefront_api_client.ApiClient(configuration))
offset = 0 # int |  (optional) (default to 0)
limit = 100 # int |  (optional) (default to 100)

try:
    # Get all searches for a customer
    api_response = api_instance.get_all_saved_traces_searches(offset=offset, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SavedTracesSearchApi->get_all_saved_traces_searches: %s\n" % e)

Parameters

Name Type Description Notes
offset int [optional] [default to 0]
limit int [optional] [default to 100]

Return type

ResponseContainerPagedSavedTracesSearch

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_all_saved_traces_searches_for_user

ResponseContainerPagedSavedTracesSearch get_all_saved_traces_searches_for_user(offset=offset, limit=limit)

Get all searches for a user

Example

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

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

# create an instance of the API class
api_instance = wavefront_api_client.SavedTracesSearchApi(wavefront_api_client.ApiClient(configuration))
offset = 0 # int |  (optional) (default to 0)
limit = 100 # int |  (optional) (default to 100)

try:
    # Get all searches for a user
    api_response = api_instance.get_all_saved_traces_searches_for_user(offset=offset, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SavedTracesSearchApi->get_all_saved_traces_searches_for_user: %s\n" % e)

Parameters

Name Type Description Notes
offset int [optional] [default to 0]
limit int [optional] [default to 100]

Return type

ResponseContainerPagedSavedTracesSearch

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_saved_traces_search

ResponseContainerSavedTracesSearch get_saved_traces_search(id)

Get a specific search

Example

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

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

# create an instance of the API class
api_instance = wavefront_api_client.SavedTracesSearchApi(wavefront_api_client.ApiClient(configuration))
id = 'id_example' # str | 

try:
    # Get a specific search
    api_response = api_instance.get_saved_traces_search(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SavedTracesSearchApi->get_saved_traces_search: %s\n" % e)

Parameters

Name Type Description Notes
id str

Return type

ResponseContainerSavedTracesSearch

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]

update_saved_traces_search

ResponseContainerSavedTracesSearch update_saved_traces_search(id, body=body)

Update a search

Example

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

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

# create an instance of the API class
api_instance = wavefront_api_client.SavedTracesSearchApi(wavefront_api_client.ApiClient(configuration))
id = 'id_example' # str | 
body = wavefront_api_client.SavedTracesSearch() # SavedTracesSearch | Example Body:  <pre>{   \"name\": \"beachshirts shopping\",   \"searchFilters\": {     \"filters\": [       {         \"filterType\": \"OPERATION\",         \"values\": {           \"logicalValue\": [             [               \"beachshirts.\", \"shopping.\", \"'*\"             ]           ]         }       }     ]   } }</pre> (optional)

try:
    # Update a search
    api_response = api_instance.update_saved_traces_search(id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SavedTracesSearchApi->update_saved_traces_search: %s\n" % e)

Parameters

Name Type Description Notes
id str
body SavedTracesSearch Example Body: <pre>{ &quot;name&quot;: &quot;beachshirts shopping&quot;, &quot;searchFilters&quot;: { &quot;filters&quot;: [ { &quot;filterType&quot;: &quot;OPERATION&quot;, &quot;values&quot;: { &quot;logicalValue&quot;: [ [ &quot;beachshirts.&quot;, &quot;shopping.&quot;, &quot;'*&quot; ] ] } } ] } }</pre> [optional]

Return type

ResponseContainerSavedTracesSearch

Authorization

api_key

HTTP request headers

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

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

update_saved_traces_search_for_user

ResponseContainerSavedTracesSearch update_saved_traces_search_for_user(id, body=body)

Update a search belonging to the user

Example

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

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

# create an instance of the API class
api_instance = wavefront_api_client.SavedTracesSearchApi(wavefront_api_client.ApiClient(configuration))
id = 'id_example' # str | 
body = wavefront_api_client.SavedTracesSearch() # SavedTracesSearch | Example Body:  <pre>{   \"name\": \"beachshirts shopping\",   \"searchFilters\": {     \"filters\": [       {         \"filterType\": \"OPERATION\",         \"values\": {           \"logicalValue\": [             [               \"beachshirts.\", \"shopping.\", \"'*\"             ]           ]         }       }     ]   } }</pre> (optional)

try:
    # Update a search belonging to the user
    api_response = api_instance.update_saved_traces_search_for_user(id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SavedTracesSearchApi->update_saved_traces_search_for_user: %s\n" % e)

Parameters

Name Type Description Notes
id str
body SavedTracesSearch Example Body: <pre>{ &quot;name&quot;: &quot;beachshirts shopping&quot;, &quot;searchFilters&quot;: { &quot;filters&quot;: [ { &quot;filterType&quot;: &quot;OPERATION&quot;, &quot;values&quot;: { &quot;logicalValue&quot;: [ [ &quot;beachshirts.&quot;, &quot;shopping.&quot;, &quot;'*&quot; ] ] } } ] } }</pre> [optional]

Return type

ResponseContainerSavedTracesSearch

Authorization

api_key

HTTP request headers

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

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