Costfluent Public API

WorkspaceCreatedResponse

id
​WorkspacePublicId · pattern: ^wsp_[A-Za-z0-9_-]{2… · required
name
​string · required

WorkspacePublicId

string · pattern: ^wsp_[A-Za-z0-9_-]{2…

ApiError

type
​string · required
title
​string · required
status
​integer · int32 · required
code
​string · required
retryable
​boolean · required
detail
​string | null
instance
​string | null
traceId
​string | null
​array | null

ApiErrorEntry

name
​string · required
reason
​string · required
code
​string | null
​object | null

CreateWorkspaceRequest

name
​string · minLength: 0 · maxLength: 200 · required
currency
​string · minLength: 3 · maxLength: 3 · pattern: ^[A-Z]{3}$ · required
timeZone
​string | null

DeleteWorkspaceRequest

WorkspaceResponse

id
​WorkspacePublicId · pattern: ^wsp_[A-Za-z0-9_-]{2… · required
name
​string · required
currency
​string · pattern: ^[A-Z]{3}$ · required
enableCurrencyConversion
​boolean · required
conversionMethod
​FxMethod · required
enableAutomaticSyncing
​boolean · required
blendCommitmentDiscounts
​boolean · required
timeZone
​string · required
​WorkspaceReportDefaultsResponse · required
anomaliesExcludeMarketplace
​boolean · required
anomaliesExcludeCommitmentFees
​boolean · required
anomalyNotificationThreshold
​string · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,… · required
providerCount
​integer · int32 · required
createdAt
​string · date-time · required
conversionCurrency
​string | null · pattern: ^[A-Z]{3}$
updatedAt
​string | null · date-time

FxMethod

string

WorkspaceReportDefaultsResponse

dateInterval
​DateInterval · required
dateBin
​DateBin · required
includeCredits
​boolean · required
includeRefunds
​boolean · required
includeTax
​boolean · required
amortize
​boolean · required
showForecast
​boolean · required
compareToLastPeriod
​boolean · required

DateInterval

string

DateBin

string

GetWorkspaceRequest

PaginatedResponseOfWorkspaceResponse

​PaginationLinks · required
​WorkspaceResponse[] · required
self
​string · required
first
​string | null
prev
​string | null
next
​string | null
last
​string | null

PaginatedRequest

UpdateWorkspaceRequest

name
​string | null · minLength: 0 · maxLength: 200
currency
​string | null · pattern: ^[A-Z]{3}$
enableCurrencyConversion
​boolean | null
conversionCurrency
​string | null · pattern: ^[A-Z]{3}$
​
enableAutomaticSyncing
​boolean | null
blendCommitmentDiscounts
​boolean | null
timeZone
​string | null
​
anomaliesExcludeMarketplace
​boolean | null
anomaliesExcludeCommitmentFees
​boolean | null
anomalyNotificationThreshold
​string | null · decimal · min: 0 · pattern: ^-?[0-9]+(\.[0-9]{1,…

WorkspaceReportDefaultsRequest

​
​
includeCredits
​boolean | null
includeRefunds
​boolean | null
includeTax
​boolean | null
amortize
​boolean | null
showForecast
​boolean | null
compareToLastPeriod
​boolean | null

WorkspaceProviderResponse

id
​WorkspaceProviderPublicId · pattern: ^wpr_[A-Za-z0-9_-]{2… · required
workspaceId
​WorkspacePublicId · pattern: ^wsp_[A-Za-z0-9_-]{2… · required
providerId
​ProviderPublicId · pattern: ^prv_[A-Za-z0-9_-]{2… · required
providerName
​string · required
isEnabled
​boolean · required
accountIds
​string[] · required
addedAt
​string · date-time · required
​

WorkspaceProviderPublicId

string · pattern: ^wpr_[A-Za-z0-9_-]{2…

ProviderPublicId

string · pattern: ^prv_[A-Za-z0-9_-]{2…

ProviderKey

string

CreateWorkspaceProviderRequest

workspaceId
​WorkspacePublicId · minLength: 1 · pattern: ^wsp_[A-Za-z0-9_-]{2… · required
providerId
​ProviderPublicId · minLength: 1 · pattern: ^prv_[A-Za-z0-9_-]{2… · required
accountIds
​array | null

DeleteWorkspaceProviderRequest

GetWorkspaceProviderRequest

PaginatedResponseOfWorkspaceProviderResponse

​PaginationLinks · required
​WorkspaceProviderResponse[] · required

ListWorkspaceProvidersRequest

UpdateWorkspaceProviderRequest

workspaceId
​WorkspacePublicId · minLength: 1 · pattern: ^wsp_[A-Za-z0-9_-]{2… · required
isEnabled
​boolean | null
accountIds
​array | null

VirtualTagCreatedResponse

id
​VirtualTagPublicId · pattern: ^vtag_[A-Za-z0-9_-]{… · required
key
​string · required

VirtualTagPublicId

string · pattern: ^vtag_[A-Za-z0-9_-]{…

CreateVirtualTagRequest

workspaceId
​WorkspacePublicId · minLength: 1 · pattern: ^wsp_[A-Za-z0-9_-]{2… · required
key
​string · required
description
​string | null
defaultValue
​string | null
collapsedTagKeys
​string[]

VirtualTagRuleRequest

value
​string · required
filter
​string · required

DeleteVirtualTagRequest

VirtualTagResponse

id
​VirtualTagPublicId · pattern: ^vtag_[A-Za-z0-9_-]{… · required
key
​string · required
collapsedTagKeys
​string[] · required
​VirtualTagRuleResponse[] · required
createdAt
​string · date-time · required
description
​string | null
defaultValue
​string | null
updatedAt
​string | null · date-time

VirtualTagRuleResponse

value
​string · required
filter
​string · required

GetVirtualTagRequest

PaginatedResponseOfVirtualTagResponse

​PaginationLinks · required
​VirtualTagResponse[] · required

ListVirtualTagsRequest

UpdateVirtualTagRouteRequest

workspaceId
​WorkspacePublicId · minLength: 1 · pattern: ^wsp_[A-Za-z0-9_-]{2… · required
key
​string | null
description
​string | null
clearDescription
​boolean
defaultValue
​string | null
clearDefaultValue
​boolean
collapsedTagKeys
​array | null
​array | null

MeResponse

organizationId
​OrganizationPublicId · pattern: ^org_[A-Za-z0-9_-]{2… · required
tokenType
​ApiTokenType · required
tokenName
​string · required
capabilities
​ApiTokenCapability[] · required
​
​
clusterId
​string | null

OrganizationPublicId

string · pattern: ^org_[A-Za-z0-9_-]{2…

ApiTokenType

string

ApiTokenCapability

string

PingResponse

status
​string · required
timestamp
​string · date-time · required
version
​string · required

PaginatedResponseOfUserResponse

​PaginationLinks · required
​UserResponse[] · required

UserResponse

id
​UserPublicId · pattern: ^usr_[A-Za-z0-9_-]{2… · required
email
​string · required
firstName
​string · required
lastName
​string · required
role
​OrganizationRole · required
status
​string · required
joinedAt
​string · date-time · required
lastLoginAt
​string | null · date-time
inviteExpiresAt
​string | null · date-time

UserPublicId

string · pattern: ^usr_[A-Za-z0-9_-]{2…

OrganizationRole

string

ListUsersRequest

GetUserRequest

UserInvitedResponse

id
​UserPublicId · pattern: ^usr_[A-Za-z0-9_-]{2… · required
email
​string · required

InviteUserRequest

email
​string · minLength: 0 · maxLength: 320 · required
firstName
​string · minLength: 0 · maxLength: 100 · required
lastName
​string · minLength: 0 · maxLength: 100 · required
role
​InvitationRole · enum · required
Enum values:
viewer
editor
integrationOwner

InvitationRole

string · enum
Enum values:
viewer
editor
integrationOwner

TeamResponse

id
​TeamPublicId · pattern: ^team_[A-Za-z0-9_-]{… · required
name
​string · required
isSystemTeam
​boolean · required
memberCount
​integer · int32 · required
createdAt
​string · date-time · required

TeamPublicId

string · pattern: ^team_[A-Za-z0-9_-]{…

CreateTeamRequest

name
​string · minLength: 0 · maxLength: 200 · required

DeleteTeamRequest

TeamDetailResponse

id
​TeamPublicId · pattern: ^team_[A-Za-z0-9_-]{… · required
name
​string · required
isSystemTeam
​boolean · required
​TeamMemberResponse[] · required
​TeamWorkspaceAccessResponse[] · required
createdAt
​string · date-time · required

TeamMemberResponse

userId
​UserPublicId · pattern: ^usr_[A-Za-z0-9_-]{2… · required
email
​string · required
firstName
​string · required
lastName
​string · required
role
​TeamRole · required
joinedAt
​string · date-time · required

TeamRole

string

TeamWorkspaceAccessResponse

workspaceId
​WorkspacePublicId · pattern: ^wsp_[A-Za-z0-9_-]{2… · required
workspaceName
​string · required
accessLevel
​WorkspaceAccessLevel · required
​

WorkspaceAccessLevel

string

DashboardPublicId

string · pattern: ^dsh_[A-Za-z0-9_-]{2…

GetTeamRequest

PaginatedResponseOfTeamResponse

​PaginationLinks · required
​TeamResponse[] · required

ListTeamsRequest

AddTeamMemberRequest

userId
​UserPublicId · minLength: 1 · pattern: ^usr_[A-Za-z0-9_-]{2… · required
role
​TeamRole · required

UpdateTeamMemberRequest

role
​TeamRole · required

RemoveTeamMemberRequest

PaginatedResponseOfTeamWorkspaceAccessResponse

​PaginationLinks · required
​TeamWorkspaceAccessResponse[] · required

ListTeamWorkspaceAccessRequest

SetTeamWorkspaceAccessRequest

accessLevel
​WorkspaceAccessLevel · required

SetTeamDefaultDashboardRequest

​

RemoveTeamWorkspaceAccessRequest

UpdateTeamRequest

name
​string · minLength: 0 · maxLength: 200 · required

DeleteTagKeyRequest

TagKeyPublicId

string · pattern: ^tag_[A-Za-z0-9_-]{2…

TagKeyResponse

id
​TagKeyPublicId · pattern: ^tag_[A-Za-z0-9_-]{2… · required
key
​string · required
providerKeys
​string[] · required
createdAt
​string · date-time · required
isHidden
​boolean · required
isPreferred
​boolean · required
lastSeenAt
​string | null · date-time

GetTagKeyRequest

TagPolicyResponse

​TagPolicyRuleResponse[] · required
​
updatedAt
​string | null · date-time

TagPolicyRuleResponse

accountIds
​string[] · required
requiredKeys
​string[] · required
​

CostReportPublicId

string · pattern: ^crp_[A-Za-z0-9_-]{2…

GetTagPolicyRequest

PaginatedResponseOfTagKeyResponse

​PaginationLinks · required
​TagKeyResponse[] · required

ListTagKeysRequest

UpdateTagPolicyRequest

​TagPolicyRuleRequest[] · required

TagPolicyRuleRequest

requiredKeys
​string[] · required
​
accountIds
​string[]

SavingsViewResponse

id
​SavingsViewPublicId · pattern: ^svw_[A-Za-z0-9_-]{2… · required
title
​string · required
tab
​SavingsQueueTab · required
createdAt
​string · date-time · required
​
​
​
minimumMonthlySaving
​string | null · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,…
updatedAt
​string | null · date-time

SavingsViewPublicId

string · pattern: ^svw_[A-Za-z0-9_-]{2…

SavingsQueueTab

string

SavingsItemSource

string

SavingsItemKind

string

CreateSavingsViewRequest

workspaceId
​WorkspacePublicId · minLength: 1 · pattern: ^wsp_[A-Za-z0-9_-]{2… · required
title
​string · minLength: 1 · required
tab
​SavingsQueueTab · required
​
​
​
minimumMonthlySaving
​string | null · decimal · min: 0 · pattern: ^-?[0-9]+(\.[0-9]{1,…

DeleteSavingsViewRequest

GetSavingsViewRequest

PaginatedResponseOfSavingsViewResponse

​PaginationLinks · required
​SavingsViewResponse[] · required

ListSavingsViewsRequest

UpdateSavingsViewRequest

title
​string · minLength: 1 · required
tab
​SavingsQueueTab · required
​
​
​
minimumMonthlySaving
​string | null · decimal · min: 0 · pattern: ^-?[0-9]+(\.[0-9]{1,…

SavingsItemResponse

id
​SavingsItemPublicId · pattern: ^sav_[A-Za-z0-9_-]{2… · required
title
​string · required
evidence
​string · required
estimatedMonthlySaving
​string · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,… · required
currency
​string · pattern: ^[A-Z]{3}$ · required
costBasis
​string · required
owner
​string · required
confidence
​SavingsItemRating · required
risk
​SavingsItemRating · required
effort
​SavingsItemRating · required
status
​SavingsItemStatus · required
source
​SavingsItemSource · required
createdAt
​string · date-time · required
rejectionReason
​string | null
verifiedMonthlySaving
​string | null · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,…
​
resource
​string | null
scope
​string | null
lastSeenAt
​string | null · date-time
​
lastMeasurementScope
​string | null
lastMeasurementRealizedMonthly
​string | null · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,…
lastMeasuredAt
​string | null · date-time
acceptedAt
​string | null · date-time
implementedAt
​string | null · date-time
verifiedAt
​string | null · date-time
rejectedAt
​string | null · date-time
updatedAt
​string | null · date-time

SavingsItemPublicId

string · pattern: ^sav_[A-Za-z0-9_-]{2…

SavingsItemRating

string

SavingsItemStatus

string

SavingsVerificationOutcome

string

GetSavingsItemRequest

PaginatedResponseOfSavingsItemResponse

​PaginationLinks · required
​SavingsItemResponse[] · required

ListSavingsItemsRequest

SavingsQueueSort

string · enum
Enum values:
newest
largestSaving

SavedFilterCreatedResponse

id
​SavedFilterPublicId · pattern: ^flt_[A-Za-z0-9_-]{2… · required
title
​string · required

SavedFilterPublicId

string · pattern: ^flt_[A-Za-z0-9_-]{2…

CreateSavedFilterRequest

workspaceId
​WorkspacePublicId · minLength: 1 · pattern: ^wsp_[A-Za-z0-9_-]{2… · required
title
​string · minLength: 0 · maxLength: 200 · required
filter
​string · minLength: 1 · required
isDefault
​boolean

DeleteSavedFilterRequest

SavedFilterResponse

id
​SavedFilterPublicId · pattern: ^flt_[A-Za-z0-9_-]{2… · required
title
​string · required
filter
​string · required
isDefault
​boolean · required
createdAt
​string · date-time · required

GetSavedFilterRequest

PaginatedResponseOfSavedFilterResponse

​PaginationLinks · required
​SavedFilterResponse[] · required

ListSavedFiltersRequest

UpdateSavedFilterRequest

title
​string | null
filter
​string | null
isDefault
​boolean | null

ProviderCreatedResponse

id
​ProviderPublicId · pattern: ^prv_[A-Za-z0-9_-]{2… · required
type
​ProviderType · required
key
​ProviderKey · required
displayName
​string · required

ProviderType

string

ConnectProviderRequest

key
​ProviderKey · required
​object · required
displayName
​string | null · minLength: 0 · maxLength: 255
description
​string | null · minLength: 0 · maxLength: 1000
​
externalId
​string | null
​object | null
syncFrequencyMinutes
​integer · int32 · min: 60 · max: 1440

DeleteProviderRequest

PaginatedResponseOfProviderDefinitionResponse

​PaginationLinks · required
​ProviderDefinitionResponse[] · required

ProviderDefinitionResponse

key
​ProviderKey · required
type
​ProviderType · required
displayName
​string · required
requiresParentProvider
​boolean · required
requiredCredentialFields
​string[] · required
optionalSettingFields
​string[] · required
kind
​ProviderKind · required
iconUrl
​string | null

ProviderKind

string

AwsConnectorResponse

principalArn
​string · required
externalId
​string · required
region
​string · required
templateUrl
​string | null

ProviderResponse

id
​ProviderPublicId · pattern: ^prv_[A-Za-z0-9_-]{2… · required
type
​ProviderType · required
key
​ProviderKey · required
displayName
​string · required
status
​ProviderStatus · required
syncFrequencyMinutes
​integer · int32 · required
createdAt
​string · date-time · required
description
​string | null
​
externalId
​string | null
lastSyncAt
​string | null · date-time
lastSyncStatus
​string | null
lastSyncError
​string | null
nextSyncAt
​string | null · date-time
updatedAt
​string | null · date-time

ProviderStatus

string

GetProviderRequest

PaginatedResponseOfSyncHistoryEntryResponse

​PaginationLinks · required
​SyncHistoryEntryResponse[] · required

SyncHistoryEntryResponse

startedAt
​string · date-time · required
status
​string · required
quarantinedCount
​integer · int32 · required
completedAt
​string | null · date-time
recordsIngested
​integer | null · int32
errorMessage
​string | null

GetProviderSyncHistoryRequest

PaginatedResponseOfProviderResponse

​PaginationLinks · required
​ProviderResponse[] · required

ListProvidersRequest

GcpServiceAccountResponse

serviceAccountEmail
​string · required
organizationId
​string | null · pattern: ^[0-9]+$
directoryCustomerId
​string | null

ConnectionTestResponse

success
​boolean · required
message
​string | null
​object | null

TestProviderConnectionRequest

SyncTriggerResponse

triggered
​boolean · required
message
​string | null

TriggerProviderSyncRequest

fullSync
​boolean

UpdateProviderRequest

displayName
​string | null
description
​string | null · minLength: 0 · maxLength: 1000
clearDescription
​boolean
externalId
​string | null
​object | null
​object | null
clearSettings
​boolean
syncFrequencyMinutes
​integer | null · int32 · min: 60 · max: 1440

KubernetesEfficiencyResponse

level
​KubernetesEfficiencyLevel · required
​KubernetesEfficiencyRowResponse[] · required
truncated
​boolean · required
​CurrencyAmount[] · required
currency
​string | null · pattern: ^[A-Z]{3}$
historyFloor
​string | null · date

KubernetesEfficiencyLevel

string

KubernetesEfficiencyRowResponse

cluster
​string · required
cost
​string · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,… · required
idleCost
​string · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,… · required
​ResourceEfficiencyResponse · required
​ResourceEfficiencyResponse · required
namespace
​string | null
workload
​string | null

ResourceEfficiencyResponse

requested
​number · double · required
used
​number · double · required
peak
​number · double · required
usedPercent
​number | null · double
peakPercent
​number | null · double

CurrencyAmount

currency
​string · pattern: ^[A-Z]{3}$ · required
amount
​string · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,… · required

GetKubernetesEfficiencyRequest

KubernetesReportAcceptedResponse

id
​K8sClusterPublicId · pattern: ^k8s_[A-Za-z0-9_-]{2… · required
cluster_id
​string · required
status
​K8sClusterStatus · required

K8sClusterPublicId

string · pattern: ^k8s_[A-Za-z0-9_-]{2…

K8sClusterStatus

string

KubernetesReport

schema_version
​integer · int32
cluster_id
​string
agent_version
​string
agent_instance_id
​string
window_start
​string · date-time
window_end
​string · date-time
​array | null

KubernetesReportNode

name
​string
provider_id
​string | null
instance_type
​string | null
region
​string | null
zone
​string | null
spot
​boolean
observed_seconds
​number · double
capacity_cpu_cores
​number · double
capacity_memory_bytes
​integer · int64
capacity_gpu
​integer · int32
​object | null
allocatable_cpu_cores
​number · double
allocatable_memory_bytes
​integer · int64
​object | null
​object | null
​object | null

KubernetesReportPod

namespace
​string
name
​string
node
​string
controller_kind
​string | null
controller
​string | null
​object | null
​object | null
​object | null
​KubernetesReportContainer[]
claims
​array | null

KubernetesReportContainer

name
​string
observed_seconds
​number · double
cpu_request_cores
​number · double
memory_request_bytes
​integer · int64
gpu_request
​integer · int32
​object | null
cpu_usage_core_seconds
​number · double
memory_usage_byte_seconds
​number · double
cpu_allocated_core_seconds
​number · double
memory_allocated_byte_seconds
​number · double
cpu_usage_peak_cores
​number · double
memory_usage_peak_bytes
​integer · int64

KubernetesReportVolume

name
​string
capacity_bytes
​integer · int64
storage_class
​string | null
csi_driver
​string | null
volume_handle
​string | null
phase
​string | null
claim_namespace
​string | null
claim_name
​string | null
observed_seconds
​number · double
​object | null
​object | null

FolderCreatedResponse

id
​FolderPublicId · pattern: ^fld_[A-Za-z0-9_-]{2… · required
title
​string · required

FolderPublicId

string · pattern: ^fld_[A-Za-z0-9_-]{2…

CreateFolderRequest

workspaceId
​WorkspacePublicId · minLength: 1 · pattern: ^wsp_[A-Za-z0-9_-]{2… · required
title
​string · minLength: 0 · maxLength: 200 · required
​

DeleteFolderRequest

FolderResponse

id
​FolderPublicId · pattern: ^fld_[A-Za-z0-9_-]{2… · required
title
​string · required
reportCount
​integer · int32 · required
​
​array | null
​

GetFolderRequest

PaginatedResponseOfFolderResponse

​PaginationLinks · required
​FolderResponse[] · required

ListFoldersRequest

SetFolderSavedFilterRequest

workspaceId
​WorkspacePublicId · minLength: 1 · pattern: ^wsp_[A-Za-z0-9_-]{2… · required
​

UpdateFolderRequest

workspaceId
​WorkspacePublicId · minLength: 1 · pattern: ^wsp_[A-Za-z0-9_-]{2… · required
title
​string | null · minLength: 0 · maxLength: 200
​
clearParent
​boolean

PaginatedResponseOfString

​PaginationLinks · required
data
​string[] · required

ExchangeRateResponse

baseCurrency
​string · pattern: ^[A-Z]{3}$ · required
targetCurrency
​string · pattern: ^[A-Z]{3}$ · required
rate
​number · double · required
effectiveDate
​string · date · required
source
​string · required

GetExchangeRateRequest

FxPolicyStatusResponse

available
​boolean · required
​required
​FxPolicyResponse[] · required

FxPolicyResponse

token
​FxPolicyPublicId · pattern: ^fxp_[A-Za-z0-9_-]{2… · required
method
​FxMethod · required
source
​string · required
presentationCurrency
​string · pattern: ^[A-Z]{3}$ · required
effectiveFrom
​string · date · required
effectiveToExclusive
​string | null · date · required
setAt
​string · date-time · required
isCurrent
​boolean · required
description
​string · required

FxPolicyPublicId

string · pattern: ^fxp_[A-Za-z0-9_-]{2…

GetFxPolicyRequest

PaginatedResponseOfExchangeRateResponse

​PaginationLinks · required
​ExchangeRateResponse[] · required

ListExchangeRatesRequest

DashboardCreatedResponse

id
​DashboardPublicId · pattern: ^dsh_[A-Za-z0-9_-]{2… · required
title
​string · required

CreateDashboardRequest

workspaceId
​WorkspacePublicId · minLength: 1 · pattern: ^wsp_[A-Za-z0-9_-]{2… · required
title
​string · minLength: 0 · maxLength: 200 · required
isDefault
​boolean
dateInterval
​DateInterval
dateBin
​DateBin
startDate
​string | null · date
endDate
​string | null · date

DashboardWidgetCreatedResponse

id
​DashboardWidgetPublicId · pattern: ^wdg_[A-Za-z0-9_-]{2… · required
title
​string · required

DashboardWidgetPublicId

string · pattern: ^wdg_[A-Za-z0-9_-]{2…

CreateDashboardWidgetRequest

title
​string · minLength: 0 · maxLength: 200 · required
​WidgetPositionRequest · required
type
​WidgetType
​
​
content
​string | null · minLength: 0 · maxLength: 10000

WidgetType

string

WidgetDisplay

string

WidgetPositionRequest

x
​integer · int32
y
​integer · int32
w
​integer · int32
h
​integer · int32

DeleteDashboardRequest

DeleteDashboardWidgetRequest

DashboardResponse

id
​DashboardPublicId · pattern: ^dsh_[A-Za-z0-9_-]{2… · required
title
​string · required
isDefault
​boolean · required
dateInterval
​DateInterval · required
dateBin
​DateBin · required
​WidgetResponse[] · required
createdAt
​string · date-time · required
startDate
​string | null · date
endDate
​string | null · date
​

WidgetResponse

id
​DashboardWidgetPublicId · pattern: ^wdg_[A-Za-z0-9_-]{2… · required
type
​WidgetType · required
title
​string · required
​WidgetPositionResponse · required
​
​
content
​string | null
​object | null

WidgetPositionResponse

x
​integer · int32 · required
y
​integer · int32 · required
w
​integer · int32 · required
h
​integer · int32 · required

GetDashboardRequest

GetDashboardWidgetRequest

PaginatedResponseOfDashboardResponse

​PaginationLinks · required
​DashboardResponse[] · required

ListDashboardsRequest

SetDashboardDefaultRequest

workspaceId
​WorkspacePublicId · minLength: 1 · pattern: ^wsp_[A-Za-z0-9_-]{2… · required
isDefault
​boolean · required

SetDashboardSavedFilterRequest

workspaceId
​WorkspacePublicId · minLength: 1 · pattern: ^wsp_[A-Za-z0-9_-]{2… · required
​

UpdateDashboardRequest

title
​string | null
​
​
startDate
​string | null · date
endDate
​string | null · date

UpdateDashboardWidgetRequest

title
​string | null · minLength: 0 · maxLength: 200
​
content
​string | null · minLength: 0 · maxLength: 10000
​

CustomCostUploadResponse

id
​CustomCostUploadPublicId · pattern: ^upl_[A-Za-z0-9_-]{2… · required
status
​UploadStatus · required
fileName
​string · required
fileSizeBytes
​integer · int64 · required
totalRows
​integer · int32 · required
successRows
​integer · int32 · required
errorRows
​integer · int32 · required
uploadedAt
​string · date-time · required
coveredFrom
​string | null · date
coveredTo
​string | null · date
​object | null
processedAt
​string | null · date-time
​array | null

CustomCostUploadPublicId

string · pattern: ^upl_[A-Za-z0-9_-]{2…

UploadStatus

string

CustomCostUploadError

rowNumber
​integer · int32 · required
field
​string · required
message
​string · required

UploadCustomCostsRequest

file
​array | null

PaginatedResponseOfCustomCostUploadResponse

​PaginationLinks · required
​CustomCostUploadResponse[] · required

ListCustomCostUploadsRequest

CustomCostUploadRequest

SubmitCostsResponse

batchId
​CustomCostBatchPublicId · pattern: ^cbt_[A-Za-z0-9_-]{2… · required
totalRows
​integer · int32 · required
acceptedRows
​integer · int32 · required
rejectedRows
​integer · int32 · required
​array | null

CustomCostBatchPublicId

string · pattern: ^cbt_[A-Za-z0-9_-]{2…

CostValidationError

rowIndex
​integer · int32 · required
field
​string · required
message
​string · required

SubmitCostsRequest

​CostEntry[] · minLength: 1 · required
replaceLines
​boolean

CostEntry

chargePeriodStart
​string · date · required
chargeCategory
​string · required
serviceName
​string · required
billedCost
​string · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,… · required
lineItemId
​string | null
chargePeriodEnd
​string | null · date
billingCurrency
​string | null · pattern: ^[A-Z]{3}$
serviceCategory
​string | null
resourceId
​string | null
resourceType
​string | null
regionId
​string | null
consumedQuantity
​number | null · double
consumedUnit
​string | null
​object | null
subAccountId
​string | null
subAccountName
​string | null
skuId
​string | null
effectiveCost
​string | null · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,…
chargeDescription
​string | null
commitmentDiscountId
​string | null
commitmentDiscountType
​string | null
resourceName
​string | null
regionName
​string | null
serviceSubcategory
​string | null
billingAccountId
​string | null
listCost
​string | null · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,…

ActivateCostReportSubscriptionRequest

CostReportSubscriptionPublicId

string · pattern: ^crs_[A-Za-z0-9_-]{2…

CostReportSubscriptionCreatedResponse

id
​CostReportSubscriptionPublicId · pattern: ^crs_[A-Za-z0-9_-]{2… · required
name
​string · required

CreateCostReportSubscriptionRequest

workspaceId
​WorkspacePublicId · minLength: 1 · pattern: ^wsp_[A-Za-z0-9_-]{2… · required
costReportId
​CostReportPublicId · minLength: 1 · pattern: ^crp_[A-Za-z0-9_-]{2… · required
name
​string · minLength: 0 · maxLength: 200 · required
scheduleType
​ScheduleType · required
appIds
​AppPublicId[] · minLength: 1 · required
deliveryHour
​integer | null · int32 · min: 0 · max: 23
timeZone
​string | null

ScheduleType

string

AppPublicId

string · pattern: ^app_[A-Za-z0-9_-]{2…

DeactivateCostReportSubscriptionRequest

DeleteCostReportSubscriptionRequest

CostReportSubscriptionResponse

id
​CostReportSubscriptionPublicId · pattern: ^crs_[A-Za-z0-9_-]{2… · required
costReportId
​CostReportPublicId · pattern: ^crp_[A-Za-z0-9_-]{2… · required
name
​string · required
scheduleType
​ScheduleType · required
deliveryHour
​integer · int32 · required
timeZone
​string · required
appIds
​AppPublicId[] · required
isActive
​boolean · required
createdAt
​string · date-time · required
lastSentAt
​string | null · date-time
nextScheduledAt
​string | null · date-time
updatedAt
​string | null · date-time

GetCostReportSubscriptionRequest

PaginatedResponseOfCostReportSubscriptionResponse

​PaginationLinks · required
​CostReportSubscriptionResponse[] · required

ListCostReportSubscriptionsRequest

UpdateCostReportSubscriptionRouteRequest

workspaceId
​WorkspacePublicId · minLength: 1 · pattern: ^wsp_[A-Za-z0-9_-]{2… · required
name
​string | null · minLength: 0 · maxLength: 200
​
deliveryHour
​integer | null · int32 · min: 0 · max: 23
timeZone
​string | null
appIds
​array | null

CostReportCreatedResponse

id
​CostReportPublicId · pattern: ^crp_[A-Za-z0-9_-]{2… · required
title
​string · required

CreateCostReportRequest

workspaceId
​WorkspacePublicId · minLength: 1 · pattern: ^wsp_[A-Za-z0-9_-]{2… · required
title
​string · minLength: 0 · maxLength: 200 · required
​
filter
​string | null
​array | null
​
startDate
​string | null · date
endDate
​string | null · date
chartType
​ChartType · enum
Enum values:
line
bar
stackedBar
area
pie
table
​
​
​

ReportGroupingRequest

dimension
​CostGroupDimension · enum · required
Enum values:
provider
providerName
subAccount
serviceName
region
resourceName
chargeCategory
tag
key
​string | null

CostGroupDimension

string · enum
Enum values:
provider
providerName
subAccount
serviceName
region
resourceName
chargeCategory
tag

ChartType

string · enum
Enum values:
line
bar
stackedBar
area
pie
table

ChartAxis

string · enum
Enum values:
date
group

CostReportSettingsRequest

includeCredits
​boolean | null
includeRefunds
​boolean | null
includeTax
​boolean | null
amortize
​boolean | null
showForecast
​boolean | null
compareToLastPeriod
​boolean | null
comparisonStartDate
​string | null · date
comparisonEndDate
​string | null · date
​
​
​array | null
​
unitCostScale
​integer | null · int32

CostMeasure

string

BusinessMetricPublicId

string · pattern: ^bmt_[A-Za-z0-9_-]{2…

UnitCostLabelConditionRequest

key
​string · required
values
​string[] · required

UnitCostCalculation

string

DeleteCostReportRequest

CostReportDataResponse

​ReportSummaryResponse · required
​ReportTimeSeriesResponse[] · required
​ReportBreakdownResponse[] · required
startDate
​string · date · required
endDate
​string · date · required
historyFloor
​string | null · date
​
​
dataThrough
​string | null · date
​

ReportSummaryResponse

​CurrencyPresentation · required
measure
​CostMeasure · required
​UnitQuantity[] · required
totalCost
​string | null · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,…
previousPeriodCost
​string | null · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,…
changePercent
​number | null · double
comparedThrough
​string | null · date
comparedCost
​string | null · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,…
previousComparedThrough
​string | null · date
currency
​string | null · pattern: ^[A-Z]{3}$

CurrencyPresentation

​CurrencyConversion[] · required
​CurrencyAmount[] · required
​CurrencyAmount[] · required

CurrencyConversion

sourceCurrency
​string · pattern: ^[A-Z]{3}$ · required
sourceAmount
​string · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,… · required
convertedAmount
​string · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,… · required
method
​FxMethod · required
source
​string · required
description
​string · required

UnitQuantity

unit
​string · required
quantity
​number · double · required

ReportTimeSeriesResponse

date
​string · date · required
​ReportGroupResponse[] · required

ReportGroupResponse

keys
​string[] · required
isOther
​boolean · required
cost
​string · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,… · required
currency
​string | null · pattern: ^[A-Z]{3}$
unit
​string | null

ReportBreakdownResponse

keys
​string[] · required
isOther
​boolean · required
cost
​string · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,… · required
percent
​number · double · required
currency
​string | null · pattern: ^[A-Z]{3}$
unit
​string | null
previousCost
​string | null · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,…
comparedCost
​string | null · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,…
changePercent
​number | null · double

ReportComparisonResponse

startDate
​string · date · required
endDate
​string · date · required
​ReportComparisonPointResponse[] · required

ReportComparisonPointResponse

date
​string · date · required
previousDate
​string · date · required
cost
​string · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,… · required

ReportForecastResponse

​ReportForecastPointResponse[] · required

ReportForecastPointResponse

date
​string · date · required
amount
​string · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,… · required
lowerBound
​string · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,… · required
upperBound
​string · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,… · required

ReportUnitCostResponse

metricId
​BusinessMetricPublicId · pattern: ^bmt_[A-Za-z0-9_-]{2… · required
name
​string · required
unit
​string · required
calculation
​UnitCostCalculation · required
scale
​integer · int32 · required
​ReportUnitCostPointResponse[] · required
currency
​string | null · pattern: ^[A-Z]{3}$
average
​string | null · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,…

ReportUnitCostPointResponse

date
​string · date · required
metricAmount
​string | null · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,…
unitCost
​string | null · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,…
value
​string | null · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,…

GetCostReportDataRequest

CostReportResponse

id
​CostReportPublicId · pattern: ^crp_[A-Za-z0-9_-]{2… · required
title
​string · required
​ReportGroupingResponse[] · required
dateInterval
​string · required
chartType
​string · required
chartAxis
​string · required
dateBin
​string · required
​CostReportSettingsResponse · required
createdAt
​string · date-time · required
isDefault
​boolean · required
​
filter
​string | null
startDate
​string | null · date
endDate
​string | null · date
updatedAt
​string | null · date-time

ReportGroupingResponse

dimension
​string · required
key
​string | null

CostReportSettingsResponse

includeCredits
​boolean · required
includeRefunds
​boolean · required
includeTax
​boolean · required
amortize
​boolean · required
showForecast
​boolean · required
compareToLastPeriod
​boolean · required
measure
​CostMeasure · required
​UnitCostLabelConditionResponse[] · required
unitCostCalculation
​UnitCostCalculation · required
unitCostScale
​integer · int32 · required
comparisonStartDate
​string | null · date
comparisonEndDate
​string | null · date
​

UnitCostLabelConditionResponse

key
​string · required
values
​string[] · required

GetCostReportRequest

PaginatedResponseOfCostReportResponse

​PaginationLinks · required
​CostReportResponse[] · required

ListCostReportsRequest

UpdateCostReportRequest

title
​string | null
​
clearFolder
​boolean
filter
​string | null
clearFilter
​boolean
​array | null
​
startDate
​string | null · date
clearStartDate
​boolean
endDate
​string | null · date
clearEndDate
​boolean
​
​
​
​

CostFilterTranslationResponse

filter
​string | null
query
​string | null

TranslateCostFilterRequest

CostEstimateReceiptResponse

id
​CostEstimatePublicId · pattern: ^est_[A-Za-z0-9_-]{2… · required
state
​CostEstimateState · required
appliedOn
​string | null · date

CostEstimatePublicId

string · pattern: ^est_[A-Za-z0-9_-]{2…

CostEstimateState

string

ApplyCostEstimateRequest

workspaceId
​WorkspacePublicId · minLength: 1 · pattern: ^wsp_[A-Za-z0-9_-]{2… · required
repository
​string | null
pullRequest
​integer | null · int32
plan
​string | null
​array | null

AppliedResourceRequest

address
​string · required
resourceIds
​string[] · required

CostEstimateResponse

id
​CostEstimatePublicId · pattern: ^est_[A-Za-z0-9_-]{2… · required
workspaceId
​WorkspacePublicId · pattern: ^wsp_[A-Za-z0-9_-]{2… · required
source
​string · required
currency
​string · pattern: ^[A-Z]{3}$ · required
state
​CostEstimateState · required
​CostEstimatePlannedResponse · required
resourceCount
​integer · int32 · required
createdAt
​string · date-time · required
repository
​string | null
pullRequest
​integer | null · int32
plan
​string | null
sourceVersion
​string | null
commit
​string | null
url
​string | null
​
appliedOn
​string | null · date
​
​
​array | null
updatedAt
​string | null · date-time
closedAt
​string | null · date-time

CostEstimateTagResponse

key
​string · required
value
​string · required

CostEstimateOutcome

string

CostEstimatePlannedResponse

monthlyCostBefore
​string · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,… · required
monthlyCostAfter
​string · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,… · required
monthlyChange
​string · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,… · required
unpricedResources
​integer · int32 · required

CostEstimateActualResponse

monthlyCostBefore
​string · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,… · required
monthlyCostAfter
​string · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,… · required
monthlyChange
​string · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,… · required
monthlyVariance
​string · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,… · required
billingCurrency
​string | null · pattern: ^[A-Z]{3}$
exchangeRate
​string | null · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,…

CostEstimateResourceResponse

address
​string · required
type
​string · required
change
​CostEstimateChange · required
resourceIds
​string[] · required
appliedResourceIds
​string[] · required
monthlyCostBefore
​string | null · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,…
monthlyCostAfter
​string | null · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,…
plannedChange
​string | null · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,…
​
actualMonthlyCostBefore
​string | null · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,…
actualMonthlyCostAfter
​string | null · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,…
actualChange
​string | null · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,…

CostEstimateChange

string

CostEstimateLineMatch

string

GetCostEstimateRequest

PaginatedResponseOfCostEstimateResponse

​PaginationLinks · required
​CostEstimateResponse[] · required

ListCostEstimatesRequest

SubmitCostEstimateRequest

workspaceId
​WorkspacePublicId · minLength: 1 · pattern: ^wsp_[A-Za-z0-9_-]{2… · required
source
​string · minLength: 1 · required
currency
​string · minLength: 1 · pattern: ^[A-Z]{3}$ · required
​CostEstimateResourceRequest[] · minLength: 1 · required
repository
​string | null
pullRequest
​integer | null · int32
plan
​string | null
sourceVersion
​string | null
commit
​string | null
url
​string | null
​

CostEstimateTagRequest

key
​string · required
value
​string · required

CostEstimateResourceRequest

address
​string · required
type
​string · required
change
​CostEstimateChange · required
monthlyCostBefore
​string | null · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,…
monthlyCostAfter
​string | null · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,…
resourceIds
​array | null

CostDataResponse

​PaginationLinks · required
​CostDataPoint[] · required
​CostDataMeta · required

CostDataPoint

date
​string · date · required
cost
​string · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,… · required
listCost
​string · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,… · required
amortizedCost
​string · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,… · required
currency
​string · pattern: ^[A-Z]{3}$ · required
​object · required
quantity
​number | null · double
unit
​string | null

CostDataMeta

startDate
​string · date · required
endDate
​string · date · required
granularity
​DateBin · required
measure
​CostMeasure · required
totalRecords
​integer · int32 · required
​CurrencyPresentation · required
commitmentDiscounts
​CommitmentDiscountPlacement · required
dataVersion
​string · required
totalCost
​string | null · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,…
currency
​string | null · pattern: ^[A-Z]{3}$
historyFloor
​string | null · date
dataThrough
​string | null · date

CommitmentDiscountPlacement

string

GetCostDataRequest

CostForecastResponse

isAvailable
​boolean · required
​ForecastMonthResponse[] · required
​CurrencyAmount[] · required
currentMonthActual
​string | null · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,…
currentMonthForecast
​string | null · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,…
method
​string | null
currency
​string | null · pattern: ^[A-Z]{3}$
confidencePercent
​number | null · double
generatedAt
​string | null · date-time

ForecastMonthResponse

month
​string · pattern: ^[0-9]{4}-(0[1-9]|1[… · required
amount
​string · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,… · required
lowerBound
​string · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,… · required
upperBound
​string · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,… · required

GetCostForecastRequest

CostSummaryResponse

​CurrencyPresentation · required
commitmentDiscounts
​CommitmentDiscountPlacement · required
​ServiceCostBreakdown[] · required
​ProviderCostBreakdown[] · required
totalCost
​string | null · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,…
totalListCost
​string | null · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,…
totalAmortizedCost
​string | null · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,…
currency
​string | null · pattern: ^[A-Z]{3}$
costChange
​string | null · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,…
costChangePercent
​number | null · double
historyFloor
​string | null · date
dataThrough
​string | null · date
comparedThrough
​string | null · date

ServiceCostBreakdown

serviceName
​string · required
cost
​string · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,… · required
percentage
​number · double · required

ProviderCostBreakdown

providerId
​ProviderPublicId · pattern: ^prv_[A-Za-z0-9_-]{2… · required
providerName
​string · required
providerKey
​ProviderKey · required
cost
​string · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,… · required
currency
​string | null · pattern: ^[A-Z]{3}$

GetCostSummaryRequest

CostAlertCreatedResponse

id
​CostAlertPublicId · pattern: ^alrt_[A-Za-z0-9_-]{… · required
name
​string · required

CostAlertPublicId

string · pattern: ^alrt_[A-Za-z0-9_-]{…

CreateCostAlertRequest

workspaceId
​WorkspacePublicId · minLength: 1 · pattern: ^wsp_[A-Za-z0-9_-]{2… · required
name
​string · minLength: 0 · maxLength: 255 · required
thresholdType
​AlertThresholdType · required
thresholdValue
​string · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,… · required
​
minimumAmount
​string | null · decimal · min: 0 · pattern: ^-?[0-9]+(\.[0-9]{1,…
providerIds
​array | null
filter
​string | null
appIds
​array | null
evaluationFrequencyMinutes
​integer · int32 · min: 15 · max: 1440

AlertThresholdType

string

ComparisonPeriod

string · enum
Enum values:
previousDay
previousWeek
previousMonth
sameDayLastMonth
previousQuarter

DeleteCostAlertRequest

CostAlertResponse

id
​CostAlertPublicId · pattern: ^alrt_[A-Za-z0-9_-]{… · required
name
​string · required
thresholdType
​AlertThresholdType · required
thresholdValue
​string · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,… · required
appIds
​AppPublicId[] · required
evaluationFrequencyMinutes
​integer · int32 · required
status
​AlertStatus · required
createdAt
​string · date-time · required
providerIds
​array | null
filter
​string | null
comparisonPeriod
​string | null
minimumAmount
​string | null · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,…
lastEvaluatedAt
​string | null · date-time
updatedAt
​string | null · date-time

AlertStatus

string

GetCostAlertRequest

PaginatedResponseOfCostAlertEventResponse

​PaginationLinks · required
​CostAlertEventResponse[] · required

CostAlertEventResponse

id
​CostAlertEventPublicId · pattern: ^alrt_evt_[A-Za-z0-9… · required
triggeredAt
​string · date-time · required
thresholdValue
​string · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,… · required
actualValue
​string · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,… · required
status
​AlertEventStatus · required
comparisonValue
​string | null · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,…
affectedProviderIds
​array | null
​
acknowledgedAt
​string | null · date-time
resolvedAt
​string | null · date-time

CostAlertEventPublicId

string · pattern: ^alrt_evt_[A-Za-z0-9…

AlertEventStatus

string

GetCostAlertEventsRequest

PaginatedResponseOfCostAlertResponse

​PaginationLinks · required
​CostAlertResponse[] · required

ListCostAlertsRequest

PauseCostAlertRequest

ResumeCostAlertRequest

UpdateCostAlertRouteRequest

name
​string | null · minLength: 0 · maxLength: 255
​
thresholdValue
​string | null · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,…
​
clearComparisonPeriod
​boolean
minimumAmount
​string | null · decimal · min: 0 · pattern: ^-?[0-9]+(\.[0-9]{1,…
clearMinimumAmount
​boolean
providerIds
​array | null
filter
​string | null
clearFilter
​boolean
appIds
​array | null
evaluationFrequencyMinutes
​integer | null · int32 · min: 15 · max: 1440

DpaStatusResponse

required
​boolean · required
inForce
​boolean · required
​required
​DpaExecutionResponse[] · required
collectionRefusal
​string | null · required

DpaExecutionResponse

token
​DpaExecutionPublicId · pattern: ^dpa_[A-Za-z0-9_-]{2… · required
documentVersion
​string · required
signedAt
​string · date · required
signedByName
​string · required
signedByRole
​string · required
recordedAt
​string · date-time · required
isCurrent
​boolean · required
supersededAt
​string | null · date-time · required

DpaExecutionPublicId

string · pattern: ^dpa_[A-Za-z0-9_-]{2…

CommitmentCoverageResponse

granularity
​DateBin · required
​CommitmentFiguresResponse[] · required
​CommitmentFiguresResponse[] · required
​CurrencyAmount[] · required
currency
​string | null · pattern: ^[A-Z]{3}$
historyFloor
​string | null · date

CommitmentFiguresResponse

provider
​string · required
coveredOnDemandCost
​string · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,… · required
eligibleOnDemandCost
​string · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,… · required
actualCost
​string · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,… · required
usedCommitment
​string · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,… · required
date
​string | null · date
unusedCommitment
​string | null · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,…
coveragePercent
​number | null · double
effectiveSavingsRatePercent
​number | null · double
utilizationPercent
​number | null · double

GetCommitmentCoverageRequest

PaginatedResponseOfCommitmentResponse

​PaginationLinks · required
​CommitmentResponse[] · required

CommitmentResponse

id
​string · required
providerId
​ProviderPublicId · pattern: ^prv_[A-Za-z0-9_-]{2… · required
providerName
​string · required
provider
​ProviderKey · required
type
​string · required
description
​string · required
account
​string · required
region
​string · required
service
​string · required
status
​CommitmentExpiryStatus · required
providerStatus
​string · required
currency
​string · pattern: ^[A-Z]{3}$ · required
utilizationFrom
​string · date · required
utilizationTo
​string · date · required
lastReadAt
​string · date-time · required
startsAt
​string | null · date-time
endsAt
​string | null · date-time
daysUntilExpiry
​integer | null · int32
termYears
​integer | null · int32
paymentOption
​string | null
hourlyCommitment
​string | null · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,…
fullTermCost
​string | null · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,…
utilizationPercentage
​number | null · double
unusedCost
​string | null · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,…

CommitmentExpiryStatus

string

ListCommitmentsRequest

BusinessMetricResponse

id
​BusinessMetricPublicId · pattern: ^bmt_[A-Za-z0-9_-]{2… · required
name
​string · required
unit
​string · required
labelColumns
​string[] · required
createdAt
​string · date-time · required
updatedAt
​string | null · date-time

CreateBusinessMetricRequest

workspaceId
​WorkspacePublicId · minLength: 1 · pattern: ^wsp_[A-Za-z0-9_-]{2… · required
name
​string · required
unit
​string · required
labelColumns
​array | null

BusinessMetricRequest

BusinessMetricImportResponse

created
​integer · int32 · required
updated
​integer · int32 · required
unchanged
​integer · int32 · required

ImportBusinessMetricValuesRequest

​array | null

BusinessMetricValueRequest

date
​string · date
amount
​string · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,…
​object | null

PaginatedResponseOfBusinessMetricResponse

​PaginationLinks · required
​BusinessMetricResponse[] · required

ListBusinessMetricsRequest

PaginatedResponseOfBusinessMetricValueResponse

​PaginationLinks · required
​BusinessMetricValueResponse[] · required

BusinessMetricValueResponse

date
​string · date · required
amount
​string · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,… · required
​object · required

ListBusinessMetricValuesRequest

UpdateBusinessMetricRequest

name
​string | null
unit
​string | null

BudgetResponse

id
​BudgetPublicId · pattern: ^bud_[A-Za-z0-9_-]{2… · required
name
​string · required
currency
​string · pattern: ^[A-Z]{3}$ · required
measure
​BudgetMeasure · required
startDate
​string · date · required
intervalCount
​integer · int32 · required
intervalUnit
​BudgetIntervalUnit · required
​BudgetPeriodResponse[] · required
status
​BudgetStatus · required
state
​BudgetState · required
spendAvailability
​SpendAvailability · required
​CurrencyAmount[] · required
​BudgetAlertResponse[] · required
createdAt
​string · date-time · required
amount
​string | null · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,…
usageUnit
​string | null
​
​
​
currentSpend
​string | null · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,…
budgetedToDate
​string | null · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,…
projectedSpend
​string | null · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,…
percentUsed
​number | null · double
historyFloor
​string | null · date
updatedAt
​string | null · date-time

BudgetPublicId

string · pattern: ^bud_[A-Za-z0-9_-]{2…

BudgetMeasure

string

BudgetIntervalUnit

string

BudgetPeriodResponse

startDate
​string · date · required
endDate
​string · date · required
amount
​string · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,… · required

BudgetStatus

string

BudgetState

string

SegmentPublicId

string · pattern: ^seg_[A-Za-z0-9_-]{2…

SpendAvailability

string

BudgetAlertResponse

thresholdPercent
​integer · int32 · required
basis
​BudgetAlertBasis · required
appIds
​AppPublicId[] · required
isTriggered
​boolean · required
triggeredAt
​string | null · date-time

BudgetAlertBasis

string

CreateBudgetRequest

workspaceId
​WorkspacePublicId · minLength: 1 · pattern: ^wsp_[A-Za-z0-9_-]{2… · required
name
​string · minLength: 0 · maxLength: 200 · required
currency
​string · minLength: 3 · maxLength: 3 · pattern: ^[A-Z]{3}$ · required
measure
​BudgetMeasureValue · enum
Enum values:
cost
usage
usageUnit
​string | null · minLength: 0 · maxLength: 64
startDate
​string | null · date
intervalCount
​integer · int32 · min: 1 · max: 366
intervalUnit
​BudgetIntervalUnitValue · enum
Enum values:
day
week
month
year
amount
​string | null · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,…
​array | null
​array | null
segmentId
​string | null
​
appIds
​array | null

BudgetMeasureValue

string · enum
Enum values:
cost
usage

BudgetIntervalUnitValue

string · enum
Enum values:
day
week
month
year

BudgetPeriodRequest

startDate
​string · date
endDate
​string · date
amount
​string · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,…

BudgetAlertRequest

thresholdPercent
​integer · int32
basis
​BudgetAlertBasisValue · enum
Enum values:
actual
forecast

BudgetAlertBasisValue

string · enum
Enum values:
actual
forecast

DeleteBudgetRequest

GetBudgetRequest

PaginatedResponseOfBudgetResponse

​PaginationLinks · required
​BudgetResponse[] · required

ListBudgetsRequest

UpdateBudgetRequest

name
​string | null
amount
​string | null · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,…
​array | null
segmentId
​string | null
clearSegment
​boolean
​
clearCostReport
​boolean
appIds
​array | null
usageUnit
​string | null · minLength: 0 · maxLength: 64
​array | null

EntitlementResponse

planCode
​string · required
planName
​string · required
status
​string · required
currency
​string · pattern: ^[A-Z]{3}$ · required
features
​string[] · required
overriddenLimits
​string[] · required
ingestionHalted
​boolean · required
ingestionHaltedReason
​string · required
currentPeriodStart
​string · date · required
currentPeriodEnd
​string · date · required
​PlanLadderEntryResponse[] · required
spendCeiling
​string | null · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,…
historyDays
​integer | null · int32
maxConnections
​integer | null · int32
maxAllocationRules
​integer | null · int32
maxBackfillMonths
​integer | null · int32
maxRowsPerMonth
​integer | null · int64
maxBytesStored
​integer | null · int64
bandPlanCode
​string | null

PlanLadderEntryResponse

code
​string · required
name
​string · required
currency
​string · pattern: ^[A-Z]{3}$ · required
historyDays
​integer · int32 · required
features
​string[] · required
selfServeAvailable
​boolean · required
priceAmount
​string | null · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,…
spendCeiling
​string | null · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,…
maxConnections
​integer | null · int32
maxAllocationRules
​integer | null · int32

UsageResponse

periodStart
​string · date · required
currency
​string · pattern: ^[A-Z]{3}$ · required
trackedSpend
​string · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,… · required
isSpendComplete
​boolean · required
unconvertedCurrencies
​string[] · required
rowsIngested
​integer · int64 · required
bytesStored
​integer · int64 · required
connectionCount
​integer · int32 · required
activeUserCount
​integer · int32 · required
​UsageHistoryEntryResponse[] · required
computedAt
​string | null · date-time
averageTrackedSpend
​string | null · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,…
bandPlanCode
​string | null

UsageHistoryEntryResponse

periodStart
​string · date · required
trackedSpend
​string · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,… · required
rowsIngested
​integer · int64 · required
bytesStored
​integer · int64 · required

PaginatedResponseOfAuditLogEntryResponse

​PaginationLinks · required
​AuditLogEntryResponse[] · required

AuditLogEntryResponse

id
​AuditEventPublicId · pattern: ^aud_[A-Za-z0-9_-]{2… · required
eventName
​string · required
createdAt
​string · date-time · required
objectType
​string | null
​
actorName
​string | null
​
managedBy
​string | null
managedOrganization
​string | null
ipAddress
​string | null
userAgent
​string | null
metadata
​

AuditEventPublicId

string · pattern: ^aud_[A-Za-z0-9_-]{2…

ListAuditLogsRequest

PaginatedResponseOfAppResponse

​PaginationLinks · required
​AppResponse[] · required

AppResponse

id
​AppPublicId · pattern: ^app_[A-Za-z0-9_-]{2… · required
key
​AppKey · required
name
​string · required
​object · required
isEnabled
​boolean · required
createdAt
​string · date-time · required
signingSecret
​string | null

AppKey

string

ListAppsRequest

GetAppRequest

CreateAppRequest

key
​AppKey · required
name
​string · minLength: 0 · maxLength: 200 · required
​object · minLength: 1 · required

UpdateAppRequest

name
​string | null · minLength: 0 · maxLength: 200
​object | null

DeleteAppRequest

AcknowledgeAnomalyRequest

AnomalyPublicId

string · pattern: ^ano_[A-Za-z0-9_-]{2…

PaginatedResponseOfAnomalyResponse

​PaginationLinks · required
​AnomalyResponse[] · required

AnomalyResponse

id
​AnomalyPublicId · pattern: ^ano_[A-Za-z0-9_-]{2… · required
workspaceId
​WorkspacePublicId · pattern: ^wsp_[A-Za-z0-9_-]{2… · required
providerId
​ProviderPublicId · pattern: ^prv_[A-Za-z0-9_-]{2… · required
anomalyDate
​string · date · required
serviceName
​string · required
anomalyType
​string · required
severity
​string · required
expectedCost
​string · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,… · required
actualCost
​string · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,… · required
deviationPercent
​number · double · required
description
​string · required
currency
​string · pattern: ^[A-Z]{3}$ · required
status
​AnomalyStatus · required
isAcknowledged
​boolean · required
detectedAt
​string · date-time · required
​AnomalyContributorResponse[] · required
​AnomalySkuContributorResponse[] · required
region
​string | null
​
ignoreReason
​string | null
acknowledgedAt
​string | null · date-time
attributedResourceId
​string | null
attributedSku
​string | null

AnomalyStatus

string

AnomalyStatusReason

string

AnomalyContributorResponse

resourceId
​string · required
increase
​string · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,… · required
accountId
​string | null

AnomalySkuContributorResponse

sku
​string · required
increase
​string · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,… · required

ListAnomaliesRequest

AnnotationResponse

id
​AnnotationPublicId · pattern: ^ann_[A-Za-z0-9_-]{2… · required
date
​string · date · required
source
​AnnotationSource · required
costReportIds
​CostReportPublicId[] · required
createdAt
​string · date-time · required
text
​string | null
​
​
sourceName
​string | null
thresholdPercent
​integer | null · int32
​
​
resolvedAt
​string | null · date-time
​
updatedAt
​string | null · date-time

AnnotationPublicId

string · pattern: ^ann_[A-Za-z0-9_-]{2…

AnnotationSource

string

CreateAnnotationRequest

workspaceId
​WorkspacePublicId · minLength: 1 · pattern: ^wsp_[A-Za-z0-9_-]{2… · required
date
​string · date · required
text
​string · minLength: 1 · required
costReportIds
​CostReportPublicId[] · minLength: 1 · required

AnnotationIdRequest

PaginatedResponseOfAnnotationResponse

​PaginationLinks · required
​AnnotationResponse[] · required

ListAnnotationsRequest

UpdateAnnotationRequest

date
​string · date · required
text
​string · minLength: 1 · required
costReportIds
​CostReportPublicId[] · minLength: 1 · required

PaginatedResponseOfAllocationRuleResponse

​PaginationLinks · required
​AllocationRuleResponse[] · required

AllocationRuleResponse

id
​AllocationRulePublicId · pattern: ^alr_[A-Za-z0-9_-]{2… · required
name
​string · required
priority
​integer · int32 · required
filter
​string · required
costKind
​string · required
segmentId
​SegmentPublicId · pattern: ^seg_[A-Za-z0-9_-]{2… · required
isEnabled
​boolean · required
createdAt
​string · date-time · required
segmentName
​string | null
costCentre
​string | null
updatedAt
​string | null · date-time

AllocationRulePublicId

string · pattern: ^alr_[A-Za-z0-9_-]{2…

ListAllocationRulesRequest

CreateAllocationRuleRequest

workspaceId
​WorkspacePublicId · minLength: 1 · pattern: ^wsp_[A-Za-z0-9_-]{2… · required
name
​string · required
filter
​string · required
segmentId
​SegmentPublicId · minLength: 1 · pattern: ^seg_[A-Za-z0-9_-]{2… · required
priority
​integer · int32
isEnabled
​boolean

UpdateAllocationRuleRequest

name
​string · required
filter
​string · required
segmentId
​SegmentPublicId · minLength: 1 · pattern: ^seg_[A-Za-z0-9_-]{2… · required
priority
​integer | null · int32
isEnabled
​boolean | null

ReorderAllocationRulesRequest

workspaceId
​WorkspacePublicId · minLength: 1 · pattern: ^wsp_[A-Za-z0-9_-]{2… · required

DeleteAllocationRuleRequest

AllocationCoverageResponse

startDate
​string · date · required
endDate
​string · date · required
costBasis
​string · required
​AllocationCoverageCurrency[] · required

AllocationCoverageCurrency

billingCurrency
​string · pattern: ^[A-Z]{3}$ · required
totalCost
​string · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,… · required
directCost
​string · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,… · required
sharedCost
​string · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,… · required
undistributedSharedCost
​string · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,… · required
unallocatedCost
​string · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,… · required
unallocatedRecordCount
​integer · int64 · required
recordCount
​integer · int64 · required
​AllocationCoverageSegment[] · required
​AllocationCoveragePool[] · required
coverage
​number | null · double

AllocationCoverageSegment

segmentId
​string · required
name
​string · required
costCentre
​string · required
directCost
​string · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,… · required
sharedCost
​string · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,… · required
allocatedCost
​string · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,… · required
recordCount
​integer · int64 · required

AllocationCoveragePool

segmentId
​string · required
label
​string · required
method
​SegmentSplitMethod · required
cost
​string · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,… · required
distributedCost
​string · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,… · required
residual
​string · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,… · required
recordCount
​integer · int64 · required
​AllocationCoverageShare[] · required

SegmentSplitMethod

string

AllocationCoverageShare

segmentId
​string · required
share
​string · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,… · required

GetAllocationCoverageRequest

PaginatedResponseOfSegmentResponse

​PaginationLinks · required
​SegmentResponse[] · required

SegmentResponse

id
​SegmentPublicId · pattern: ^seg_[A-Za-z0-9_-]{2… · required
teamLabel
​string · required
product
​string · required
costCentre
​string · required
isShared
​boolean · required
label
​string · required
createdAt
​string · date-time · required
​
teamName
​string | null
​
updatedAt
​string | null · date-time

SegmentSplitResponse

method
​SegmentSplitMethod · required
​SegmentSplitTargetResponse[] · required

SegmentSplitTargetResponse

segmentId
​SegmentPublicId · pattern: ^seg_[A-Za-z0-9_-]{2… · required
percent
​number | null · double

ListSegmentsRequest

CreateSegmentRequest

workspaceId
​WorkspacePublicId · minLength: 1 · pattern: ^wsp_[A-Za-z0-9_-]{2… · required
​
teamLabel
​string | null
product
​string
costCentre
​string
isShared
​boolean
label
​string | null
​

SegmentSplitRequest

method
​SegmentSplitMethodValue · enum
Enum values:
proportional
even
percent

SegmentSplitMethodValue

string · enum
Enum values:
proportional
even
percent

SegmentSplitTargetRequest

segmentId
​SegmentPublicId · pattern: ^seg_[A-Za-z0-9_-]{2… · required
percent
​number | null · double

UpdateSegmentRequest

​
teamLabel
​string | null
product
​string | null
costCentre
​string | null
label
​string | null
​

DeleteSegmentRequest

AllocationDryRunResponse

billingCurrency
​string · pattern: ^[A-Z]{3}$ · required
movedCost
​string · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,… · required
movedRecordCount
​integer · int64 · required
coverageBefore
​number · double · required
coverageAfter
​number · double · required
​AllocationDryRunSegmentChangeResponse[] · required

AllocationDryRunSegmentChangeResponse

name
​string · required
costCentre
​string · required
allocatedBefore
​string · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,… · required
allocatedAfter
​string · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,… · required
delta
​string · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,… · required

PreviewAllocationRuleRequest

workspaceId
​WorkspacePublicId · minLength: 1 · pattern: ^wsp_[A-Za-z0-9_-]{2… · required
startDate
​string · date · required
endDate
​string · date · required
filter
​string · required
segmentId
​SegmentPublicId · minLength: 1 · pattern: ^seg_[A-Za-z0-9_-]{2… · required
priority
​integer · int32