TagEngine
Platform APIs for product tag management, metadata, experiments, and configuration.
Manage A/B experiment tags for testing different tag configurations. Supports creating experiments, fetching experimental data, and retrieving category tags by position.
Operations
PUT
# Create or update A/B experiment tags
GET
# Get all experimental tag data
GET
# Get category tags by position
GET
# Get all active tag positions
Upsert A/B experiment tag configuration for testing different tag setups.
Parameters
company_id
string
Required
application_id
string
Required
Request body
position
string
experiment_name
string
tags
array of object (ExperimentTag)
Array of ExperimentTag
name
string
value
string
Response
200
Experiment upserted
ExperimentData
position
string
experiment_name
string
tags
array of object (ExperimentTag)
Array of ExperimentTag
name
string
value
string
Examples
Parameters
body:
body
Was this section helpful?
PUT
Response
Create or update A/B experiment tags
upsertExperiment
Retrieve all A/B experiment tag configurations for the current tenant.
Parameters
company_id
string
Required
application_id
string
Required
Response
200
Experimental tag data
Array of ExperimentDataItem
position
string
experiment_name
string
tenant
string
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Get all experimental tag data
getExperimentalTagData
Parameters
company_id
string
Required
application_id
string
Required
position
string
Required
Response
200
Category tags
Array of CategoryTag
name
string
position
string
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Get category tags by position
getCategoryTags
Parameters
company_id
string
Required
application_id
string
Required
Response
200
Active tags
Array of CategoryTag
name
string
position
string
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Get all active tag positions
getAllActiveTags
Upload and download tag bucket JSON files for bulk tag management. Supports file upload, download, and cache clearing operations.
Operations
PUT
# Upload tag bucket JSON file
GET
# Download tag bucket file
GET
# Clear tag bucket cache
Upload a JSON file containing tag bucket data. Maximum file size is 2MB.
Parameters
company_id
string
Required
application_id
string
Required
Request body
file_name
string
Response
200
File uploaded
StatusMessage
status
string
message
string
Examples
Parameters
body:
body
Was this section helpful?
PUT
Response
Upload tag bucket JSON file
uploadTagBucket
Parameters
company_id
string
Required
application_id
string
Required
file_name
string
Required
Response
200
File content
FileContent
file_name
string
content
string
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Download tag bucket file
downloadTagBucket
Parameters
company_id
string
Required
application_id
string
Required
Response
200
Cache cleared
StatusMessage
status
string
message
string
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Clear tag bucket cache
clearTagBucketCache
Manage runtime configuration settings for the tag engine service including cache timeouts, batch sizes, and other operational parameters.
Operations
PUT
# Update runtime configuration
GET
# Get all application configurations
GET
# Refresh configuration cache
Update a runtime configuration key-value pair for the tag engine service.
Parameters
company_id
string
Required
application_id
string
Required
key
string
Required
value
string
Required
Response
200
Configuration updated
StatusMessage
status
string
message
string
Examples
Parameters
Parameters are not required.
Was this section helpful?
PUT
Response
Update runtime configuration
updateConfig
Retrieve all runtime configuration settings for the tag engine service.
Parameters
company_id
string
Required
application_id
string
Required
Response
200
Application configurations
AppConfig
key
string
value
string
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Get all application configurations
getAppConfig
Parameters
company_id
string
Required
application_id
string
Required
Response
200
Cache refreshed
StatusMessage
status
string
message
string
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Refresh configuration cache
refreshConfigCache
Fetch product tags by option codes. Tags like Best Price, Selling Fast, and Good Quality are assigned to products and displayed on product listing and detail pages.
Operations
GET
# Get tags by option codes
GET
# Get tags V2 with service and tenant support
Fetch product tags for the given option codes. Returns tags like Best Price, Selling Fast, etc.
Parameters
company_id
string
Required
application_id
string
Required
option_codes
string
Required
fetch_all_tags
string
Enum
nocache
string
Enum
Response
200
Tags fetched successfully
TagListV1
status
string
message
string
tags
array of object
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Get tags by option codes
getTags
Fetch product tags with service type and tenant filtering. Supports A/B experiment values.
Parameters
company_id
string
Required
application_id
string
Required
service
string
Required
Enum
option_codes
string
Required
fetch_all_tags
string
Enum
nocache
string
Enum
experiment_value
string
Response
200
Tags fetched successfully
TagListV2
status
string
tags
array of object
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Get tags V2 with service and tenant support
getTagsV2
Manage tag metadata definitions including priority, visibility, and service-level configuration. Supports CRUD operations on tag metadata and priority hierarchies.
Operations
GET
# Get tag metadata by tag name
POST
# Create or update tag metadata
GET
# Get priority hierarchy for a service
GET
# Filter tag metadata
GET
# Refresh tag metadata cache
Retrieve metadata for a specific tag including priority, visibility, and service configuration.
Parameters
company_id
string
Required
application_id
string
Required
tag
string
Required
Response
200
Tag metadata
Array of TagMetaDataItem
name
string
position
string
service
string
show_tags
boolean
priority
integer
tenant
string
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Get tag metadata by tag name
getTagMetaData
Upsert tag metadata definitions for tags including priority, visibility, and service configuration.
Parameters
company_id
string
Required
application_id
string
Required
Response
200
Metadata upserted
Array of TagMetaDataItem
name
string
position
string
service
string
show_tags
boolean
priority
integer
tenant
string
Examples
Parameters
body:
body[0]
Was this section helpful?
POST
Response
Create or update tag metadata
upsertTagMetaData
Retrieve the priority hierarchy of tags for a given service type.
Parameters
company_id
string
Required
application_id
string
Required
service
string
Required
Response
200
Priority hierarchy
TagPriority
priorities
array of object (CategoryTag)
Array of CategoryTag
name
string
position
string
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Get priority hierarchy for a service
getPriorityByService
Parameters
company_id
string
Required
application_id
string
Required
service
string
tag_name
string
show_tags
string
Enum
position
string
Response
200
Filtered metadata
Array of TagMetaDataItem
name
string
position
string
service
string
show_tags
boolean
priority
integer
tenant
string
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Filter tag metadata
filterMetaData
Parameters
company_id
string
Required
application_id
string
Required
Response
200
Metadata refreshed
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Refresh tag metadata cache
refreshTagMetaData
Publish product tags to the PLP (Product Listing Page) service via Kafka for real-time tag updates on the storefront.
Operations
POST
# Publish tags to PLP via Kafka
Publish product tags for the given option codes to the PLP service via Kafka.
Parameters
company_id
string
Required
application_id
string
Required
Request body
option_codes
array of string
Response
200
Tags published
StatusMessage
status
string
message
string
Examples
Parameters
body:
body
Was this section helpful?
POST
Response