UsageApi.md

gooddata_api_client.UsageApi

All URIs are relative to http://localhost

Method	HTTP request	Description
all_platform_usage	GET /api/v1/actions/collectUsage	Info about the platform usage.
particular_platform_usage	POST /api/v1/actions/collectUsage	Info about the platform usage for particular items.

all_platform_usage

[PlatformUsage] all_platform_usage()

Info about the platform usage.

Provides information about platform usage, like amount of users, workspaces, ... NOTE: The admin user is always excluded from this amount.

Example

import time
import gooddata_api_client
from gooddata_api_client.api import usage_api
from gooddata_api_client.model.platform_usage import PlatformUsage
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = gooddata_api_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with gooddata_api_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = usage_api.UsageApi(api_client)

    # example, this endpoint has no required or optional parameters
    try:
        # Info about the platform usage.
        api_response = api_instance.all_platform_usage()
        pprint(api_response)
    except gooddata_api_client.ApiException as e:
        print("Exception when calling UsageApi->all_platform_usage: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

[PlatformUsage]

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

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

particular_platform_usage

[PlatformUsage] particular_platform_usage(platform_usage_request)

Info about the platform usage for particular items.

Provides information about platform usage, like amount of users, workspaces, ... NOTE: The admin user is always excluded from this amount.

Example

import time
import gooddata_api_client
from gooddata_api_client.api import usage_api
from gooddata_api_client.model.platform_usage_request import PlatformUsageRequest
from gooddata_api_client.model.platform_usage import PlatformUsage
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = gooddata_api_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with gooddata_api_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = usage_api.UsageApi(api_client)
    platform_usage_request = PlatformUsageRequest(
        usage_item_names=[
            "UserCount",
        ],
    ) # PlatformUsageRequest | 

    # example passing only required values which don't have defaults set
    try:
        # Info about the platform usage for particular items.
        api_response = api_instance.particular_platform_usage(platform_usage_request)
        pprint(api_response)
    except gooddata_api_client.ApiException as e:
        print("Exception when calling UsageApi->particular_platform_usage: %s\n" % e)

Parameters

Name	Type	Description	Notes
platform_usage_request	PlatformUsageRequest

Return type

[PlatformUsage]

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

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