Campaign
v0.1.0A marketing campaign in the Marketing & Analytics (signals) domain. Models the outbound program a dealership or agency runs across channels (email, SMS, direct mail, paid/organic media, events, equity mining) together with its audience, schedule, budget, offers, creatives, UTM attribution, consent/compliance posture, attribution model, pacing, and rolled-up performance metrics. Complements ADF's lead <provider>/<vendor>/<source> attribution by naming the campaign that sourced a lead: a Lead's campaign_id references this entity, and the UTM block mirrors the utm_* parameters that AutomotiveAPI and most CRMs stamp onto web-sourced leads.
Resources
signals.get_campaignsignals.list_campaignscampaign.example.jsonJSON
{
"id": "8f3a2c1d-4b5e-6a7f-8091-a2b3c4d5e6f7",
"source_ids": [
{
"system": "mailchimp",
"id": "cmp_9x8y7z",
"sequence": 1
},
{
"system": "vinsolutions_crm",
"id": "CMP-2026-0612",
"sequence": 2
}
],
"external_ids": {
"esp_campaign_id": "cmp_9x8y7z",
"meta_campaign_id": "23851234567890123"
},
"dealer_id": "aa11bb22-cc33-dd44-ee55-ff6677889900",
"dealer_group_id": "bb22cc33-dd44-ee55-ff66-778899001122",
"account_id": "cc33dd44-ee55-ff66-7788-990011223344",
"name": "2026 June Certified SUV Conquest",
"description": "Conquest email + paid social push targeting in-market SUV shoppers within 25 miles who are not existing customers, featuring the CPO 1.9% APR offer.",
"type": "email",
"channels": [
"email",
"paid_social"
],
"status": "active",
"objective": "conquest",
"brand": "Toyota",
"models": [
"RAV4",
"Highlander",
"4Runner"
],
"vehicle_condition": "certified_pre_owned",
"co_op": {
"is_co_op": true,
"program": "Toyota Tier 3 Digital",
"claim_id": "T3-2026-0612-889",
"oem_match_rate": 50,
"reimbursable_amount": {
"amount": 7160.28,
"currency": "USD"
},
"approval_status": "submitted"
},
"audience": {
"segment_id": "1c2d3e4f-5a6b-7c8d-9e0f-1a2b3c4d5e6f",
"name": "In-market SUV shoppers, 25mi, non-customers",
"size": 18450,
"source": "cdp",
"match_type": "in_market",
"geo": {
"countries": [
"US"
],
"regions": [
"TX"
],
"dma_codes": [
"623"
],
"radius": {
"center_postal_code": "75201",
"distance": 25,
"unit": "miles"
}
},
"exclusions": [
"dd44ee55-ff66-7788-9900-112233445566"
],
"filters": [
{
"field": "vehicle_class",
"operator": "eq",
"value": "suv"
},
{
"field": "distance_miles",
"operator": "lte",
"value": 25
},
{
"field": "is_existing_customer",
"operator": "eq",
"value": false
},
{
"field": "in_market_score",
"operator": "gte",
"value": 70
}
]
},
"schedule": {
"start_at": "2026-06-01T13:00:00Z",
"end_at": "2026-06-30T04:59:59Z",
"timezone": "America/Chicago",
"send_at": "2026-06-01T13:00:00Z",
"frequency": "one_time",
"frequency_cap": {
"max_impressions": 3,
"period": "week"
}
},
"budget": {
"total": {
"amount": 25000,
"currency": "USD"
},
"spent": {
"amount": 14320.55,
"currency": "USD"
},
"remaining": {
"amount": 10679.45,
"currency": "USD"
},
"daily_cap": {
"amount": 1200,
"currency": "USD"
},
"pacing": "standard",
"budget_type": "lifetime"
},
"bid_strategy": "not_applicable",
"offers": [
{
"name": "CPO 1.9% APR for 60 months",
"description": "1.9% APR for 60 months on all Toyota Certified Used Vehicles for qualified buyers through Toyota Financial Services. Offer expires 06/30/2026.",
"offer_type": "apr_finance",
"apr": 1.9,
"term_months": 60,
"starts_at": "2026-06-01T05:00:00Z",
"expires_at": "2026-06-30T04:59:59Z",
"stackable": false,
"disclaimer": "Subject to credit approval through Toyota Financial Services. Not all buyers will qualify. See dealer for complete details."
},
{
"name": "$500 Conquest Cash",
"description": "$500 conquest bonus cash for shoppers currently in a competitive-make vehicle. Must present offer. Cannot be combined with employee pricing.",
"offer_type": "conquest_cash",
"cash_amount": {
"amount": 500,
"currency": "USD"
},
"expires_at": "2026-06-30T04:59:59Z",
"stackable": true
}
],
"creatives": [
{
"id": "2b3c4d5e-6f70-8192-a3b4-c5d6e7f80912",
"format": "html_email",
"name": "June CPO SUV hero email",
"headline": "Your Next Certified SUV Is Waiting — 1.9% APR",
"description_line": "40+ Toyota Certified SUVs in stock now.",
"call_to_action": "Shop Certified SUVs",
"body": "Explore 40+ Toyota Certified SUVs in stock. Every CPO comes with a 12-month/12,000-mile limited comprehensive warranty and a 160-point inspection.",
"url": "https://dealer.example.com/campaigns/june-cpo-suv",
"thumbnail_url": "https://cdn.example.com/creatives/2b3c4d5e/thumb.png",
"language": "en-US",
"status": "active"
},
{
"id": "3c4d5e6f-7081-82a3-b4c5-d6e7f8091223",
"format": "responsive_search_ad",
"headline": "Certified Toyota SUVs | 1.9% APR",
"call_to_action": "Get ePrice",
"url": "https://dealer.example.com/certified/suv",
"language": "en-US",
"status": "approved"
}
],
"utm": {
"source": "mailchimp",
"medium": "email",
"campaign": "2026_june_cpo_suv_conquest",
"term": "certified toyota suv",
"content": "hero_1p9apr",
"id": "8f3a2c1d"
},
"landing_page_url": "https://dealer.example.com/campaigns/june-cpo-suv",
"attribution": {
"model": "data_driven",
"click_through_window_days": 30,
"view_through_window_days": 1,
"conversion_definition": "form_submit OR phone_call over 60s OR ePrice request"
},
"compliance": {
"consent_basis": "express_written",
"regulations": [
"can_spam",
"tcpa",
"ccpa"
],
"suppression_list_applied": true,
"quiet_hours_enforced": true,
"unsubscribe_url": "https://dealer.example.com/unsubscribe?c=8f3a2c1d",
"physical_mailing_address": {
"city": "Dallas",
"region": "TX",
"postal_code": "75201",
"country": "US",
"lines": [
"1500 Auto Plaza Dr"
]
}
},
"metrics": {
"impressions": 96500,
"reach": 61200,
"sends": 18450,
"delivered": 18102,
"bounces": 348,
"opens": 7420,
"clicks": 1985,
"open_rate": 40.99,
"click_through_rate": 10.97,
"unsubscribes": 42,
"spam_complaints": 3,
"phone_calls": 61,
"form_submissions": 153,
"leads": 214,
"conversions": 176,
"conversion_rate": 8.87,
"cost_per_click": {
"amount": 7.21,
"currency": "USD"
},
"cost_per_lead": {
"amount": 66.92,
"currency": "USD"
},
"cost_per_acquisition": {
"amount": 622.63,
"currency": "USD"
},
"appointments_set": 88,
"appointments_shown": 61,
"test_drives": 44,
"attributed_sales": 23,
"attributed_revenue": {
"amount": 712400,
"currency": "USD"
},
"attributed_gross_profit": {
"amount": 78200,
"currency": "USD"
},
"return_on_ad_spend": 49.75,
"roi": 48.75,
"as_of": "2026-06-18T09:00:00Z"
},
"ab_test": {
"is_test": true,
"test_id": "4d5e6f70-8182-a3b4-c5d6-e7f809122334",
"variant": "B",
"is_control": false,
"hypothesis": "A payment-led subject line outperforms an APR-led subject line on click-through.",
"primary_metric": "click_through_rate",
"confidence_level": 95,
"traffic_allocation": 50
},
"tags": [
"q2",
"conquest",
"cpo",
"tier3"
],
"currency": "USD",
"created_at": "2026-05-20T16:42:00Z",
"updated_at": "2026-06-18T09:15:30Z",
"launched_at": "2026-06-01T13:00:00Z",
"created_by": "5e6f7081-82a3-b4c5-d6e7-f80912233445",
"updated_by": "6f708182-a3b4-c5d6-e7f8-091223344556",
"extensions": {
"acme.spend_pacing": "on_track",
"acme.attribution_model": "data_driven"
}
}Object shapes align with the AutomotiveAPI open data standard where sensible, and with the industry's ADF lead format — so a conformant server maps cleanly onto systems dealers already run.