HubSpot Campaign API Update
HubSpot Campaign API Briefing Doc
Date: October 2, 2024
Source: Product Update - Campaign API
Overview:
This document provides an overview of the new Campaign APIs, designed to empower customers, developers, and app partners to seamlessly manage and analyze marketing campaigns and their associated assets.
Key Features:
- CRUD and Batch API: Enables comprehensive campaign management, including creation, retrieval, updating (partial modifications supported), and deletion of campaigns. Batch processing enhances efficiency for handling multiple campaign operations.
- Asset API: Facilitates the management of assets linked to a campaign, allowing users to list, add, or remove them.
- Metrics API: Provides access to crucial campaign performance metrics (e.g., Contacts, Sessions, revenue, budget, spend). This data enables informed decision-making and performance evaluation.
Use Cases:
- Create and Manage Campaigns (CRUD Campaigns):Targets app partners seeking to integrate campaign management directly into their applications.
- Functionalities:"Retrieving and displaying a list of existing campaigns."
- "Creating and managing campaigns directly within third-party applications."
- "Retrieving marketing assets with newly created or existing campaigns."
- Data Integration Service:Benefits customers and developers requiring automated integration of campaign data into external data warehouses.
- Capabilities:"Automated extraction and loading of campaign data into external data warehouses"
- Enables real-time analytics by merging campaign metrics with other business intelligence data.
API Functionalities:
- Campaign Management:Create a campaign with specified properties.
- Read a specific campaign or a page of campaigns.
- Update campaign details with partial modification support.
- Delete a specified campaign.
- Asset Management:List all assets associated with a campaign by asset type.
- Metrics Retrieval:"Get Campaign Metrics Counters": Retrieve metrics like sessions, new contacts, and influenced contacts.
- "Get Metrics Contacts Breakdown": Get a list of new and influenced contacts.
- "Get Revenue Information": Access revenue data for a specific campaign.
- "Get Campaign Budget and Spend Information": Retrieve budget allocation and spending details.
Target Audience:
- Marketing Pro
- Marketing Enterprise
Creators and Guests
Host
Ben Binary
A sharp, data-driven AI personality with a clear, robotic yet professional appearance, embodying precision and technical expertise. He decodes HubSpot updates with the efficiency of an algorithm.
Host
Luna Logic
An intelligent and insightful AI co-host, designed with a logical, analytical mind, and a polished professional look. She brings strategic thinking and a clear, human-like touch to complex updates.