Segments

Server

Download schema

List segments

GET

https://api.costfluent.com

/v1/segments

Bearer (API token)

Returns every segment cost can be assigned to in a workspace

List segments › query Parameters

CostfluentSharedKernelPublicIdsWorkspacePublicId · required

List segments › Responses

Success

CostfluentPublicApiModelsV1ResponsesSegmentResponse[]

CostfluentPublicApiModelsV1ResponsesSegmentResponse

id

string · required

teamLabel

string · required

product

string · required

costCentre

string · required

isShared

boolean · required

createdAt

string · date-time · required

teamId

string | null

teamName

string | null

updatedAt

string | null · date-time

Create a segment

POST

https://api.costfluent.com

/v1/segments

Bearer (API token)

Create a segment › Request Body

CostfluentPublicApiEndpointsV1AllocationCreateSegmentRequest

CostfluentSharedKernelPublicIdsWorkspacePublicId · required

teamLabel

string | null

product

string

costCentre

string

isShared

boolean

Create a segment › Responses

Success

CostfluentPublicApiModelsV1ResponsesSegmentResponse

id

string · required

teamLabel

string · required

product

string · required

costCentre

string · required

isShared

boolean · required

createdAt

string · date-time · required

teamId

string | null

teamName

string | null

updatedAt

string | null · date-time

POST/v1/segments

curl https://api.costfluent.com/v1/segments \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "workspaceId": {
    "Value": "Value"
  },
  "teamId": {
    "Value": "Value"
  },
  "teamLabel": "teamLabel",
  "product": "product",
  "costCentre": "costCentre",
  "isShared": true
}'

Example Request Body

{
  "workspaceId": {
    "Value": "Value"
  },
  "teamId": {
    "Value": "Value"
  },
  "teamLabel": "teamLabel",
  "product": "product",
  "costCentre": "costCentre",
  "isShared": true
}

json

Example Responses

{
  "id": "id",
  "teamId": "teamId",
  "teamLabel": "teamLabel",
  "teamName": "teamName",
  "product": "product",
  "costCentre": "costCentre",
  "isShared": true,
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedAt": "2024-08-25T15:00:00Z"
}

json

application/json

Update a segment

PUT

https://api.costfluent.com

/v1/segments/{segmentId}

Bearer (API token)

teamLabel

string | null

product

string

costCentre

string

Update a segment › Responses

Success

CostfluentPublicApiModelsV1ResponsesSegmentResponse

id

string · required

teamLabel

string · required

product

string · required

costCentre

string · required

isShared

boolean · required

createdAt

string · date-time · required

teamId

string | null

teamName

string | null

updatedAt

string | null · date-time

PUT/v1/segments/{segmentId}

curl 'https://api.costfluent.com/v1/segments/:segmentId?workspaceId=[object Object]' \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "teamId": {
    "Value": "Value"
  },
  "teamLabel": "teamLabel",
  "product": "product",
  "costCentre": "costCentre"
}'

Example Request Body

{
  "teamId": {
    "Value": "Value"
  },
  "teamLabel": "teamLabel",
  "product": "product",
  "costCentre": "costCentre"
}

json

Example Responses

{
  "id": "id",
  "teamId": "teamId",
  "teamLabel": "teamLabel",
  "teamName": "teamName",
  "product": "product",
  "costCentre": "costCentre",
  "isShared": true,
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedAt": "2024-08-25T15:00:00Z"
}

json

application/json

Delete a segment

DELETE

https://api.costfluent.com

/v1/segments/{segmentId}

Bearer (API token)

Refused while any rule still assigns cost to it

Delete a segment › path Parameters

CostfluentSharedKernelPublicIdsSegmentPublicId · required

Delete a segment › query Parameters

CostfluentSharedKernelPublicIdsWorkspacePublicId · required

Delete a segment › Responses

No Content

No data returned

Allocation

Costfluent Public API

Segments

Server

Download schema

List segments

GET

https://api.costfluent.com

/v1/segments

Bearer (API token)

Returns every segment cost can be assigned to in a workspace

