Update field

PUT/v2/datasets/{dataset_id}/fields/{field_id}

Updates the unit, description, and hidden settings of a field. All three are replaced, so omitted values are cleared. The name and type in the body are ignored.

Parameters

Property	Type	Location	Description
`dataset_id`	`string`Required	`path`
`field_id`	`string`Required	`path`

Body

application/json

Property	Type	Description
`description`	`string`	Description of the field
`hidden`	`boolean`	Whether the field is hidden
`name`	`string`Required	Name of the field
`type`	`string`Required	Type of the field
`unit`	`string`	Unit of the field

Request

curl -X PUT 'https://api.axiom.co/v2/datasets/DATASET_ID/fields/FIELD_ID' \
  -H 'Authorization: Bearer API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"description":"string","hidden":true,"name":"string","type":"string","unit":"string"}'

Try itRun this request against your Axiom organization

Credentials stay in this browser tab and are only sent to Axiom when you run the request.

API token Requireddataset_id pathRequiredfield_id pathRequiredRequest body application/json

Response

200Updated field.

application/json

400A metrics dataset or a dataset managed by Axiom.

application/json

403Forbidden

404The dataset doesn't exist or the field isn't in its schema.

application/json

Property	Type	Description
`description`	`string`	Description of the field
`hidden`	`boolean`	Whether the field is hidden
`name`	`string`Required	Name of the field
`type`	`string`Required	Type of the field
`unit`	`string`	Unit of the field