Update an attribute

patchhttps://api.faraday.ai/v1/attributes/{attribute_id}

Update the configuration of an attribute

Authentication

Bearer Authentication

Provide your API key in the Authorization header. You can find your API key in the Settings page of the dashboard.

Authorization: Bearer YOUR_TOKEN

path parameters

attribute_idstring<uuid>required

The UUID of an attribute

Responses

200Information about the attribute

aggregationobjectrequired

Configuration for how to aggregate multiple assertions for this attribute.

Properties of object

methodstringrequired

The aggregation method to use.

Allowed values: or, min, max, mean, median, mode, coalesce

sortarray[object]

Sort configuration used by the coalesce method. Applied in order - first by the first sort, then by the second, etc. Only used when method is 'coalesce'.

Items of array[object]

directionstring

Sort direction (ascending or descending).

Allowed values: asc, desc

priorityarray[object]

Explicit priority order for categorical values.

Example: ["epsilon","verisk"]

property_namestringrequired

The property name to sort by.

Example: "authority"

archived_atstring<date-time>

If not null, this resource will no longer receive updates, but will still be visable.

categorystringrequired

A category describing the type of attribute.

Allowed values:

fig/demography, fig/environment, fig/geography, fig/identity, fig/lifestyle, fig/life_event, fig/property, fig/reachability, fig/society, fig/financial, user_defined

created_atstring<date-time>required

When this resource was created.

default_selector_by_purposeobjectrequired

Default selector hints organized by purpose (modeling, inference, append). These provide guidance to consumers but are not automatically applied by the attribute system.

Properties of object

appendobject

Selector hints for append purposes.

Properties of object

authorityarray[string]

List of allowed authorities.

Example: ["epsilon","verisk"]

derivationsarray[string]

List of allowed derivation methods.

Example: ["modeled","collected"]

precisionarray[string]

List of allowed precision levels.

Example: ["person"]

qualityarray[string]

List of allowed quality levels.

Example: ["1"]

inferenceobject

Selector hints for inference purposes.

Properties of object

authorityarray[string]

List of allowed authorities.

Example: ["epsilon","verisk"]

derivationsarray[string]

List of allowed derivation methods.

Example: ["modeled","collected"]

precisionarray[string]

List of allowed precision levels.

Example: ["person"]

qualityarray[string]

List of allowed quality levels.

Example: ["1"]

modelingobject

Selector hints for modeling purposes.

Properties of object

authorityarray[string]

List of allowed authorities.

Example: ["epsilon","verisk"]

derivationsarray[string]

List of allowed derivation methods.

Example: ["modeled","collected"]

precisionarray[string]

List of allowed precision levels.

Example: ["person"]

qualityarray[string]

List of allowed quality levels.

Example: ["1"]

deprecatedboolean

Whether this attribute is deprecated.

deprecation_notesstring

Notes about the deprecation of the attribute. Should be present if and only if deprecated is true.

descriptionstringrequired

A description of the attribute.

Example: "The person's age in years"

directionality_interpretationstring

If applicable, describes the meaning of any directionality in the values.

Example: "Higher numbers indicate older individuals"

feature_store_idstring<uuid>required

The UUID of the feature store this attribute belongs to.

Example: "9c7b2a8f-4e1d-4d3c-8b9a-1f2e3d4c5b6a"

idstring<uuid>required

A unique ID for this resource.

interpretation_mapdictionary[string, string]

For enumerable attributes, a mapping from values to their interpretations. The key type matches the attribute's data type, and the value is always a string interpretation.

last_read_input_atstring<date-time>

The last time this resource's input was read.

last_updated_config_atstring<date-time>

The last time this resource's configuration was updated. If this is more recent than last_updated_output_at, the resource will be rebuilt.

last_updated_output_atstring<date-time>

The last time this resource successfully built.

literatestringrequired

A human-readable name for the attribute.

Example: "Age"

namestringrequired

The slug name of the attribute. Must start with a letter and contain only lowercase letters, numbers, and underscores.

Example: "age"

Match pattern: ^[a-z][a-z0-9_]*$

null_value_interpretationstring

If a unary null replacement isn't applicable or viable, this describes how NULLs should be interpreted when encountered.

Example: "Unknown"

null_value_replacementone of 3 types

If set, null values should be coalesced with this replacement to avoid any NULLs.

Properties of one of 3 types

One of:

boolean

resource_typestringrequired

The type of this resource.

