List automatic allocation rules with filtering

1 min

GET

https://app.amberflo.io/business-unit/focus-allocation/automatic/rule

List the automatic FOCUS allocation rules

Query Parameters

limitinteger<int32>
pageinteger<int32>
tagNamestring
tagValuesstring[]
businessUnitIdsstring[]
Description
Filter for these business units.
providersstring[]
Description
Filter for these providers.
enabledboolean
Description
If true only enabled rules are returned, if false only disabled rules are returned, if null all rules are returned.

Responses

200Successful request

business_unit.focus_allocation.automatic.query.AutomaticMatchingRulePage.out
- metadatabusiness_unit.focus_allocation.automatic.query.AutomaticMatchingRulePageMetadata.out
  - limitinteger<int32>
  - pageinteger<int32>
  - tagNamestring
  - tagValuesstring[]
  - businessUnitIdsstring[]
    Description
    Filter for these business units.
  - providersfocus.common.FocusProvider.out[]
    Description
    Filter for these providers.
  - enabledboolean
    Description
    If true only enabled rules are returned, if false only disabled rules are returned, if null all rules are returned.
  - totalRowCountinteger<int32>
  - filteredRowCountinteger<int32>
  - totalFilteredPagesinteger<int32>
- itemsbusiness_unit.focus_allocation.automatic.AutomaticMatchingRule.out[]
  Description
  Complete automatic FOCUS allocation rule configuration with system-generated metadata for cost assignment to business units based on resource tag matching.
  - idstring<uuid>
    Example
    0e63b938-6785-429b-a89d-c4164144fc88
    Description
    System-generated unique identifier for rule tracking. Required for rule updates, deletions, and position management in execution sequence.
  - providerfocus.common.FocusProvider.outrequired
    Description
    Cloud provider for cost allocation filtering. Supported values include AWS, AZURE, GOOGLE_CLOUD for targeted rule application.
  - predicatebusiness_unit.focus_allocation.automatic.predicate.GroupKeyPredicate.outrequired
    Description
    Matching conditions that determine when rule applies to cost records. Defines value matrix logic for resource identification.
    - business_unit.focus_allocation.automatic.predicate.ValueMatrixPredicate.out
      - typestringrequired
        Description
        Predicate type identifier for value matrix matching logic. Always set to 'value_matrix' for matrix-based resource filtering conditions.
        Default
        value_matrix
      - columnsstring[]required
        Description
        FOCUS column names for matrix dimension headers. Defines resource attributes used for matching conditions in allocation rules.
      - rowsbusiness_unit.focus_allocation.automatic.predicate.ValueMatrixPredicate.ValueMatrixRow.out[]required
        Description
        Matrix row definitions containing value combinations for resource matching. Each row represents specific resource attribute criteria for rule application.
        valuesstring[]required
        Description
        Array of string values corresponding to matrix columns for resource matching. Each element matches position in predicate column array.
  - tagNamestring
    Description
    FOCUS tag key for cost allocation target. Specifies resource tag name used for business unit assignment mapping.
  - tagValuestring
    Description
    Specific FOCUS tag value to match for cost allocation. Must be used with tagName for targeted resource matching.
  - businessUnitIdstring
    Description
    Target business unit identifier for cost assignment. Alternative to tagName/tagValue approach for direct business unit allocation.
  - labelstring
    Description
    Human-readable display name for rule management and identification. Used for administrative organization and rule tracking purposes.
  - descriptionstring
    Description
    Detailed explanation of rule purpose and allocation logic. Provides context for rule configuration and business unit cost assignment.
  - enabledboolean
    Description
    Rule activation status for automatic cost allocation processing. Controls whether rule participates in allocation execution sequence.
  - createTimeInMillisinteger<int64>
    Description
    Rule creation timestamp in Unix time milliseconds. Tracks when automatic allocation rule was first established in system.
  - updateTimeInMillisinteger<int64>
    Description
    Rule modification timestamp in Unix time milliseconds. Tracks when automatic allocation rule configuration was last changed.

curl

curl --request GET \
     --url https://app.amberflo.io/business-unit/focus-allocation/automatic/rule \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://app.amberflo.io/business-unit/focus-allocation/automatic/rule", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://app.amberflo.io/business-unit/focus-allocation/automatic/rule")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://app.amberflo.io/business-unit/focus-allocation/automatic/rule"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

// Successful request
{
  "metadata": {
    "limit": "",
    "page": "",
    "tagName": "",
    "tagValues": [
      ""
    ],
    "businessUnitIds": [
      ""
    ],
    "providers": [
      ""
    ],
    "enabled": false,
    "totalRowCount": "",
    "filteredRowCount": "",
    "totalFilteredPages": ""
  },
  "items": [
    {
      "id": "0e63b938-6785-429b-a89d-c4164144fc88",
      "provider": "",
      "predicate": {},
      "tagName": "",
      "tagValue": "",
      "businessUnitId": "",
      "label": "",
      "description": "",
      "enabled": false,
      "createTimeInMillis": "",
      "updateTimeInMillis": ""
    }
  ]
}