A custom audience created from business data such as customer lists, website visitors, or app users for retargeting in advertising campaigns.

CustomAudience

A custom audience created from business data such as customer lists, website visitors, or app users for retargeting in advertising campaigns.

Properties

id (string): Unique identifier for the custom audience.
name (string): The name of the custom audience.
business ([[Business]]): The business that owns this custom audience.
platform (string): Platform (facebook, google, linkedin, twitter, tiktok).
audienceId (string): Platform-specific audience ID.
type (string): Audience type (customer-list, website-traffic, app-activity, engagement, offline-activity).
source (string): Data source (crm, pixel, sdk, offline-events, partner-integration).
status (string): Current status (ready, populating, too-small, error).
description (string): Audience description.
customerList (object): Customer list configuration (for customer list audiences).
pixel ([[Pixel]]): Pixel used for tracking (for website/app audiences).
websiteRules (object[]): Website rules (URL contains, visited pages, time on site).
appEvents (string[]): App events included (for app activity audiences).
engagementType (string): Engagement type (video, lead-form, instant-experience, facebook-page, instagram-account).
retentionDays (number): Data retention period in days (1-180).
size (number): Approximate audience size.
minimumSize (number): Minimum size required for activation.
dataUploadMethod (string): Upload method (api, csv, tag, connector).
matchingRate (number): Match rate as a decimal.
matchedUsers (number): Number of matched users.
uploadedRecords (number): Number of uploaded records.
campaigns ([[Campaign]][]): Campaigns using this audience.
ads ([[Ad]][]): Ads targeting this audience.
lookalikeAudiences ([[LookalikeAudience]][]): Lookalike audiences created from this.
exclusions ([[Audience]][]): Audiences to exclude.
lastUpdated (string): Last update timestamp (ISO 8601 format).
autoUpdate (boolean): Whether audience auto-updates.
updateFrequency (string): Update frequency (daily, weekly, real-time).
gdprCompliant (boolean): Whether GDPR compliant.
consentCollected (boolean): Whether user consent collected.
tags (string[]): Tags for categorizing.
createdAt (string): Creation timestamp (ISO 8601 format).
updatedAt (string): Last update timestamp (ISO 8601 format).
metadata (object): Additional information.