Skip to content

Latest commit

 

History

History
774 lines (532 loc) · 20.9 KB

AlertApi.md

File metadata and controls

774 lines (532 loc) · 20.9 KB
Raw

thirdeye_client.AlertApi

All URIs are relative to https://localhost

Method HTTP request Description
count_with_predicate3 GET /api/alerts/count
create_multiple3 POST /api/alerts
delete3 DELETE /api/alerts/{id}
delete_all3 DELETE /api/alerts/all
edit_multiple3 PUT /api/alerts
evaluate POST /api/alerts/evaluate
get7 GET /api/alerts/{id}
get8 GET /api/alerts/name/{name}
get_all3 GET /api/alerts
get_analytics GET /api/alerts/{id}/stats
get_insights GET /api/alerts/{id}/insights
get_insights1 POST /api/alerts/insights
reset POST /api/alerts/{id}/reset Delete associated anomalies and rerun detection till present
run_task POST /api/alerts/{id}/run
validate_multiple POST /api/alerts/validate

count_with_predicate3

count_with_predicate3()

Example

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

# Configure API key authorization: oauth
configuration = thirdeye_client.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 = thirdeye_client.AlertApi(thirdeye_client.ApiClient(configuration))

try:
    api_instance.count_with_predicate3()
except ApiException as e:
    print("Exception when calling AlertApi->count_with_predicate3: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

oauth

HTTP request headers

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

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

create_multiple3

create_multiple3(body=body)

Example

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

# Configure API key authorization: oauth
configuration = thirdeye_client.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 = thirdeye_client.AlertApi(thirdeye_client.ApiClient(configuration))
body = [thirdeye_client.AlertApiModel()] # list[AlertApiModel] |  (optional)

try:
    api_instance.create_multiple3(body=body)
except ApiException as e:
    print("Exception when calling AlertApi->create_multiple3: %s\n" % e)

Parameters

Name Type Description Notes
body list[AlertApiModel] [optional]

Return type

void (empty response body)

Authorization

oauth

HTTP request headers

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

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

delete3

delete3(id)

Example

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

# Configure API key authorization: oauth
configuration = thirdeye_client.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 = thirdeye_client.AlertApi(thirdeye_client.ApiClient(configuration))
id = 789 # int | 

try:
    api_instance.delete3(id)
except ApiException as e:
    print("Exception when calling AlertApi->delete3: %s\n" % e)

Parameters

Name Type Description Notes
id int

Return type

void (empty response body)

Authorization

oauth

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_all3

delete_all3()

Example

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

# Configure API key authorization: oauth
configuration = thirdeye_client.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 = thirdeye_client.AlertApi(thirdeye_client.ApiClient(configuration))

try:
    api_instance.delete_all3()
except ApiException as e:
    print("Exception when calling AlertApi->delete_all3: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

oauth

HTTP request headers

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

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

edit_multiple3

edit_multiple3(body=body)

Example

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

# Configure API key authorization: oauth
configuration = thirdeye_client.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 = thirdeye_client.AlertApi(thirdeye_client.ApiClient(configuration))
body = [thirdeye_client.AlertApiModel()] # list[AlertApiModel] |  (optional)

try:
    api_instance.edit_multiple3(body=body)
except ApiException as e:
    print("Exception when calling AlertApi->edit_multiple3: %s\n" % e)

Parameters

Name Type Description Notes
body list[AlertApiModel] [optional]

Return type

void (empty response body)

Authorization

oauth

HTTP request headers

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

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

evaluate

evaluate(body=body)

Example

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

# Configure API key authorization: oauth
configuration = thirdeye_client.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 = thirdeye_client.AlertApi(thirdeye_client.ApiClient(configuration))
body = thirdeye_client.AlertEvaluationApiModel() # AlertEvaluationApiModel |  (optional)

try:
    api_instance.evaluate(body=body)
except ApiException as e:
    print("Exception when calling AlertApi->evaluate: %s\n" % e)

Parameters

Name Type Description Notes
body AlertEvaluationApiModel [optional]

Return type

void (empty response body)

Authorization

oauth

HTTP request headers

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

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

get7

get7(id)

Example

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

# Configure API key authorization: oauth
configuration = thirdeye_client.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 = thirdeye_client.AlertApi(thirdeye_client.ApiClient(configuration))
id = 789 # int | 

try:
    api_instance.get7(id)
except ApiException as e:
    print("Exception when calling AlertApi->get7: %s\n" % e)

Parameters

Name Type Description Notes
id int

Return type

void (empty response body)

Authorization

oauth

HTTP request headers

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

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

get8

get8(name)

Example

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

# Configure API key authorization: oauth
configuration = thirdeye_client.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 = thirdeye_client.AlertApi(thirdeye_client.ApiClient(configuration))
name = 'name_example' # str | 

try:
    api_instance.get8(name)
except ApiException as e:
    print("Exception when calling AlertApi->get8: %s\n" % e)

Parameters

Name Type Description Notes
name str

Return type

void (empty response body)

Authorization

oauth

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_all3

get_all3()

Example

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

# Configure API key authorization: oauth
configuration = thirdeye_client.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 = thirdeye_client.AlertApi(thirdeye_client.ApiClient(configuration))

try:
    api_instance.get_all3()
except ApiException as e:
    print("Exception when calling AlertApi->get_all3: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

oauth

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_analytics

get_analytics(id, enumeration_item_id=enumeration_item_id, start_time=start_time, end_time=end_time)

Example

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

# Configure API key authorization: oauth
configuration = thirdeye_client.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 = thirdeye_client.AlertApi(thirdeye_client.ApiClient(configuration))
id = 789 # int | 
enumeration_item_id = 789 # int |  (optional)
start_time = 789 # int |  (optional)
end_time = 789 # int |  (optional)

try:
    api_instance.get_analytics(id, enumeration_item_id=enumeration_item_id, start_time=start_time, end_time=end_time)
except ApiException as e:
    print("Exception when calling AlertApi->get_analytics: %s\n" % e)

Parameters

Name Type Description Notes
id int
enumeration_item_id int [optional]
start_time int [optional]
end_time int [optional]

Return type

void (empty response body)

Authorization

oauth

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_insights

get_insights(id)

Example

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

# Configure API key authorization: oauth
configuration = thirdeye_client.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 = thirdeye_client.AlertApi(thirdeye_client.ApiClient(configuration))
id = 789 # int | 

try:
    api_instance.get_insights(id)
except ApiException as e:
    print("Exception when calling AlertApi->get_insights: %s\n" % e)

Parameters

Name Type Description Notes
id int

Return type

void (empty response body)

Authorization

oauth

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_insights1

get_insights1(body=body)

Example

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

# Configure API key authorization: oauth
configuration = thirdeye_client.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 = thirdeye_client.AlertApi(thirdeye_client.ApiClient(configuration))
body = thirdeye_client.AlertInsightsRequestApiModel() # AlertInsightsRequestApiModel |  (optional)

try:
    api_instance.get_insights1(body=body)
except ApiException as e:
    print("Exception when calling AlertApi->get_insights1: %s\n" % e)

Parameters

Name Type Description Notes
body AlertInsightsRequestApiModel [optional]

Return type

void (empty response body)

Authorization

oauth

HTTP request headers

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

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

reset

reset(id)

Delete associated anomalies and rerun detection till present

Example

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

# Configure API key authorization: oauth
configuration = thirdeye_client.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 = thirdeye_client.AlertApi(thirdeye_client.ApiClient(configuration))
id = 789 # int | 

try:
    # Delete associated anomalies and rerun detection till present
    api_instance.reset(id)
except ApiException as e:
    print("Exception when calling AlertApi->reset: %s\n" % e)

Parameters

Name Type Description Notes
id int

Return type

void (empty response body)

Authorization

oauth

HTTP request headers

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

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

run_task

run_task(id, start=start, end=end)

Example

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

# Configure API key authorization: oauth
configuration = thirdeye_client.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 = thirdeye_client.AlertApi(thirdeye_client.ApiClient(configuration))
id = 789 # int | 
start = 789 # int |  (optional)
end = 789 # int |  (optional)

try:
    api_instance.run_task(id, start=start, end=end)
except ApiException as e:
    print("Exception when calling AlertApi->run_task: %s\n" % e)

Parameters

Name Type Description Notes
id int
start int [optional]
end int [optional]

Return type

void (empty response body)

Authorization

oauth

HTTP request headers

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

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

validate_multiple

validate_multiple(body=body)

Example

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

# Configure API key authorization: oauth
configuration = thirdeye_client.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 = thirdeye_client.AlertApi(thirdeye_client.ApiClient(configuration))
body = [thirdeye_client.AlertApiModel()] # list[AlertApiModel] |  (optional)

try:
    api_instance.validate_multiple(body=body)
except ApiException as e:
    print("Exception when calling AlertApi->validate_multiple: %s\n" % e)

Parameters

Name Type Description Notes
body list[AlertApiModel] [optional]

Return type

void (empty response body)

Authorization

oauth

HTTP request headers

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

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