Campaign SDKv1.0.11

@omx-sdk/campaign

Campaign management module for the OMX platform with full CRUD operations, analytics, and team-based data isolation.

Key Features

Campaign CRUD

• Create and manage campaigns
• Update campaign status
• Duplicate campaigns
• Delete campaigns

Zero Dependencies

• Edge Function-based architecture
• No external dependencies
• TypeScript support
• JWT token management

Team Isolation

• Team-based data isolation
• Secure authentication
• Campaign statistics
• Execution tracking

Analytics

• Campaign performance metrics
• Execution statistics
• Real-time tracking
• Historical data

Installation

Install @omx-sdk/campaign

npm install @omx-sdk/campaign

Or use your preferred package manager:

yarn add @omx-sdk/campaign

pnpm add @omx-sdk/campaign

Quick Start

Basic Usage

Initialize the campaign client and create your first campaign

import { createCampaignClient } from "@omx-sdk/campaign";

// Initialize the client
const campaignClient = createCampaignClient({
  clientId: "your-client-id",
  secretKey: "your-secret-key",
  teamId: "your-team-id" // optional
});

// Create a campaign
const newCampaign = await campaignClient.createCampaign({
  name: "Summer Sale 2024",
  description: "Special summer promotion",
  industry: "ecommerce",
  status: "draft"
});

console.log("Campaign created:", newCampaign.id);

// List all campaigns
const campaigns = await campaignClient.listCampaigns();
console.log("Total campaigns:", campaigns.length);

Core Methods

createCampaign(data)

Create a new campaign

listCampaigns(filters?)

List all campaigns with optional filters

getCampaign(id)

Get specific campaign details

updateCampaign(id, updates)

Update campaign information

deleteCampaign(id)

Delete a campaign

updateCampaignStatus(id, status)

Update campaign status

duplicateCampaign(id, newName?)

Duplicate an existing campaign

getCampaignStats()

Get campaign statistics

Next Steps

Create Campaigns

Learn how to create and configure campaigns with all available options.

View Guide

Campaign Analytics

Discover how to track campaign performance and analyze metrics.

Learn More