v1

latestOpenAPI 3.0.02026-07-2482421001.1 KB

Tag Management

Retrieve a tag

This API is used to retrieve details of a specific tag based on the specified tag_uuid. The response includes the tag's name, description, color, type (system or custom), include and exclude terms, and other configuration details.

get/v2/analytics/tags/{tag_uuid}

Path parameters

tag_uuidstring required

Example:13e6d579-4699-43e2-a419-8a29bcb5f922

Unique identifier of the tag whose details are to be retrieved.

Response

Success

uuidstring uuid

Unique identifier of the tag whose details are retrieved.

namestring

Name of the retrieved tag.

descriptionstring

Detailed description of the tag.

colorstring

Hexadecimal color code of tag in Dashboard.

is_system_tagboolean

Indicates whether the tag is a system-defined tag (true) or a custom tag (false).

created_tsstring date-time

Timestamp when the tag was created.

updated_tsstring date-time

Timestamp when the tag was last updated.

Example response

{
  "uuid": "41761692-032e-4b03-9b36-e96c03c9a7bc",
  "name": "demo_tag",
  "description": "for demo testing",
  "color": "#f5ce03",
  "created_ts": "2023-09-13T12:05:52.789616",
  "updated_ts": "2023-11-23T10:48:02.074384",
  "customization": {
    "include_terms": [
      "hh"
    ],
    "exclude_terms": []
  }
}