Tag By ID

POST 
/v1/query/update/tag/ids

Applies or removes a tag to a specified list of data point IDs within a projection. If the tag does not exist, it will be created.

Request

application/json

Body

required

projection_id uuidrequired

The UUID of the projection (map).

tag_name Tag Name (string)required

The name of the tag to apply or remove.

id_field ID Field (string)

The field containing the unique IDs. Defaults to the dataset's unique_id_field if not provided.

ids undefined[]required

An array of data point IDs to tag or untag.

operation Operation (string)

Possible values: [add, remove]

Default value: add

The operation to perform.

Responses

200

Successful Response

application/json

Schema

Schema

success Success (boolean)

Indicates if the operation was successful.

tag_id uuid

The UUID of the tag involved in the operation.

points_tagged Points Tagged (integer)

The number of points successfully tagged or untagged.

Example (from schema)

{
  "success": true,
  "tag_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "points_tagged": 0
}

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...