Skip to content

Commit c218606

Browse files
samueljlieberksc-odoo
authored andcommitted
[IMP] marketing: RST upgrades for metrics doc
closes #5399 X-original-commit: 6f02a0a Signed-off-by: Zachary Straub (zst) <zst@odoo.com> Signed-off-by: Kevin Scannell (ksc) <ksc@odoo.com>
1 parent 111501b commit c218606

File tree

1 file changed

+47
-40
lines changed

1 file changed

+47
-40
lines changed

content/applications/marketing/marketing_automation/advanced/understanding_metrics.rst

Lines changed: 47 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -2,79 +2,86 @@
22
Understanding metrics
33
=====================
44

5-
Metrics are detailed statistics that measure the progress (and success) of marketing campaigns.
6-
When creating marketing activities in a workflow, Odoo will visually display various metrics
7-
related to the campaign with graphs and data.
5+
Metrics are detailed statistics that measure the progress and success of marketing campaigns. When
6+
creating marketing activities in a workflow, Odoo visually displays various metrics related to the
7+
campaign with detailed graphs and in-depth data.
88

9-
Consider the following example:
9+
.. example::
10+
A typical line graph in a marketing automation workflow showcasing the success rate of an email.
1011

11-
.. image:: understanding_metrics/commercial-prospection-campaign-example.png
12-
:align: center
13-
:alt: An example of a marketing automation campaign in Odoo.
12+
.. image:: understanding_metrics/commercial-prospection-campaign-example.png
13+
:align: center
14+
:alt: An example of a marketing automation campaign in Odoo.
1415

15-
In this case, the :guilabel:`Target` of this campaign is set to :guilabel:`Lead/Opportunity` and
16-
was narrowed down to only focus on the Leads (or Opportunities) whose :guilabel:`Tag Name` contain
17-
a value of `product` and they *also* have an email address set up in the database.
16+
In this case, the :guilabel:`Target` of this campaign is set to :guilabel:`Lead/Opportunity`, and
17+
was narrowed down to *only* focus on the leads (or opportunities) whose :guilabel:`Tag Name`
18+
contains a value of `product` — and *also* have an email address set up in the database.
1819

19-
Beneath the filter nodes, Odoo will display how many records in the database fall into the
20-
previously-specified criteria filter. In this example, there are 18 records in the database that
21-
match the criteria.
20+
Beneath the filter nodes, Odoo displays how many records in the database fall into the
21+
previously-specified criteria filter.
2222

23-
.. image:: understanding_metrics/marketing-automation-lead-filters.png
24-
:align: center
25-
:alt: Lead generation filters used to refine records on marketing automation campaigns in Odoo.
23+
.. example::
24+
Below, there are 18 records in the database that match the criteria.
2625

27-
At the top of the marketing automation form, there are a series of smart buttons. The
26+
.. image:: understanding_metrics/marketing-automation-lead-filters.png
27+
:align: center
28+
:alt: Lead generation filters used to refine records on automation campaigns in Odoo.
29+
30+
At the top of the marketing automation campaign form, there are a series of smart buttons. The
2831
:guilabel:`Participations` smart button in this example indicates that, out of those 18 records, 25
2932
have become participants. In other words, they have matched the criteria, and have already
3033
interacted with the campaign in one way or another.
3134

3235
.. note::
3336
:guilabel:`Records` represent a real-time number. Therefore, while the workflow is running,
34-
changes in opportunity records (deletions, additions, adjustments) may occur. This means there
35-
will be real-time updates to the number of :guilabel:`Records`, but such updates do *not* change
36-
the number of :guilabel:`Participants`, as the metric *will not* exclude opportunities that have
37-
already been set as :guilabel:`Participants` before - Odoo will just add new ones. That's why
38-
the number of :guilabel:`Records` can be different from the number of :guilabel:`Participants`
39-
from time to time.
37+
changes in opportunity records (deletions, additions, or adjustments) may occur.
38+
39+
This means there will be real-time updates to the number of :guilabel:`Records`, but such updates
40+
do *not* change the number of :guilabel:`Participants`, as the metric *will not* exclude
41+
opportunities that have already been set as :guilabel:`Participants` before — Odoo just adds new
42+
ones.
43+
44+
That's why the number of :guilabel:`Records` can be different from the number of
45+
:guilabel:`Participants` from time to time.
4046

4147
.. image:: understanding_metrics/campaign-records-vs-participants.png
4248
:align: center
4349
:alt: Difference between real-time record count and total participants on a markeing campaign.
4450

4551
Whenever the system runs, updating numbers and triggering actions, it will look at the
46-
:guilabel:`Target` model, and check if new :guilabel:`Records` have been added (or modified),
47-
which always keeps the flow up-to-date.
52+
:guilabel:`Target` model, and check if new :guilabel:`Records` have been added (or modified), which
53+
always keeps the flow up-to-date.
4854

4955
.. note::
50-
The filter here is applied to *all* activities. Leads that lose that specific :guilabel:`Tag`
51-
in the meantime will be excluded from later activities.
56+
The :guilabel:`Filter` here is applied to *all* activities. Leads that lose that specific tag
57+
(`product`) in the meantime will be excluded from later activities.
5258

5359
.. tip::
5460
Filters can also be applied to individual activities, in the :guilabel:`Domain` section of the
55-
activity pop-up form. Use this feature to specify an individual filter that will only be
56-
performed if the records satisfy *both* filter criteria - the activity filter and its specific
57-
domain filter.
61+
:guilabel:`Activity` pop-up form. Use this feature to specify an individual filter that will
62+
*only* be performed if the records satisfy *both* filter criteria the activity filter and its
63+
specific domain filter.
5864

59-
(*Example*: when configuring an SMS activity, make sure a certain phone number is set,
60-
in order to avoid triggering a SMS that would never be sent.)
65+
.. example::
66+
When configuring an SMS activity, make sure a certain phone number is set, in order to avoid
67+
triggering a SMS that would never be sent.
6168

6269
.. image:: understanding_metrics/individual-filter-to-activity.png
6370
:align: center
6471
:alt: A relevant targeting filter that applies to a type of individual activity.
6572

66-
:guilabel:`Success` represents the number of times the searching for participants - who match the
67-
criteria filter(s) of that activity - was performed successfully, in relation to the total number
68-
of participants. If a participant does *not* match the conditions, it will be added to
69-
:guilabel:`Rejected`.
73+
:guilabel:`Success` represents the number of times that the searching for participants who match
74+
the criteria filter(s) of that activity was performed successfully, in relation to the total
75+
number of participants. If a participant does *not* match the conditions, it will be added to the
76+
:guilabel:`Rejected` number.
7077

7178
.. image:: understanding_metrics/participant-matching-success-vs-rejected.png
7279
:align: center
7380
:alt: Overview showing participants who do or do not match filtering criteria on an activity.
7481

75-
Hovering over the graph, Odoo displays the number of successful and rejected participants, per day,
76-
over the last 15 days.
82+
Hovering over the graph on an automation activity block, Odoo displays the number of successful and
83+
rejected participants, per day, over the last 15 days.
7784

7885
.. note::
79-
Whenever a new record is added to the :guilabel:`Target` model, it will automatically be added
80-
to the workflow, and it will start the workflow from the beginning (:guilabel:`Parent Action`).
86+
Whenever a new record is added to the :guilabel:`Target` model, it's automatically added to the
87+
workflow, and it will start the workflow from the beginning (:guilabel:`Parent Action`).

0 commit comments

Comments
 (0)