ai-core-api-client/docs/MetricsApi.md

openapi_client.MetricsApi

All URIs are relative to /api/v1

Method	HTTP request	Description
metrics_get	GET /metrics	Get company metrics

metrics_get

DomainMetricsResponse metrics_get()

Get company metrics

This endpoint returns metrics of a specific company by its token in the database.

Example

• Api Key Authentication (BearerAuth):

import openapi_client
from openapi_client.models.domain_metrics_response import DomainMetricsResponse
from openapi_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "/api/v1"
)

# 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: BearerAuth
configuration.api_key['BearerAuth'] = os.environ["API_KEY"]

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

# Enter a context with an instance of the API client
with openapi_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = openapi_client.MetricsApi(api_client)

    try:
        # Get company metrics
        api_response = api_instance.metrics_get()
        print("The response of MetricsApi->metrics_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MetricsApi->metrics_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

DomainMetricsResponse

Authorization

BearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-

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