Dashboards

Server

Download schema

List dashboards

GET

https://api.costfluent.com

/v1/dashboards

Bearer (API token)

Returns all dashboards for a workspace

List dashboards › query Parameters

CostfluentSharedKernelPublicIdsWorkspacePublicId · required

page

integer · int32 · required

limit

integer · int32 · required

List dashboards › Responses

Success

CostfluentPublicApiModelsV1CommonPaginatedResponseOfDashboardResponse

CostfluentPublicApiModelsV1CommonPaginationLinks · required

CostfluentPublicApiModelsV1ResponsesDashboardResponse[] · required

GET/v1/dashboards

curl 'https://api.costfluent.com/v1/dashboards?workspaceId=[object Object]&page=<number>&limit=<number>' \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "links": {
    "self": "self",
    "first": "first",
    "prev": "prev",
    "next": "next",
    "last": "last"
  },
  "data": [
    {
      "id": {
        "Value": "Value"
      },
      "title": "title",
      "isDefault": true,
      "dateInterval": "dateInterval",
      "dateBin": "dateBin",
      "widgets": [
        {
          "id": {
            "Value": "Value"
          },
          "type": "type",
          "title": "title",
          "position": {
            "x": 0,
            "y": 0,
            "w": 0,
            "h": 0
          },
          "config": {
            "key": {}
          }
        }
      ],
      "createdAt": "2024-08-25T15:00:00Z"
    }
  ]
}

json

application/json

Create dashboard

POST

https://api.costfluent.com

/v1/dashboards

Bearer (API token)

Creates a new dashboard

Create dashboard › Request Body

CostfluentPublicApiModelsV1RequestsCreateDashboardRequest

CostfluentSharedKernelPublicIdsWorkspacePublicId · minLength: 1 · required

title

string · minLength: 0 · maxLength: 200 · required

isDefault

boolean

dateInterval

CostfluentDomainEnumsDateInterval · enum

Enum values:

thisMonth

lastMonth

last7Days

last30Days

last90Days

yearToDate

custom

thisQuarter

dateBin

CostfluentDomainEnumsDateBin · enum

Enum values:

day

week

month

quarter

Create dashboard › Responses

Success

CostfluentPublicApiModelsV1ResponsesDashboardCreatedResponse

CostfluentSharedKernelPublicIdsDashboardPublicId · required

title

string · required

Get dashboard

GET

https://api.costfluent.com

/v1/dashboards/{dashboardId}

Bearer (API token)

Returns a specific dashboard with widgets

Get dashboard › path Parameters

CostfluentSharedKernelPublicIdsDashboardPublicId · required

Get dashboard › query Parameters

CostfluentSharedKernelPublicIdsWorkspacePublicId · required

Get dashboard › Responses

Success

CostfluentPublicApiModelsV1ResponsesDashboardResponse

CostfluentSharedKernelPublicIdsDashboardPublicId · required

title

string · required

dateInterval

string · required

dateBin

string · required

CostfluentPublicApiModelsV1ResponsesWidgetResponse[] · required

isDefault

boolean

createdAt

string · date-time

Update dashboard

PUT

https://api.costfluent.com

/v1/dashboards/{dashboardId}

Bearer (API token)

Updates a dashboard

title

string | null

dateInterval

string | null

dateBin

string | null

Update dashboard › Responses

Success

CostfluentPublicApiModelsV1ResponsesDashboardResponse

CostfluentSharedKernelPublicIdsDashboardPublicId · required

title

string · required

dateInterval

string · required

dateBin

string · required

CostfluentPublicApiModelsV1ResponsesWidgetResponse[] · required

isDefault

boolean

createdAt

string · date-time

PUT/v1/dashboards/{dashboardId}

curl 'https://api.costfluent.com/v1/dashboards/:dashboardId?workspaceId=[object Object]' \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "title": "title",
  "dateInterval": "dateInterval",
  "dateBin": "dateBin"
}'

Example Request Body

{
  "title": "title",
  "dateInterval": "dateInterval",
  "dateBin": "dateBin"
}

json

Example Responses

{
  "id": {
    "Value": "Value"
  },
  "title": "title",
  "isDefault": true,
  "dateInterval": "dateInterval",
  "dateBin": "dateBin",
  "widgets": [
    {
      "id": {
        "Value": "Value"
      },
      "type": "type",
      "title": "title",
      "position": {
        "x": 0,
        "y": 0,
        "w": 0,
        "h": 0
      },
      "config": {
        "key": {}
      }
    }
  ],
  "createdAt": "2024-08-25T15:00:00Z"
}

json

application/json

Delete dashboard

DELETE

https://api.costfluent.com

/v1/dashboards/{dashboardId}

Bearer (API token)

Deletes a dashboard and all its widgets

Delete dashboard › path Parameters

CostfluentSharedKernelPublicIdsDashboardPublicId · required

Delete dashboard › query Parameters

CostfluentSharedKernelPublicIdsWorkspacePublicId · required

Delete dashboard › Responses

No Content

No data returned

Exchange-Rates Custom Provider

Costfluent Public API

Dashboards

Server

Download schema

List dashboards

GET

https://api.costfluent.com

/v1/dashboards

Bearer (API token)

Returns all dashboards for a workspace

