UMumbrellacost

Create Viewpoint Mapping

post/api/v2/business-mapping/viewpoints/{viewpoint-id}/mappings

Request

  • Base URL
    https://api.umbrellacost.io
  • URL
    https://api.umbrellacost.io/api/v2/business-mapping/viewpoints/{viewpoint-id}/mappings
  • Auth
    none declared. Required headers: authorization, apikey

Path parameters

viewpoint-idstring required

viewpoint uuid

Headers

authorizationstring required
apikeystring required

Request body

namestring required

Display name, and the value this mapping contributes to the viewpoint dimension. Names are how split targets and viewpoint filters address a mapping, so keep them unique within a viewpoint.

mappingGroupIdstring

Puts the new mapping inside a mapping group (if defined).

splitboolean

Turns this into a split mapping - its cost is redistributed onto other mappings instead of staying here. See Split explanation above.

k8sboolean

Marks the mapping as a Kubernetes mapping, so its rules are resolved against the K8s dataset.

k8s_configobject

Kubernetes display options

is_group_byboolean

Makes this a Group By mapping - one bucket per distinct value of group_by_field. See Mapping types above.

group_by_fieldstring

The dimension to bucket by.

is_telemetryboolean

Allocates by a Unit Economics pipeline metric instead of by cost ratio.

telemetryConfigobject

{ pipelineId, dimension, metric, granularity, includeUnmatched }; granularity is daily (default) or monthly. Not validated on this route — the in-app route requires pipelineId, dimension and metric, and forbids combining is_telemetry with split or is_group_by. The public route enforces none of that, so hold the rule yourself.

Response

uuidstring
creation_timestring
update_timestring
created_bystring
namestring
account_idstring
account_keystring
division_idstring
splitboolean
splitOptionsstring
globalboolean
rulesstring

Changes

No recorded changes to this operation across all 1 revision of this API.