Tag Management APIs

The Tag Management APIs provide a set of endpoints for creating, retrieving, updating, and deleting tags in the Spaaza system. Tags are flexible labels that can be applied to various entities (currently focused on users) to enable segmentation, targeting, and additional metadata storage.

Core Concepts

Tags in the Spaaza system are structured around these key concepts:

Tags

Tags are metadata labels that:

• Belong to a specific chain (retailer)
• Have a unique ID within that chain
• Contain a string value that represents the tag content
• Are associated with a specific model class (e.g., “user”)
• Can be marked as active or inactive
• Can be marked as deleted

In the Spaaza data model, a ‘tag’ is a flexible object that can be used to label and categorize various entities within the system. Tags are primarily used to associate metadata with users, allowing for segmentation and targeted campaign management.

Tag Types

Tags in Spaaza are defined by their model_class, which determines the type of entity they can be associated with. Currently, the most common model class is user, which allows tags to be applied to end-user accounts.

Features of Tags

• Chain-specific: Tags are always associated with a specific chain (retailer)
• Simple key-value structure: Each tag consists of a unique id and a string value
• Status tracking: Tags can be marked as active or inactive and can be “deleted” (marked as deleted)
• Flexible usage: Tags can be used for segmentation, targeting, and filtering users
• Metadata carrier: Tags enable additional information to be attached to entities without modifying core data structures

User Tags

When tags are applied to users:

• They create relationships between users and specific metadata labels
• They enable segmentation of users based on arbitrary criteria
• They support advanced targeting for marketing campaigns
• They can be used to store additional user attributes outside the core user schema

Available Endpoints

Tag Management

• Add Tag - Create a new tag for a chain
• Get Tag - Retrieve a specific tag by ID
• Get Tags - List all tags for a chain
• Alter Tag - Update an existing tag
• Delete Tag - Delete a tag

User Tag Management

• Add User Tag - Associate a tag with a user
• Delete User Tag - Remove a tag from a user

Common Operations

1. Creating and managing tags:
   • First create a tag using Add Tag
   • Retrieve it with Get Tag or list all with Get Tags
   • Update it with Alter Tag if needed
   • Delete it with Delete Tag when no longer needed
2. Tagging users:
   • After creating tags, assign them to users with Add User Tag
   • Remove associations with Delete User Tag

---

Table of contents

• Adding a tag
• Altering a tag
• Deleting a tag
• Getting a tag
• Getting tags