statusstringrequired

The current state of this resource and any updates.

Example: "pending"

Allowed values: new, starting, running, ready, error

status_changed_atstring<date-time>

When the status of this resource was last updated.

status_errorstring

If this resource has status == "error", this will contain an error message.

stream_namestringrequired

The name of the stream containing the assertions for this attribute.

Example: "age_assertions"

tierstringrequired

A billing tier for the attribute.

Allowed values: standard, premium, prohibited

updated_atstring<date-time>required

When this resource was last updated.

value_property_namestringrequired

The name of the property in the stream that contains the assertion value. This indicates which property is special and represents the attribute's value.

Example: "value"

400The request was invalid.

errorstringrequired

A Faraday error code.

Some possible values include:

Generic HTTP Errors

BAD_REQUEST: The request could not be validated.
FORBIDDEN: You do not have permission to access the specified resour...

Example: "ERROR_TYPE"

Allowed values:

BAD_REQUEST, FORBIDDEN, MAX_RESOURCES_REACHED, INTERNAL_SERVER_ERROR, INVALID_AUTHORIZATION, NOT_FOUND, MALFORMED_API_KEY, MISSING_API_KEY, EXPIRED_API_KEY, VALIDATION_FAILED, CONFLICT

idstring<uuid>required

A unique ID for this error. Please include this in bug reports.

Example: "082f9513-901c-4308-8081-902a8fe22d7e"

notestringrequired

A human-readable description of the error.

Example: "An error occurred"

validationErrorsarray[object]

JSON Schema validation errors, if any.

Items of array[object]

contextobjectrequired

More information about the error.

Properties of object

errorTypestringrequired

The type of validation error which occurred.

messagestringrequired

A human-readable error message.

pathstringrequired

The location in the document that failed validation.

suggestionstring

A suggestion for fixing this error.

401No API key was supplied.

errorstringrequired

A Faraday error code.

Some possible values include:

Generic HTTP Errors

BAD_REQUEST: The request could not be validated.
FORBIDDEN: You do not have permission to access the specified resour...

Example: "ERROR_TYPE"

Allowed values:

BAD_REQUEST, FORBIDDEN, MAX_RESOURCES_REACHED, INTERNAL_SERVER_ERROR, INVALID_AUTHORIZATION, NOT_FOUND, MALFORMED_API_KEY, MISSING_API_KEY, EXPIRED_API_KEY, VALIDATION_FAILED, CONFLICT

idstring<uuid>required

A unique ID for this error. Please include this in bug reports.

Example: "082f9513-901c-4308-8081-902a8fe22d7e"

notestringrequired

A human-readable description of the error.

Example: "An error occurred"

validationErrorsarray[object]

JSON Schema validation errors, if any.

Items of array[object]

contextobjectrequired

More information about the error.

Properties of object

errorTypestringrequired

The type of validation error which occurred.

messagestringrequired

A human-readable error message.

pathstringrequired

The location in the document that failed validation.

suggestionstring

A suggestion for fixing this error.

403Access to this resource was forbidden.

errorstringrequired

A Faraday error code.

Some possible values include:

Generic HTTP Errors

BAD_REQUEST: The request could not be validated.
FORBIDDEN: You do not have permission to access the specified resour...

Example: "ERROR_TYPE"

Allowed values:

BAD_REQUEST, FORBIDDEN, MAX_RESOURCES_REACHED, INTERNAL_SERVER_ERROR, INVALID_AUTHORIZATION, NOT_FOUND, MALFORMED_API_KEY, MISSING_API_KEY, EXPIRED_API_KEY, VALIDATION_FAILED, CONFLICT

idstring<uuid>required

A unique ID for this error. Please include this in bug reports.

Example: "082f9513-901c-4308-8081-902a8fe22d7e"

notestringrequired

A human-readable description of the error.

Example: "An error occurred"

validationErrorsarray[object]

JSON Schema validation errors, if any.

Items of array[object]

contextobjectrequired

More information about the error.

Properties of object

errorTypestringrequired

The type of validation error which occurred.

messagestringrequired

A human-readable error message.

pathstringrequired

The location in the document that failed validation.

suggestionstring

A suggestion for fixing this error.

404The requested resource ID was not found.

errorstringrequired

A Faraday error code.

Some possible values include:

Generic HTTP Errors

BAD_REQUEST: The request could not be validated.
FORBIDDEN: You do not have permission to access the specified resour...

