Skip to content

Marketplace Project Usage

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/marketplace-project-usage/{uuid}/components-usage/ Get resource usage statistics broken down per offering
Other Actions
GET /api/marketplace-project-usage/{uuid}/components-usage-timeseries/ Get monthly usage buckets for a single offering

Core CRUD

Get resource usage statistics broken down per offering

Returns one row per (offering, component type, billing type) for all non-terminated resources within the scope. Each row's usage and limit_usage are aggregated using the offering's own limit_period.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-project-usage/a1b2c3d4-e5f6-7890-abcd-ef1234567890/components-usage/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_project_usage import marketplace_project_usage_components_usage_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_project_usage_components_usage_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_project_usage_components_usage_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProjectUsageComponentsUsageRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceProjectUsageComponentsUsageRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
components array of objects
components.type string
components.name string
components.description string
components.measured_unit string
components.billing_type string
components.usage number (double)
components.limit_usage number (double)
components.limit number (double)
components.offering_name string
components.offering_uuid string (uuid)
components.limit_period string
components.current_period_label string
components.current_period_start string (date)
components.current_period_end string (date)

Other Actions

Get monthly usage buckets for a single offering

Returns a per-month timeseries of ComponentUsage for one offering, restricted to that offering's current limit_period. Buckets are keyed by billing_period (always month-start). period_offset shifts the window backward by N periods.

1
2
3
4
5
http \
  GET \
  https://api.example.com/api/marketplace-project-usage/a1b2c3d4-e5f6-7890-abcd-ef1234567890/components-usage-timeseries/ \
  Authorization:"Token YOUR_API_TOKEN" \
  offering_uuid=="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_project_usage import marketplace_project_usage_components_usage_timeseries_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_project_usage_components_usage_timeseries_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    offering_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)

print(response)
  1. API Source: marketplace_project_usage_components_usage_timeseries_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { marketplaceProjectUsageComponentsUsageTimeseriesRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceProjectUsageComponentsUsageTimeseriesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  query: {
    "offering_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Required
component_type string
offering_uuid string (uuid) ✓
period_offset integer

200 -

Field Type
offering_uuid string (uuid)
offering_name string
type string
name string
measured_unit string
billing_type string
limit_period string
limit number (double)
current_period_label string
current_period_start string (date)
current_period_end string (date)
today string (date)
buckets array of objects
buckets.billing_period string (date)
buckets.usage number (double)