Returns a summary of all costs known to wayfinder for the specified time period

Returns a summary of all costs known to wayfinder for the specified time period

Path Parameters

workspace stringrequired

Workspace to use

from stringrequired

Start of time range to return summary for

to stringrequired

End of time range to return summary for

Query Parameters

provider string

Restrict to costs for specified cloud provider (e.g. gcp, aws, azure)

invoice string

Invoice to return costs for, in the formay YYYYMM

asset string

Specific asset identifier to return costs for - default is all assets

Responses

200

A summary of costs known to the system for the workspace

application/json

Schema

Schema

assetCosts undefined[]
assetIdentifier string
assetName string
assetType string
cost int64
details undefined[]
account string
assetIdentifier string
cost int64
costIdentifier string
description string
invoice string
provider string
retrievedAt string
usageAmount string
usageEndTime string
usageStartTime string
usageType string
usageUnit string
workspaceIdentifier string
provider string
usageEndTime string
usageStartTime string
workspaceIdentifier string
cost int64
usageEndTime string
usageStartTime string
workspace string
workspaceIdentifier string

Example (from schema)

{
  "assetCosts": [
    {
      "assetIdentifier": "string",
      "assetName": "string",
      "assetType": "string",
      "cost": 0,
      "details": [
        {
          "account": "string",
          "assetIdentifier": "string",
          "cost": 0,
          "costIdentifier": "string",
          "description": "string",
          "invoice": "string",
          "provider": "string",
          "retrievedAt": "string",
          "usageAmount": "string",
          "usageEndTime": "string",
          "usageStartTime": "string",
          "usageType": "string",
          "usageUnit": "string",
          "workspaceIdentifier": "string"
        }
      ],
      "provider": "string",
      "usageEndTime": "string",
      "usageStartTime": "string",
      "workspaceIdentifier": "string"
    }
  ],
  "cost": 0,
  "usageEndTime": "string",
  "usageStartTime": "string",
  "workspace": "string",
  "workspaceIdentifier": "string"
}

401

If not authenticated

403

If authenticated but not authorized

500

A generic API error containing the cause of the error

application/json

Schema

Schema

code int32
detail string
message string
uri string
verb string

Example (from schema)

{
  "code": 0,
  "detail": "string",
  "message": "string",
  "uri": "string",
  "verb": "string"
}

Loading...