API ReferenceProviders

Get provider service breakdown

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

Authorization

BearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

provider_id*string

Query Parameters

format?string

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

Default"table"
Match^(table|chart|csv|raw)$
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?string

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

Default"daily"
Match^(daily|monthly)$
page?integer

Page number (1-indexed, table format only)

Default1
Range1 <= value
page_size?integer

Items per page (max 100, table format only)

Default10
Range1 <= value <= 100
sort_by?string

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

Default"cost"
sort_order?string

Sort order

Default"desc"
Value in"asc" | "desc"
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<>|

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

service_mode?string
Default"include"
Value in"include" | "exclude"
environment?array<>|

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

account_id?array<>|

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

account_id_mode?string
Default"include"
Value in"include" | "exclude"
region?array<>|

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

region_mode?string
Default"include"
Value in"include" | "exclude"
tag_key?array<>|

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

tag_key_mode?string
Default"include"
Value in"include" | "exclude"
tag_value?array<>|

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

tag_value_mode?string
Default"include"
Value in"include" | "exclude"
group_by?array<>|

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

show_cost_as?string

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

Default"unblended"
Match^(unblended|blended|amortized|net_unblended|net_amortized)$
instance_type?array<>|

Filter by instance type(s)

instance_type_mode?string
Default"include"
Value in"include" | "exclude"
usage_type?array<>|

Filter by usage type(s)

usage_type_mode?string
Default"include"
Value in"include" | "exclude"
usage_type_group?array<>|

Filter by usage type group(s)

usage_type_group_mode?string
Default"include"
Value in"include" | "exclude"
charge_type?array<>|

Filter by charge type(s)

charge_type_mode?string
Default"include"
Value in"include" | "exclude"
availability_zone?array<>|

Filter by availability zone(s)

availability_zone_mode?string
Default"include"
Value in"include" | "exclude"
platform?array<>|

Filter by platform(s)

platform_mode?string
Default"include"
Value in"include" | "exclude"
purchase_option?array<>|

Filter by purchase option(s)

purchase_option_mode?string
Default"include"
Value in"include" | "exclude"
tenancy?array<>|

Filter by tenancy type(s)

tenancy_mode?string
Default"include"
Value in"include" | "exclude"
database_engine?array<>|

Filter by database engine(s)

database_engine_mode?string
Default"include"
Value in"include" | "exclude"
legal_entity?array<>|

Filter by legal entity

legal_entity_mode?string
Default"include"
Value in"include" | "exclude"
billing_entity?array<>|

Filter by billing entity

billing_entity_mode?string
Default"include"
Value in"include" | "exclude"
api_operation?array<>|

Filter by API operation(s)

api_operation_mode?string
Default"include"
Value in"include" | "exclude"
resource?array<>|

Filter by resource ID(s)

resource_mode?string
Default"include"
Value in"include" | "exclude"
cost_category_key?array<>|

Filter by cost category key(s)

cost_category_key_mode?string
Default"include"
Value in"include" | "exclude"
cost_category_value?array<>|

Filter by cost category value(s)

cost_category_value_mode?string
Default"include"
Value in"include" | "exclude"
payer_account?array<>|

Filter by payer account ID(s)

payer_account_mode?string
Default"include"
Value in"include" | "exclude"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://loading/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"
}

Create a new API key POST

Previous Page

Get provider cost filter options GET

Returns available values for every filter dimension. Dimensions cross-constrain each other (AWS Cost Explorer behavior); each dimension excludes its own selections when computing its option list.