[IMP] marketing: RST upgrades for metrics doc

closes odoo/documentation#5406

X-original-commit: 6f02a0af04
Signed-off-by: Zachary Straub (zst) <zst@odoo.com>
Signed-off-by: Kevin Scannell (ksc) <ksc@odoo.com>
This commit is contained in:
Sam Lieber (sali) 2023-05-04 14:08:10 +00:00 committed by KC (ksc)
parent 6731fb0320
commit 58b538c2b1

View File

@ -2,79 +2,86 @@
Understanding metrics Understanding metrics
===================== =====================
Metrics are detailed statistics that measure the progress (and success) of marketing campaigns. Metrics are detailed statistics that measure the progress and success of marketing campaigns. When
When creating marketing activities in a workflow, Odoo will visually display various metrics creating marketing activities in a workflow, Odoo visually displays various metrics related to the
related to the campaign with graphs and data. campaign with detailed graphs and in-depth data.
Consider the following example: .. example::
A typical line graph in a marketing automation workflow showcasing the success rate of an email.
.. image:: understanding_metrics/commercial-prospection-campaign-example.png .. image:: understanding_metrics/commercial-prospection-campaign-example.png
:align: center :align: center
:alt: An example of a marketing automation campaign in Odoo. :alt: An example of a marketing automation campaign in Odoo.
In this case, the :guilabel:`Target` of this campaign is set to :guilabel:`Lead/Opportunity` and In this case, the :guilabel:`Target` of this campaign is set to :guilabel:`Lead/Opportunity`, and
was narrowed down to only focus on the Leads (or Opportunities) whose :guilabel:`Tag Name` contain was narrowed down to *only* focus on the leads (or opportunities) whose :guilabel:`Tag Name`
a value of `product` and they *also* have an email address set up in the database. contains a value of `product` and *also* have an email address set up in the database.
Beneath the filter nodes, Odoo will display how many records in the database fall into the Beneath the filter nodes, Odoo displays how many records in the database fall into the
previously-specified criteria filter. In this example, there are 18 records in the database that previously-specified criteria filter.
match the criteria.
.. image:: understanding_metrics/marketing-automation-lead-filters.png .. example::
Below, there are 18 records in the database that match the criteria.
.. image:: understanding_metrics/marketing-automation-lead-filters.png
:align: center :align: center
:alt: Lead generation filters used to refine records on marketing automation campaigns in Odoo. :alt: Lead generation filters used to refine records on automation campaigns in Odoo.
At the top of the marketing automation form, there are a series of smart buttons. The At the top of the marketing automation campaign form, there are a series of smart buttons. The
:guilabel:`Participations` smart button in this example indicates that, out of those 18 records, 25 :guilabel:`Participations` smart button in this example indicates that, out of those 18 records, 25
have become participants. In other words, they have matched the criteria, and have already have become participants. In other words, they have matched the criteria, and have already
interacted with the campaign in one way or another. interacted with the campaign in one way or another.
.. note:: .. note::
:guilabel:`Records` represent a real-time number. Therefore, while the workflow is running, :guilabel:`Records` represent a real-time number. Therefore, while the workflow is running,
changes in opportunity records (deletions, additions, adjustments) may occur. This means there changes in opportunity records (deletions, additions, or adjustments) may occur.
will be real-time updates to the number of :guilabel:`Records`, but such updates do *not* change
the number of :guilabel:`Participants`, as the metric *will not* exclude opportunities that have This means there will be real-time updates to the number of :guilabel:`Records`, but such updates
already been set as :guilabel:`Participants` before - Odoo will just add new ones. That's why do *not* change the number of :guilabel:`Participants`, as the metric *will not* exclude
the number of :guilabel:`Records` can be different from the number of :guilabel:`Participants` opportunities that have already been set as :guilabel:`Participants` before — Odoo just adds new
from time to time. ones.
That's why the number of :guilabel:`Records` can be different from the number of
:guilabel:`Participants` from time to time.
.. image:: understanding_metrics/campaign-records-vs-participants.png .. image:: understanding_metrics/campaign-records-vs-participants.png
:align: center :align: center
:alt: Difference between real-time record count and total participants on a markeing campaign. :alt: Difference between real-time record count and total participants on a markeing campaign.
Whenever the system runs, updating numbers and triggering actions, it will look at the Whenever the system runs, updating numbers and triggering actions, it will look at the
:guilabel:`Target` model, and check if new :guilabel:`Records` have been added (or modified), :guilabel:`Target` model, and check if new :guilabel:`Records` have been added (or modified), which
which always keeps the flow up-to-date. always keeps the flow up-to-date.
.. note:: .. note::
The filter here is applied to *all* activities. Leads that lose that specific :guilabel:`Tag` The :guilabel:`Filter` here is applied to *all* activities. Leads that lose that specific tag
in the meantime will be excluded from later activities. (`product`) in the meantime will be excluded from later activities.
.. tip:: .. tip::
Filters can also be applied to individual activities, in the :guilabel:`Domain` section of the Filters can also be applied to individual activities, in the :guilabel:`Domain` section of the
activity pop-up form. Use this feature to specify an individual filter that will only be :guilabel:`Activity` pop-up form. Use this feature to specify an individual filter that will
performed if the records satisfy *both* filter criteria - the activity filter and its specific *only* be performed if the records satisfy *both* filter criteria — the activity filter and its
domain filter. specific domain filter.
(*Example*: when configuring an SMS activity, make sure a certain phone number is set, .. example::
in order to avoid triggering a SMS that would never be sent.) When configuring an SMS activity, make sure a certain phone number is set, in order to avoid
triggering a SMS that would never be sent.
.. image:: understanding_metrics/individual-filter-to-activity.png .. image:: understanding_metrics/individual-filter-to-activity.png
:align: center :align: center
:alt: A relevant targeting filter that applies to a type of individual activity. :alt: A relevant targeting filter that applies to a type of individual activity.
:guilabel:`Success` represents the number of times the searching for participants - who match the :guilabel:`Success` represents the number of times that the searching for participants — who match
criteria filter(s) of that activity - was performed successfully, in relation to the total number the criteria filter(s) of that activity — was performed successfully, in relation to the total
of participants. If a participant does *not* match the conditions, it will be added to number of participants. If a participant does *not* match the conditions, it will be added to the
:guilabel:`Rejected`. :guilabel:`Rejected` number.
.. image:: understanding_metrics/participant-matching-success-vs-rejected.png .. image:: understanding_metrics/participant-matching-success-vs-rejected.png
:align: center :align: center
:alt: Overview showing participants who do or do not match filtering criteria on an activity. :alt: Overview showing participants who do or do not match filtering criteria on an activity.
Hovering over the graph, Odoo displays the number of successful and rejected participants, per day, Hovering over the graph on an automation activity block, Odoo displays the number of successful and
over the last 15 days. rejected participants, per day, over the last 15 days.
.. note:: .. note::
Whenever a new record is added to the :guilabel:`Target` model, it will automatically be added Whenever a new record is added to the :guilabel:`Target` model, it's automatically added to the
to the workflow, and it will start the workflow from the beginning (:guilabel:`Parent Action`). workflow, and it will start the workflow from the beginning (:guilabel:`Parent Action`).