Example: "ERROR_TYPE"

Allowed values:

BAD_REQUEST, FORBIDDEN, MAX_RESOURCES_REACHED, INTERNAL_SERVER_ERROR, INVALID_AUTHORIZATION, NOT_FOUND, MALFORMED_API_KEY, MISSING_API_KEY, EXPIRED_API_KEY, VALIDATION_FAILED, CONFLICT

idstring<uuid>required

A unique ID for this error. Please include this in bug reports.

Example: "082f9513-901c-4308-8081-902a8fe22d7e"

notestringrequired

A human-readable description of the error.

Example: "An error occurred"

validationErrorsarray[object]

JSON Schema validation errors, if any.

Items of array[object]

contextobjectrequired

More information about the error.

Properties of object

errorTypestringrequired

The type of validation error which occurred.

messagestringrequired

A human-readable error message.

pathstringrequired

The location in the document that failed validation.

suggestionstring

A suggestion for fixing this error.

409The request was formatted correctly, but conflicted with an existing resource.

errorstringrequired

A Faraday error code.

Some possible values include:

Generic HTTP Errors

BAD_REQUEST: The request could not be validated.
FORBIDDEN: You do not have permission to access the specified resour...

Example: "ERROR_TYPE"

Allowed values:

BAD_REQUEST, FORBIDDEN, MAX_RESOURCES_REACHED, INTERNAL_SERVER_ERROR, INVALID_AUTHORIZATION, NOT_FOUND, MALFORMED_API_KEY, MISSING_API_KEY, EXPIRED_API_KEY, VALIDATION_FAILED, CONFLICT

idstring<uuid>required

A unique ID for this error. Please include this in bug reports.

Example: "082f9513-901c-4308-8081-902a8fe22d7e"

notestringrequired

A human-readable description of the error.

Example: "An error occurred"

validationErrorsarray[object]

JSON Schema validation errors, if any.

Items of array[object]

contextobjectrequired

More information about the error.

Properties of object

errorTypestringrequired

The type of validation error which occurred.

messagestringrequired

A human-readable error message.

pathstringrequired

The location in the document that failed validation.

suggestionstring

A suggestion for fixing this error.

500An internal server error occurred.

errorstringrequired

A Faraday error code.

Some possible values include:

Generic HTTP Errors

BAD_REQUEST: The request could not be validated.
FORBIDDEN: You do not have permission to access the specified resour...

Example: "ERROR_TYPE"

Allowed values:

BAD_REQUEST, FORBIDDEN, MAX_RESOURCES_REACHED, INTERNAL_SERVER_ERROR, INVALID_AUTHORIZATION, NOT_FOUND, MALFORMED_API_KEY, MISSING_API_KEY, EXPIRED_API_KEY, VALIDATION_FAILED, CONFLICT

idstring<uuid>required

A unique ID for this error. Please include this in bug reports.

Example: "082f9513-901c-4308-8081-902a8fe22d7e"

notestringrequired

A human-readable description of the error.

Example: "An error occurred"

validationErrorsarray[object]

JSON Schema validation errors, if any.

Items of array[object]

contextobjectrequired

More information about the error.

Properties of object

errorTypestringrequired

The type of validation error which occurred.

messagestringrequired

A human-readable error message.

pathstringrequired

The location in the document that failed validation.

suggestionstring

A suggestion for fixing this error.

Tags

attributes

Test request

API key

Prefer using test/development API keys here.

Path parameters

attribute_id*

Request body (JSON)

{
  "aggregation": {
    "method": "or",
    "sort": [
      {
        "direction": "asc",
        "priority": [
          "epsilon",
          "verisk"
        ],
        "property_name": "authority"
      }
    ]
  },
  "category": "fig/demography",
  "default_selector_by_purpose": {
    "append": {
      "authority": [
        "epsilon",
        "verisk"
      ],
      "derivations": [
        "modeled",
        "collected"
      ],
      "precision": [
        "person"
      ],
      "quality": [
        "1"
      ]
    },
    "inference": {
      "authority": [
        "epsilon",
        "verisk"
      ],
      "derivations": [
        "modeled",
        "collected"
      ],
      "precision": [
        "person"
      ],
      "quality": [
        "1"
      ]
    },
    "modeling": {
      "authority": [
        "epsilon",
        "verisk"
      ],
      "derivations": [
        "modeled",
        "collected"
      ],
      "precision": [
        "person"
      ],
      "quality": [
        "1"
      ]
    }
  },
  "deprecated": false,
  "deprecation_notes": "string",
  "description": "The person's age in years",
  "directionality_interpretation": "Higher numbers indicate older individuals",
  "feature_store_id": "9c7b2a8f-4e1d-4d3c-8b9a-1f2e3d4c5b6a",
  "interpretation_map": {
    "key": "string"
  },
  "literate": "Age",
  "name": "age",
  "null_value_interpretation": "Unknown",
  "null_value_replacement": false,
  "stream_name": "age_assertions",
  "tier": "standard",
  "value_property_name": "value"
}