List segments › query Parameters

CostfluentSharedKernelPublicIdsWorkspacePublicId · required

List segments › Responses

Success

CostfluentPublicApiModelsV1ResponsesSegmentResponse[]

CostfluentPublicApiModelsV1ResponsesSegmentResponse

id

string · required

teamLabel

string · required

product

string · required

costCentre

string · required

isShared

boolean · required

createdAt

string · date-time · required

teamId

string | null

teamName

string | null

updatedAt

string | null · date-time

Create a segment

POST

https://api.costfluent.com

/v1/segments

Bearer (API token)

Create a segment › Request Body

CostfluentPublicApiEndpointsV1AllocationCreateSegmentRequest

CostfluentSharedKernelPublicIdsWorkspacePublicId · required

teamLabel

string | null

product

string

costCentre

string

isShared

boolean

Create a segment › Responses

Success

CostfluentPublicApiModelsV1ResponsesSegmentResponse

id

string · required

teamLabel

string · required

product

string · required

costCentre

string · required

isShared

boolean · required

createdAt

string · date-time · required

teamId

string | null

teamName

string | null

updatedAt

string | null · date-time

POST/v1/segments

curl https://api.costfluent.com/v1/segments \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "workspaceId": {
    "Value": "Value"
  },
  "teamId": {
    "Value": "Value"
  },
  "teamLabel": "teamLabel",
  "product": "product",
  "costCentre": "costCentre",
  "isShared": true
}'

Example Request Body

{
  "workspaceId": {
    "Value": "Value"
  },
  "teamId": {
    "Value": "Value"
  },
  "teamLabel": "teamLabel",
  "product": "product",
  "costCentre": "costCentre",
  "isShared": true
}

json

Example Responses

{
  "id": "id",
  "teamId": "teamId",
  "teamLabel": "teamLabel",
  "teamName": "teamName",
  "product": "product",
  "costCentre": "costCentre",
  "isShared": true,
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedAt": "2024-08-25T15:00:00Z"
}

json

application/json

Update a segment

PUT

https://api.costfluent.com

/v1/segments/{segmentId}

Bearer (API token)

Update a segment › path Parameters

CostfluentSharedKernelPublicIdsSegmentPublicId · required

Update a segment › query Parameters

CostfluentSharedKernelPublicIdsWorkspacePublicId · required

Update a segment › Request Body

CostfluentPublicApiEndpointsV1AllocationUpdateSegmentRequest

teamLabel

string | null

product

string

costCentre

string

Update a segment › Responses

Success

CostfluentPublicApiModelsV1ResponsesSegmentResponse

id

string · required

teamLabel

string · required

product

string · required

costCentre

string · required

isShared

boolean · required

createdAt

string · date-time · required

teamId

string | null

teamName

string | null

updatedAt

string | null · date-time

PUT/v1/segments/{segmentId}

curl 'https://api.costfluent.com/v1/segments/:segmentId?workspaceId=[object Object]' \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "teamId": {
    "Value": "Value"
  },
  "teamLabel": "teamLabel",
  "product": "product",
  "costCentre": "costCentre"
}'

Example Request Body

{
  "teamId": {
    "Value": "Value"
  },
  "teamLabel": "teamLabel",
  "product": "product",
  "costCentre": "costCentre"
}

json

Example Responses

{
  "id": "id",
  "teamId": "teamId",
  "teamLabel": "teamLabel",
  "teamName": "teamName",
  "product": "product",
  "costCentre": "costCentre",
  "isShared": true,
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedAt": "2024-08-25T15:00:00Z"
}

json

application/json

Delete a segment

DELETE

https://api.costfluent.com

/v1/segments/{segmentId}

Bearer (API token)

Refused while any rule still assigns cost to it

Delete a segment › path Parameters

CostfluentSharedKernelPublicIdsSegmentPublicId · required

Delete a segment › query Parameters

CostfluentSharedKernelPublicIdsWorkspacePublicId · required

Delete a segment › Responses

No Content

No data returned

Allocation