API ReferenceProviders

Get provider service breakdown

GET
/api/v1/providers/{provider_id}/costs/breakdown

Authorization

BearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

provider_id*Provider Id

Query Parameters

format?Format

Response format: table (paginated UI), chart (aggregated stacked bar), csv (export), raw (all records)

start?|

Start date in ISO 8601 format (e.g., 2026-02-01T00:00:00.000Z). Defaults to first of current month

end?|

End date in ISO 8601 format (e.g., 2026-02-01T00:00:00.000Z). Defaults to today

granularity?Granularity

Granularity: 'daily' or 'monthly' (used for chart format)

page?Page

Page number (1-indexed, table format only)

page_size?Page Size

Items per page (max 100, table format only)

sort_by?Sort By

Field to sort by (service, environment, region, account_id, cost, previous_cost, change_percentage)

sort_order?Sort Order

Sort order

sort_by_date?|

Sort by a specific date's cost (YYYY-MM-DD for daily, YYYY-MM for monthly). Overrides sort_by.

preset?|

Date preset: '30D', '6M', or '12M' (takes precedence over start/end)

service?array<string>|

Filter by service(s) - can be repeated for multiple values

service_mode?Service Mode
environment?array<string>|

Filter by environment(s) - can be repeated for multiple values

account_id?array<string>|

Filter by account ID(s) - can be repeated for multiple values

account_id_mode?Account Id Mode
region?array<string>|

Filter by region(s) - can be repeated for multiple values

region_mode?Region Mode
tag_key?array<string>|

Filter by tag key(s) - required when group_by=tag

tag_key_mode?Tag Key Mode
tag_value?array<string>|

Filter by tag value(s) - can be repeated for multiple values

tag_value_mode?Tag Value Mode
group_by?array<string>|

Group by field(s). Valid: service, account_id, region, tag

show_cost_as?Show Cost As

Cost metric: unblended, blended, amortized, net_unblended, net_amortized

instance_type?array<string>|

Filter by instance type(s)

instance_type_mode?Instance Type Mode
usage_type?array<string>|

Filter by usage type(s)

usage_type_mode?Usage Type Mode
usage_type_group?array<string>|

Filter by usage type group(s)

usage_type_group_mode?Usage Type Group Mode
charge_type?array<string>|

Filter by charge type(s)

charge_type_mode?Charge Type Mode
availability_zone?array<string>|

Filter by availability zone(s)

availability_zone_mode?Availability Zone Mode
platform?array<string>|

Filter by platform(s)

platform_mode?Platform Mode
purchase_option?array<string>|

Filter by purchase option(s)

purchase_option_mode?Purchase Option Mode
tenancy?array<string>|

Filter by tenancy type(s)

tenancy_mode?Tenancy Mode
database_engine?array<string>|

Filter by database engine(s)

database_engine_mode?Database Engine Mode
legal_entity?array<string>|

Filter by legal entity

legal_entity_mode?Legal Entity Mode
billing_entity?array<string>|

Filter by billing entity

billing_entity_mode?Billing Entity Mode
api_operation?array<string>|

Filter by API operation(s)

api_operation_mode?Api Operation Mode
resource?array<string>|

Filter by resource ID(s)

resource_mode?Resource Mode
cost_category_key?array<string>|

Filter by cost category key(s)

cost_category_key_mode?Cost Category Key Mode
cost_category_value?array<string>|

Filter by cost category value(s)

cost_category_value_mode?Cost Category Value Mode
payer_account?array<string>|

Filter by payer account ID(s)

payer_account_mode?Payer Account Mode

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/providers/string/costs/breakdown"
{
  "success": true,
  "timestamp": "2019-08-24T14:15:22Z",
  "data": {
    "provider_id": "string",
    "provider_name": "string",
    "period": "string",
    "start_date": "string",
    "end_date": "string",
    "total_period_cost": 0,
    "items": [
      {
        "service": "string",
        "environment": "string",
        "region": "string",
        "account_id": "string",
        "tag_key": "string",
        "tag_value": "string",
        "cost": 0,
        "previous_cost": 0,
        "change_percentage": 0,
        "spendings_by_date": [
          {
            "date": "string",
            "value": 0,
            "change_percentage": 0
          }
        ]
      }
    ],
    "pagination": {
      "total_items": 0,
      "total_pages": 0,
      "current_page": 0,
      "page_size": 0,
      "has_next": true,
      "has_previous": true
    },
    "totals_by_date": [
      {
        "date": "string",
        "value": 0,
        "change_percentage": 0
      }
    ]
  }
}
{
  "success": false,
  "error": {
    "code": "string",
    "message": "string",
    "details": null
  },
  "timestamp": "2019-08-24T14:15:22Z"
}
{
  "success": false,
  "error": {
    "code": "string",
    "message": "string",
    "details": null
  },
  "timestamp": "2019-08-24T14:15:22Z"
}
{
  "success": false,
  "error": {
    "code": "string",
    "message": "string",
    "details": null
  },
  "timestamp": "2019-08-24T14:15:22Z"
}
{
  "success": false,
  "error": {
    "code": "string",
    "message": "string",
    "details": null
  },
  "timestamp": "2019-08-24T14:15:22Z"
}
{
  "success": false,
  "error": {
    "code": "string",
    "message": "string",
    "details": null
  },
  "timestamp": "2019-08-24T14:15:22Z"
}
{
  "property1": null,
  "property2": null
}
{
  "success": false,
  "error": {
    "code": "string",
    "message": "string",
    "details": null
  },
  "timestamp": "2019-08-24T14:15:22Z"
}
{
  "success": false,
  "error": {
    "code": "string",
    "message": "string",
    "details": null
  },
  "timestamp": "2019-08-24T14:15:22Z"
}