project_service_usage

Creates, updates, deletes, gets or lists a project_service_usage resource.

Overview

Name	project_service_usage
Type	Resource
Id	railway.billing.project_service_usage

Fields

The following fields are returned by SELECT queries:

list

One row per AggregatedUsage. The aggregated usage of a single measurement.

Name	Datatype	Description
measurement	string	The measurement that was aggregated. (AGENT_CACHE_READ_TOKENS, AGENT_CACHE_WRITE_TOKENS, AGENT_INPUT_TOKENS, AGENT_OUTPUT_TOKENS, AGENT_SPEND_USD, BACKUP_USAGE_GB, CPU_LIMIT, CPU_USAGE, CPU_USAGE_2, DISK_USAGE_GB, EPHEMERAL_DISK_USAGE_GB, MEASUREMENT_UNSPECIFIED, MEMORY_LIMIT_GB, MEMORY_USAGE_GB, NETWORK_RX_GB, NETWORK_TX_GB, UNRECOGNIZED)
tags	object	The tags that were used to group the metric. Only the tags that were used in the groupBy will be present.
value	number	The aggregated value.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	end_date, measurements, start_date, workspace_id	include_deleted	Get paginated usage grouped by project and service for a workspace. Backed by the Railway GraphQL query projectServiceUsage.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
end_date	string (date-time)
measurements	string	GraphQL list literal of MetricMeasurement values, for example [AGENT_CACHE_READ_TOKENS, AGENT_CACHE_WRITE_TOKENS].
start_date	string (date-time)
workspace_id	string
include_deleted	boolean	Whether to include deleted projects in usage.

SELECT examples

list

Get paginated usage grouped by project and service for a workspace. Backed by the Railway GraphQL query projectServiceUsage.

SELECT
measurement,
tags,
value
FROM railway.billing.project_service_usage
WHERE end_date = '{{ end_date }}' -- required
AND measurements = '{{ measurements }}' -- required
AND start_date = '{{ start_date }}' -- required
AND workspace_id = '{{ workspace_id }}' -- required
AND include_deleted = '{{ include_deleted }}'
;