kpi

Kpi

Bases: KpiMetadata

Kpi object to interact with kpi specific endpoints.

short_display_name class-attribute instance-attribute

short_display_name = Field(None, alias='shortDisplayName')

description class-attribute instance-attribute

description = Field(None, alias='description')

scope class-attribute instance-attribute

scope = Field(None, alias='scope')

internal_note class-attribute instance-attribute

internal_note = Field(None, alias='internalNote')

custom_attributes class-attribute instance-attribute

custom_attributes = Field(None, alias='customAttributes')

auto_generated class-attribute instance-attribute

auto_generated = Field(None, alias='autoGenerated')

filter_ids class-attribute instance-attribute

filter_ids = Field(None, alias='filterIds')

unit class-attribute instance-attribute

unit = Field(None, alias='unit')

format class-attribute instance-attribute

format = Field(None, alias='format')

breakdowns class-attribute instance-attribute

breakdowns = Field(None, alias='breakdowns')

aggregations class-attribute instance-attribute

aggregations = Field(None, alias='aggregations')

parameters class-attribute instance-attribute

parameters = Field(None, alias='parameters')

targets class-attribute instance-attribute

targets = Field(None, alias='targets')

desired_direction class-attribute instance-attribute

desired_direction = Field(None, alias='desiredDirection')

priority class-attribute instance-attribute

priority = Field(None, alias='priority')

benchmarking class-attribute instance-attribute

benchmarking = Field(None, alias='benchmarking')

type_ class-attribute instance-attribute

type_ = Field(None, alias='type')

benchmarkable class-attribute instance-attribute

benchmarkable = Field(None, alias='benchmarkable')

client class-attribute instance-attribute

client = Field(..., exclude=True)

id instance-attribute

id

Id of Kpi.

display_name instance-attribute

display_name

Display name of Kpi.

pql instance-attribute

pql

PQL query of Kpi.

knowledge_model_id instance-attribute

knowledge_model_id

Id of knowledge model where Kpi is located.

from_transport classmethod

from_transport(client, knowledge_model_id, kpi_transport)

Creates high-level Kpi object from given KpiMetadata.

Parameters:

• client (Client) –

  Client to use to make API calls for given kpi.

• knowledge_model_id (str) –

  Id of knowledge model where kpi is located.

• kpi_transport (KpiMetadata) –

  KpiMetadata object containing properties of kpi.

Returns:

• Kpi –

  A Kpi object with properties from transport and given client.

update

update()

Pushes local changes of kpi to EMS and updates properties with response from EMS.

sync

sync()

Syncs kpi properties with EMS.

delete

delete()

Deletes kpi.