Retrieve a bucket attribute

Retrieves a bucket attribute specified by the bucketingId. You can retrieve a bucket attribute's bucketingId using the Retrieve all bucket attributes endpoint.

Request Method Service URL

GET

/api-metadata/v1/{access-key}/metadata/aggregatedtables/{aggregatedTableId}/buckets/{bucketingId}

Request Headers

Content-Type=application/json

Examples

Retrieve the bucket attribute for the "mastercustomer" master entity where the bucketingId is "age_bands":

Request

GET http://{accountURL}/api-metadata/v1/e2a7a0df2410470d85ef69c8dad2bdb8/metadata/aggregatedtables/mastercustomer/buckets/age_bands

Response

{
  "tenantId": 100173,
  "name": "Age group Bands",
  "versionTS": 1583969465003,
  "active": true,
  "lastModifiedBy": "system",
  "createdTS": 1562190929928,
  "tableId": "MasterCustomer",
  "bucketingId": "age_bands",
  "attribute": {
    "atype": ".ReferenceAttribute",
    "tableName": "MasterCustomer",
    "attributeName": "Age"
  },
  "type": "VALUE",
  "configs": [
    {
      "lowerBound": {
        "atype": ".RangeAttribute",
        "data": 0,
        "type": "INCLUSIVE"
      },
      "upperBound": {
        "atype": ".RangeAttribute",
        "data": 18,
        "type": "INCLUSIVE"
      },
      "rangeValue": {
        "atype": ".StaticAttribute",
        "data": "Under 18"
      }
    },
    {
      "lowerBound": {
        "atype": ".RangeAttribute",
        "data": 18,
        "type": "EXCLUSIVE"
      },
      "upperBound": {
        "atype": ".RangeAttribute",
        "data": 44,
        "type": "INCLUSIVE"
      },
      "rangeValue": {
        "atype": ".StaticAttribute",
        "data": "18-44"
      }
    },
    {
      "lowerBound": {
        "atype": ".RangeAttribute",
        "data": 44,
        "type": "EXCLUSIVE"
      },
      "upperBound": {
        "atype": ".RangeAttribute",
        "data": 64,
        "type": "INCLUSIVE"
      },
      "rangeValue": {
        "atype": ".StaticAttribute",
        "data": "45-64"
      }
    },
    {
      "lowerBound": {
        "atype": ".RangeAttribute",
        "data": 64,
        "type": "EXCLUSIVE"
      },
      "rangeValue": {
        "atype": ".StaticAttribute",
        "data": "65+"
      }
    }
  ]
}

Learn more

Bucket Attributes API

Master entities API