get_campaign

Retrieve detailed information about a specific campaign by its ID.

Returns complete campaign configuration including discount details, validation rules, voucher settings, and current status for campaign analysis and management.

Enhanced Features:

• Automatically fetches and processes validation rules for detailed rule analysis

• Provides both raw validation_rules_assignments and processed assigned_validation_rules

• Includes complete campaign hierarchy and voucher generation settings

Parameters:

• campaign_id: Campaign identifier for lookup

Identifier Requirements:

• Campaign ID: Must start with 'camp_' prefix (e.g., "camp_X26jzR8ObD55nlwOUcr63Px0")

• ID must correspond to existing campaign

Validation Rules:

• Campaign ID must be valid and existing

• ID format is case-sensitive

Examples:

• get_campaign(campaign_id="camp_X26jzR8ObD55nlwOUcr63Px0")

Returns: JSON object containing complete campaign details including:

Core Campaign Information:

• id: Campaign system identifier (e.g., "camp_X26jzR8ObD55nlwOUcr63Px0")

• name: Human-readable campaign name (e.g., "Burger Deluxe Family Campaign")

• campaign_type: Campaign type ("DISCOUNT_COUPONS", "GIFT_VOUCHERS", "LOYALTY_PROGRAM", "PROMOTION")

• type: Campaign generation type ("STATIC", "DYNAMIC")

• active: Boolean campaign status

• object: Always "campaign"

Campaign Configuration:

• auto_join: Boolean automatic customer enrollment setting

• join_once: Boolean single enrollment restriction

• use_voucher_metadata_schema: Boolean voucher metadata schema usage

• protected: Boolean protection status against modifications

Voucher Template Settings:

• voucher: Complete voucher template configuration:

  • type: Voucher type ("DISCOUNT_VOUCHER", "GIFT_VOUCHER", etc.)

  • discount: Discount configuration (e.g., {"type": "PERCENT", "percent_off": 3})

  • redemption: Usage limits (e.g., {"quantity": null} for unlimited)

  • code_config: Code generation settings:

    • length: Code length (e.g., 8)

    • charset: Character set for code generation

    • pattern: Code pattern (e.g., "########")

  • is_referral_code: Boolean referral code status

Campaign Status and Statistics:

• vouchers_count: Total vouchers generated in campaign

• creation_status: Campaign creation status ("DONE", "IN_PROGRESS", "FAILED")

• vouchers_generation_status: Voucher generation status ("DONE", "IN_PROGRESS", "FAILED")

• created_at: Campaign creation timestamp (ISO 8601)

Access and Categorization:

• access_settings_assignments: Access control assignments with data array and total count

• category_id: Campaign category identifier (null if uncategorized)

• categories: Array of campaign categories (empty if uncategorized)

Validation Rules (Enhanced):

• assigned_validation_rules: Processed validation rules with detailed conditions (added by this tool) See "Validation Rules Structure" section in server instructions for complete field documentation

Use Cases:

• Analyze campaign configuration and discount mechanics

• Understand validation rules and product requirements

• Check campaign status and voucher generation progress

• Review campaign hierarchy and settings

• Get complete campaign blueprint for duplication

Raises:

• ToolError: If campaign not found or invalid campaign ID format