System tools for Campaign

  • Updated

System tools are built-in features that help Optimizely Opal take action. Each tool performs a specific task, such as creating a campaign, uploading files, or generating images. Think of tools like attachments on a Swiss Army knife. Each one has a distinct purpose that helps you get work done.

In addition to the system tools available in Opal, Campaign includes a set of system tools designed to support getting campaign information. These Opal system tools are grouped by functionality to make it easier to find the right tool for your workflow.

You can ask Opal what tools it has at any time. For example, enter "Please list the tools you have with a brief description of what they do and the parameters" into Opal Chat.

Click a tool's name to expand it and learn when to use it, its required and optional parameters, and example prompts to calling the tool. If you do not provide a required parameter, Opal prompts you for it.

campaign_get_smart_campaign – Retrieves detailed information about a single Smart Campaign.
  • When to use
    • When you want to view, get, analyze, or fetch information about a specific campaign by its ID.
  • Parameters
    • campaignId 
  • Example prompts
    • Show campaign 12345.
    • Get details of campaign 98765.
    • Analyze campaign 54321.
    • Fetch campaign 112233.
    • Tell me about campaign 78901.
campaign_get_smart_campaign_list –  Retrieves detailed information about a list of Smart Campaigns.
  • When to use
    • When you need to show, list, find, or get data for multiple campaigns, or analyze overall campaign performance.
  • Parameters
    • (Optional) limit
    • (Optional) offset
    • (Optional) sort
    • (Optional) direction
    • (Optional) mediaType
    • (Optional) status
  • Example prompts
    • Show me all active email campaigns.
    • List all campaigns.
    • Find campaigns created this month.
    • Get all running campaigns.
    • Show me campaigns sorted by name.
campaign_get_smart_campaign_message_content – Retrieves the content of a specific campaign email message in either plain text or HTML format.
  • When to use
    • When you want to view, fetch, or retrieve the message content of a campaign, including HTML or plain text versions, or content from the editor.
  • Parameters
    • campaignId
    • mailingId
    • (Optional) mimeType
    • (Optional) source
  • Example prompts
    • Show message content of mailing ID 4324 of campaign 12345.
    • Get HTML content of mailing ID 1234 of campaign 54321.
    • Show plain text of campaign 99999 mail 123.
    • Retrieve email content 5432 of campaign 2222.
campaign_get_smart_campaign_messages – Retrieves a list of all messages associated with a specific Smart Campaign.
  • When to use
    •  When you need to show, list, or get messages for a particular campaign, or audit what was sent.
  • Parameters
    • campaignId
  • Example prompts
    • List all messages for campaign 12345.
    • Show messages for campaign 98765.
    • What messages were sent in campaign 54321?"
    • Get messages for campaign 112233.
    • Show me the messages in campaign 78901.
campaign_get_smart_campaign_report – Generates a detailed report for a Smart Campaign, including statistics on recipients, bounces, unsubscribes, opens, and clicks.
  • When to use
    • When you need a report for a campaign or specific metrics from that report, such as clicks, opens, or unsubscribes.
  • Parameters
    • campaignId
  • Example prompts
    • Show report for campaign 1234.
    • How many opens were there in campaign 12345?
    • Get the number of clicks for campaign 22.
    • Provide me information about unsubscribes in campaign 9999.
    • Show me the full report for campaign 556677.