Skip to content

WebsiteCatalogApi.md

Latest commit

 

History

History
249 lines (169 loc) · 7.94 KB

WebsiteCatalogApi.md

File metadata and controls

249 lines (169 loc) · 7.94 KB
Raw

instana_client.WebsiteCatalogApi

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

Method HTTP request Description
get_website_catalog_metrics GET /api/website-monitoring/catalog/metrics Metric catalog
get_website_catalog_tags GET /api/website-monitoring/catalog/tags Get all existing website tags
get_website_tag_catalog GET /api/website-monitoring/catalog Get website tag catalog

get_website_catalog_metrics

List[WebsiteMonitoringMetricDescription] get_website_catalog_metrics()

Metric catalog

API to get catalog of website metrics.

Example

  • Api Key Authentication (ApiKeyAuth):
import instana_client
from instana_client.models.website_monitoring_metric_description import WebsiteMonitoringMetricDescription
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.WebsiteCatalogApi(api_client)

    try:
        # Metric catalog
        api_response = api_instance.get_website_catalog_metrics()
        print("The response of WebsiteCatalogApi->get_website_catalog_metrics:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WebsiteCatalogApi->get_website_catalog_metrics: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

List[WebsiteMonitoringMetricDescription]

Authorization

ApiKeyAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -
401 Unauthorized access - requires user authentication. -
500 Internal server error. -

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

get_website_catalog_tags

List[Tag] get_website_catalog_tags()

Get all existing website tags

API to get all existing website tags.

Example

  • Api Key Authentication (ApiKeyAuth):
import instana_client
from instana_client.models.tag import Tag
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.WebsiteCatalogApi(api_client)

    try:
        # Get all existing website tags
        api_response = api_instance.get_website_catalog_tags()
        print("The response of WebsiteCatalogApi->get_website_catalog_tags:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WebsiteCatalogApi->get_website_catalog_tags: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

List[Tag]

Authorization

ApiKeyAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -
401 Unauthorized access - requires user authentication. -
500 Internal server error. -

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

get_website_tag_catalog

TagCatalog get_website_tag_catalog(beacon_type, use_case)

Get website tag catalog

API to get website tag catalog for specified beaconType and useCase.

Example

  • Api Key Authentication (ApiKeyAuth):
import instana_client
from instana_client.models.tag_catalog import TagCatalog
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.WebsiteCatalogApi(api_client)
    beacon_type = 'pageLoad' # str | beaconType
    use_case = 'GROUPING' # str | useCase

    try:
        # Get website tag catalog
        api_response = api_instance.get_website_tag_catalog(beacon_type, use_case)
        print("The response of WebsiteCatalogApi->get_website_tag_catalog:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WebsiteCatalogApi->get_website_tag_catalog: %s\n" % e)

Parameters

Name Type Description Notes
beacon_type str beaconType
use_case str useCase

Return type

TagCatalog

Authorization

ApiKeyAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -
400 When the combination of beaconType and useCase is unsupported/unknown. -
401 Unauthorized access - requires user authentication. -
500 Internal server error. -

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