Skip to content

EndUserMonitoringApi.md

Latest commit

 

History

History
89 lines (59 loc) · 2.71 KB

EndUserMonitoringApi.md

File metadata and controls

89 lines (59 loc) · 2.71 KB

instana_client.EndUserMonitoringApi

All URIs are relative to https://unit-tenant.instana.io

Method HTTP request Description
get_impacted_users_report GET /api/eum/impact/report/{eventId} Get impacted users report

get_impacted_users_report

get_impacted_users_report(event_id)

Get impacted users report

Gets a report of users impacted by an event which was created from a smart alert violation

Example

  • Api Key Authentication (ApiKeyAuth):
import instana_client
from instana_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://unit-tenant.instana.io
# See configuration.py for a list of all supported configuration parameters.
configuration = instana_client.Configuration(
    host = "https://unit-tenant.instana.io"
)

# 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.

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with instana_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = instana_client.EndUserMonitoringApi(api_client)
    event_id = 'event_id_example' # str | 

    try:
        # Get impacted users report
        api_instance.get_impacted_users_report(event_id)
    except Exception as e:
        print("Exception when calling EndUserMonitoringApi->get_impacted_users_report: %s\n" % e)

Parameters

Name Type Description Notes
event_id str

Return type

void (empty response body)

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/csv

HTTP response details

Status code Description Response headers
200 OK -
401 Unauthorized access - requires user authentication. -
403 Insufficient permissions or limited in access. -
404 Resource not found. -
500 Internal server error. -

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