Skip to content
Proud to collaborate with Microsoft for Startups

gcp.billing.cost.summarize ​

Summarize GCP cost from the BigQuery billing export, grouped by dimensions.

Overview ​

PropertyValue
Workflow typeLinear
LibraryBase-gcp
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
connection_uuiduuidYes—GCP CloudConnection UUID.
project_idstringNo—Query project; defaults to the connection's project.
export_tablestringYes—Billing export table ref, e.g. dataset.gcp_billing_export_v1_XXXXXX or project.dataset.table.
start_datestringNo—Inclusive lower bound on usage_start_time (RFC3339/timestamp).
end_datestringNo—Exclusive upper bound on usage_start_time (RFC3339/timestamp).
group_byjsonNo—List of billing-export column expressions to group by; defaults to [service.description].
locationstringNo—BigQuery location, e.g. US or EU.
limitintegerNo—Max grouped rows; defaults to 100.
poll_interval_secondsintegerNo—Poll interval when the job is not immediately complete.
timeout_secondsintegerNo—Overall wait budget for job completion.

Output Schema ​

FieldTypeRequiredDefaultDescription
connection_uuiduuidNo—Echoed connection UUID.
project_idstringNo—Effective project id.
export_tablestringNo—Billing export table ref, e.g. dataset.gcp_billing_export_v1_XXXXXX or project.dataset.table.
start_datestringNo—Inclusive lower bound on usage_start_time (RFC3339/timestamp).
end_datestringNo—Exclusive upper bound on usage_start_time (RFC3339/timestamp).
group_byjsonNo—List of billing-export column expressions to group by; defaults to [service.description].
locationstringNo—BigQuery location, e.g. US or EU.
limitintegerNo—Max grouped rows; defaults to 100.
poll_interval_secondsintegerNo—Poll interval when the job is not immediately complete.
timeout_secondsintegerNo—Overall wait budget for job completion.
rowsjsonNo—Grouped cost rows with cost, credits, net_cost.
row_countintegerNo—Number of grouped rows.
summaryjsonNo—Totals: total_cost, total_credits, net_cost, row_count.
querystringNo—The generated SQL executed.
job_idstringNo—BigQuery job id.
total_bytes_processedstringNo—Bytes scanned by the query.
failure_reasonstringNo—Human-readable failure reason.
failed_stepstringNo—Failed logical step.
failed_layerjsonNo—Engine failed layer.
failed_at_statestringNo—State where failure occurred.
errorstringNo—Error message.
error_typestringNo—Error class.

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—preflight—
preflightingNoNo—execute—
summarizingNoNo—complete—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
pendingpreflightpreflighting—
preflightingexecutesummarizing—
summarizingcompletecompleted—
* (any state)failfailed—

API Usage ​

bash
POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "gcp.billing.cost.summarize",
  "initial_data": {
    "connection_uuid": "value",
    "export_table": "value"
  }
}