Odoo 19.0 Community · Persistent

utm.campaign: fields, relations and API

The utm.campaign model ("UTM Campaign") is a persistent model declared by the UTM Trackers module, then extended by 10 other modules. It exposes 37 fields, 31 of them declared directly on the model; 14 fields from other models point to it. Below you will find every field with its technical name, type, label and relations, followed by an Odoo 19 JSON-2 API call.

View source code Search another model

Model identity

Technical name: utm.campaign
Label: UTM Campaign
Type: Persistent (models.Model)
SQL table: utm_campaign
Origin module: UTM Trackers (utm)
Extended by: crm, sale, hr_recruitment, link_tracker, mass_mailing, mass_mailing_crm, mass_mailing_sms, mass_mailing_crm_sms, mass_mailing_sale, mass_mailing_sale_sms
Display field (_rec_name): title

Model fields

31 own fields, 0 inherited from mixins and 6 automatic ORM fields. Click a name to get a direct link to that field.

Hide inherited fields

37 of 37 fields shown

Technical name	Label	Type	Details
ab_testing_completed	A/B Testing Campaign Finished	`boolean`	read-onlycomputed, stored added by Email Marketing (`mass_mailing`)
ab_testing_mailings_count	A/B Test Mailings #	`integer`	computed added by Email Marketing (`mass_mailing`)
ab_testing_mailings_sms_count	A/B Test Mailings SMS #	`integer`	computed added by SMS Marketing (`mass_mailing_sms`)
ab_testing_schedule_datetime	Send Final On Date that will be used to know when to determine and send the winner mailing	`datetime`	added by Email Marketing (`mass_mailing`)
ab_testing_sms_winner_selection	SMS Winner Selection	`selection`	Values: `manual` (Manual), `clicks_ratio` (Highest Click Rate) added by SMS Marketing (`mass_mailing_sms`)
ab_testing_winner_mailing_id	A/B Campaign Winner Mailing	`many2one` → mailing.mailing	added by Email Marketing (`mass_mailing`)
ab_testing_winner_selection	Winner Selection Selection to determine the winner mailing that will be sent.	`selection`	Values: `manual` (Manual), `opened_ratio` (Highest Open Rate), `clicks_ratio` (Highest Click Rate), `replied_ratio` (Highest Reply Rate) added by Email Marketing (`mass_mailing`)
active	Active	`boolean`
bounced_ratio	Bounced Ratio	`float`	computed added by Email Marketing (`mass_mailing`)
click_count	Number of clicks generated by the campaign	`integer`	computed added by Link Tracker (`link_tracker`)
color	Color Index	`integer`
company_id	Company	`many2one` → res.company	added by Sales (`sale`)
crm_lead_count	Leads/Opportunities count	`integer`	computed added by CRM (`crm`)
currency_id	Currency	`many2one` → res.currency	related: `company_id.currency_id` added by Sales (`sale`)
invoiced_amount	Revenues generated by the campaign	`integer`	computed added by Sales (`sale`)
is_auto_campaign	Automatically Generated Campaign Allows us to filter relevant Campaigns	`boolean`
is_mailing_campaign_activated	Is Mailing Campaign Activated	`boolean`	computed added by Email Marketing (`mass_mailing`)
mailing_mail_count	Number of Mass Mailing	`integer`	computed added by Email Marketing (`mass_mailing`)
mailing_mail_ids	Mass Mailings	`one2many` → mailing.mailing	inverse: `campaign_id` added by Email Marketing (`mass_mailing`)
mailing_sms_count	Number of Mass SMS	`integer`	computed added by SMS Marketing (`mass_mailing_sms`)
mailing_sms_ids	Mass SMS	`one2many` → mailing.mailing	inverse: `campaign_id` added by SMS Marketing (`mass_mailing_sms`)
name	Campaign Identifier	`char`	requiredcomputed, stored
opened_ratio	Opened Ratio	`float`	computed added by Email Marketing (`mass_mailing`)
quotation_count	Quotation Count	`integer`	computed added by Sales (`sale`)
received_ratio	Received Ratio	`float`	computed added by Email Marketing (`mass_mailing`)
replied_ratio	Replied Ratio	`float`	computed added by Email Marketing (`mass_mailing`)
stage_id	Stage	`many2one` → utm.stage	required
tag_ids	Tags	`many2many` → utm.tag
title	Campaign Name	`char`	requiredtranslatable
use_leads	Use Leads	`boolean`	computed added by CRM (`crm`)
user_id	Responsible	`many2one` → res.users	required
create_date	Created on	`datetime`	read-onlyautomatic
create_uid	Created by	`many2one` → res.users	read-onlyautomatic
display_name	Display Name	`char`	read-onlycomputedautomatic
id	ID	`integer`	read-onlyautomatic
write_date	Last Updated on	`datetime`	read-onlyautomatic
write_uid	Last Updated by	`many2one` → res.users	read-onlyautomatic

Relations

Models linked from this model

mailing.mailing: ab_testing_winner_mailing_id, mailing_mail_ids, mailing_sms_ids
res.company: company_id
res.currency: currency_id
res.users: user_id
utm.stage: stage_id
utm.tag: tag_ids

Fields of other models pointing here

account.move: campaign_id
crm.lead: campaign_id
event.registration: utm_campaign_id
hr.applicant: campaign_id
hr.recruitment.source: campaign_id
link.tracker: campaign_id
link.tracker.click: campaign_id
mail.compose.message: campaign_id
mailing.mailing: campaign_id
mailing.trace: campaign_id
sale.order: campaign_id
sale.report: campaign_id
sms.composer: utm_campaign_id
utm.mixin: campaign_id

Reading this model through the API

Odoo 19 JSON-2 API call reading the first five records with real fields of the model. Replace the instance, database and API key with your own.

curl

curl -X POST "https://your-instance.odoo.com/json/2/utm.campaign/search_read" \
  -H "Authorization: bearer $ODOO_API_KEY" \
  -H "X-Odoo-Database: your-db" \
  -H "Content-Type: application/json" \
  -d '{"domain":[],"fields":["title","name","stage_id","user_id","ab_testing_winner_mailing_id"],"limit":5}'

Python (requests)

import requests

BASE_URL = "https://your-instance.odoo.com/json/2"
headers = {"Authorization": f"bearer {API_KEY}", "X-Odoo-Database": "your-db"}

res = requests.post(
    f"{BASE_URL}/utm.campaign/search_read",
    headers=headers,
    json={"domain": [], "fields": ["title","name","stage_id","user_id","ab_testing_winner_mailing_id"], "limit": 5},
)
res.raise_for_status()
print(res.json())

External API access requires Odoo's Custom plan.
XML-RPC and JSON-RPC will be removed in Odoo 22 (fall 2028): use JSON-2.
The access rights and record rules of the key's user apply.

Cite this tool

Writing a tutorial, internal documentation or a forum answer? Copy this link to send your readers to the up-to-date reference.

<a href="https://aidoo.ai/en/outils/explorateur-modeles-odoo/utm-campaign">utm.campaign (Odoo 19.0)</a>

Sources

Data verified on September 23, 2026 · Odoo 19.0 Community

Have an Odoo project, or want to put your ERP to work with AI? Let's talk

Implementation, custom module development, connecting Claude or ChatGPT to your data: tell us about your context and we will reply within 24 business hours.