List dashboards › query Parameters

CostfluentSharedKernelPublicIdsWorkspacePublicId · required

page

integer · int32 · required

limit

integer · int32 · required

List dashboards › Responses

Success

CostfluentPublicApiModelsV1CommonPaginatedResponseOfDashboardResponse

CostfluentPublicApiModelsV1CommonPaginationLinks · required

CostfluentPublicApiModelsV1ResponsesDashboardResponse[] · required

GET/v1/dashboards

curl 'https://api.costfluent.com/v1/dashboards?workspaceId=[object Object]&page=<number>&limit=<number>' \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "links": {
    "self": "self",
    "first": "first",
    "prev": "prev",
    "next": "next",
    "last": "last"
  },
  "data": [
    {
      "id": {
        "Value": "Value"
      },
      "title": "title",
      "isDefault": true,
      "dateInterval": "dateInterval",
      "dateBin": "dateBin",
      "widgets": [
        {
          "id": {
            "Value": "Value"
          },
          "type": "type",
          "title": "title",
          "position": {
            "x": 0,
            "y": 0,
            "w": 0,
            "h": 0
          },
          "config": {
            "key": {}
          }
        }
      ],
      "createdAt": "2024-08-25T15:00:00Z"
    }
  ]
}

json

application/json

Create dashboard

POST

https://api.costfluent.com

/v1/dashboards

Bearer (API token)

Creates a new dashboard

Create dashboard › Request Body

CostfluentPublicApiModelsV1RequestsCreateDashboardRequest

CostfluentSharedKernelPublicIdsWorkspacePublicId · minLength: 1 · required

title

string · minLength: 0 · maxLength: 200 · required

isDefault

boolean

dateInterval

CostfluentDomainEnumsDateInterval · enum

Enum values:

thisMonth

lastMonth

last7Days

last30Days

last90Days

yearToDate

custom

thisQuarter

dateBin

CostfluentDomainEnumsDateBin · enum

Enum values:

day

week

month

quarter

Create dashboard › Responses

Success

CostfluentPublicApiModelsV1ResponsesDashboardCreatedResponse

CostfluentSharedKernelPublicIdsDashboardPublicId · required

title

string · required

Get dashboard

GET

https://api.costfluent.com

/v1/dashboards/{dashboardId}

Bearer (API token)

Returns a specific dashboard with widgets

Get dashboard › path Parameters

CostfluentSharedKernelPublicIdsDashboardPublicId · required

Get dashboard › query Parameters

CostfluentSharedKernelPublicIdsWorkspacePublicId · required

Get dashboard › Responses

Success

CostfluentPublicApiModelsV1ResponsesDashboardResponse

CostfluentSharedKernelPublicIdsDashboardPublicId · required

title

string · required

dateInterval

string · required

dateBin

string · required

CostfluentPublicApiModelsV1ResponsesWidgetResponse[] · required

isDefault

boolean

createdAt

string · date-time

Update dashboard

PUT

https://api.costfluent.com

/v1/dashboards/{dashboardId}

Bearer (API token)

Updates a dashboard

Update dashboard › path Parameters

CostfluentSharedKernelPublicIdsDashboardPublicId · required

Update dashboard › query Parameters

CostfluentSharedKernelPublicIdsWorkspacePublicId · required

Update dashboard › Request Body

CostfluentPublicApiEndpointsV1DashboardsUpdateDashboardRequest

title

string | null

dateInterval

string | null

dateBin

string | null

Update dashboard › Responses

Success

CostfluentPublicApiModelsV1ResponsesDashboardResponse

CostfluentSharedKernelPublicIdsDashboardPublicId · required

title

string · required

dateInterval

string · required

dateBin

string · required

CostfluentPublicApiModelsV1ResponsesWidgetResponse[] · required

isDefault

boolean

createdAt

string · date-time

PUT/v1/dashboards/{dashboardId}

curl 'https://api.costfluent.com/v1/dashboards/:dashboardId?workspaceId=[object Object]' \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "title": "title",
  "dateInterval": "dateInterval",
  "dateBin": "dateBin"
}'

Example Request Body

{
  "title": "title",
  "dateInterval": "dateInterval",
  "dateBin": "dateBin"
}

json

Example Responses

{
  "id": {
    "Value": "Value"
  },
  "title": "title",
  "isDefault": true,
  "dateInterval": "dateInterval",
  "dateBin": "dateBin",
  "widgets": [
    {
      "id": {
        "Value": "Value"
      },
      "type": "type",
      "title": "title",
      "position": {
        "x": 0,
        "y": 0,
        "w": 0,
        "h": 0
      },
      "config": {
        "key": {}
      }
    }
  ],
  "createdAt": "2024-08-25T15:00:00Z"
}

json

application/json

Delete dashboard

DELETE

https://api.costfluent.com

/v1/dashboards/{dashboardId}

Bearer (API token)

Deletes a dashboard and all its widgets

Delete dashboard › path Parameters

CostfluentSharedKernelPublicIdsDashboardPublicId · required

Delete dashboard › query Parameters

CostfluentSharedKernelPublicIdsWorkspacePublicId · required

Delete dashboard › Responses

No Content

No data returned

Exchange-Rates Custom Provider