Request snippet

curl -X PATCH 'https://api.faraday.ai/v1/attributes/{attribute_id}' \
  -H 'Content-Type: application/json+merge-patch' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -d '{
      "aggregation": {
        "method": "or",
        "sort": [
          {
            "direction": "asc",
            "priority": [
              "epsilon",
              "verisk"
            ],
            "property_name": "authority"
          }
        ]
      },
      "category": "fig/demography",
      "default_selector_by_purpose": {
        "append": {
          "authority": [
            "epsilon",
            "verisk"
          ],
          "derivations": [
            "modeled",
            "collected"
          ],
          "precision": [
            "person"
          ],
          "quality": [
            "1"
          ]
        },
        "inference": {
          "authority": [
            "epsilon",
            "verisk"
          ],
          "derivations": [
            "modeled",
            "collected"
          ],
          "precision": [
            "person"
          ],
          "quality": [
            "1"
          ]
        },
        "modeling": {
          "authority": [
            "epsilon",
            "verisk"
          ],
          "derivations": [
            "modeled",
            "collected"
          ],
          "precision": [
            "person"
          ],
          "quality": [
            "1"
          ]
        }
      },
      "deprecated": false,
      "deprecation_notes": "string",
      "description": "The person's age in years",
      "directionality_interpretation": "Higher numbers indicate older individuals",
      "feature_store_id": "9c7b2a8f-4e1d-4d3c-8b9a-1f2e3d4c5b6a",
      "interpretation_map": {
        "key": "string"
      },
      "literate": "Age",
      "name": "age",
      "null_value_interpretation": "Unknown",
      "null_value_replacement": false,
      "stream_name": "age_assertions",
      "tier": "standard",
      "value_property_name": "value"
    }'

Example response

application/json

{
  "aggregation": {
    "method": "or",
    "sort": [
      {
        "direction": "asc",
        "priority": [
          "epsilon",
          "verisk"
        ],
        "property_name": "authority"
      }
    ]
  },
  "archived_at": "2024-01-01T12:00:00Z",
  "category": "fig/demography",
  "created_at": "2024-01-01T12:00:00Z",
  "default_selector_by_purpose": {
    "append": {
      "authority": [
        "epsilon",
        "verisk"
      ],
      "derivations": [
        "modeled",
        "collected"
      ],
      "precision": [
        "person"
      ],
      "quality": [
        "1"
      ]
    },
    "inference": {
      "authority": [
        "epsilon",
        "verisk"
      ],
      "derivations": [
        "modeled",
        "collected"
      ],
      "precision": [
        "person"
      ],
      "quality": [
        "1"
      ]
    },
    "modeling": {
      "authority": [
        "epsilon",
        "verisk"
      ],
      "derivations": [
        "modeled",
        "collected"
      ],
      "precision": [
        "person"
      ],
      "quality": [
        "1"
      ]
    }
  },
  "deprecated": false,
  "deprecation_notes": "string",
  "description": "The person's age in years",
  "directionality_interpretation": "Higher numbers indicate older individuals",
  "feature_store_id": "9c7b2a8f-4e1d-4d3c-8b9a-1f2e3d4c5b6a",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "interpretation_map": {
    "key": "string"
  },
  "last_read_input_at": "2024-01-01T12:00:00Z",
  "last_updated_config_at": "2024-01-01T12:00:00Z",
  "last_updated_output_at": "2024-01-01T12:00:00Z",
  "literate": "Age",
  "name": "age",
  "null_value_interpretation": "Unknown",
  "null_value_replacement": false,
  "resource_type": "string",
  "status": "pending",
  "status_changed_at": "2024-01-01T12:00:00Z",
  "status_error": "string",
  "stream_name": "age_assertions",
  "tier": "standard",
  "updated_at": "2024-01-01T12:00:00Z",
  "value_property_name": "value"
}