Skip to content

Commit 96dc1d7

Browse files
authored
create annotations page (#2068)
* create annotations page and update meta/card * add annotations content * add annotation images * remove reference to Annotations from Insights
1 parent 1ab4585 commit 96dc1d7

File tree

10 files changed

+84
-15
lines changed

10 files changed

+84
-15
lines changed

pages/docs/features.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ import { Callout, Cards } from 'nextra/components'
88

99
<Cards>
1010
<Cards.Card icon title="Alerts" href="/docs/features/alerts" />
11+
<Cards.Card icon title="Annotations" href="/docs/features/annotations" />
1112
<Cards.Card icon title="Embeds" href="/docs/features/embeds" />
1213
<Cards.Card icon title="Chart Customization" href="/docs/features/chart-customization" />
1314
<Cards.Card icon title="Custom Buckets" href="/docs/features/custom-buckets" />

pages/docs/features/_meta.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
export default {
22
"alerts": "Alerts",
3+
"annotations": "Annotations",
34
"embeds": "Embeds",
45
"chart-customization": "Chart Customization",
56
"custom-buckets": "Custom Buckets",
Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
import { Steps, Callout } from 'nextra/components'
2+
3+
# Annotations
4+
5+
## Overview
6+
7+
Annotations add valuable context to your reports by linking notes to specific dates. Use them to highlight events such as product launches, marketing campaigns, or data anomalies, so viewers can clearly understand what influenced the metrics.
8+
9+
You can view Annotations directly on time-series charts and in the Annotations side-panel across all reports.
10+
11+
## Adding Annotations
12+
13+
<Steps>
14+
15+
{<h3>From a time-series Insights report, create Annotations from the bottom of the chart.</h3>}
16+
17+
Charts with time intervals (such as line, stacked line, column, and stacked column charts) are time-series charts and support Annotations.
18+
19+
Hover over the horizontal axis to locate the time interval, then click the “+” button to create an annotation for that point in time.
20+
21+
![annotations1](/annotations1.png)
22+
23+
{<h3>Alternatively, open the Annotations side panel to create an annotation.</h3>}
24+
25+
Select the **Annotations** tab (above the query builder) and click the “+” button to add a new annotation.
26+
27+
![annotations2](/annotations2.png)
28+
29+
{<h3>Select a date and time, then enter a description.</h3>}
30+
31+
Add one or more tags to categorize the annotation.
32+
33+
![annotations3](/annotations3.png)
34+
35+
<Callout type="info">
36+
Use tags consistently (e.g., Launches, Outages, Holidays, and even Team names) so it is easy to filter and spot patterns.
37+
</Callout>
38+
39+
</Steps>
40+
41+
## Viewing Annotations
42+
43+
Annotations appear as markers directly on the chart. Hover over a marker to view its details.
44+
45+
For example, in the chart below, you can see 1 annotation in March, 4 in May, and 2 in July.
46+
47+
![annotations4](/annotations4.png)
48+
49+
### Annotations Side-panel
50+
51+
Open the Annotations side panel (available in all reports) to view all annotations for your report's date range in one place. Select the **Annotations** tab (above the query builder) to open the side-panel.
52+
53+
From the side panel, you can:
54+
- **Browse** all annotations within your report's date range.
55+
- **Hide/Show** annotations
56+
- **Sort** by date
57+
- **Filter** Annotations by tags
58+
59+
![annotations5](/annotations5.png)
60+
61+
When you save a report, Mixpanel also saves your current annotation filters. The report will then display only the annotations that match your selected tag filters.
62+
63+
## Editing and Deleting Annotations
64+
65+
Hover over any existing annotations to see available actions. Click on the "pencil" button to edit the description and add/remove tags. Click the "trash" button to delete the annotation.
66+
67+
![annotations6](/annotations6.png)
68+
69+
<Callout type="warning">
70+
Annotations apply globally across the project. Any edits or deletions affect not only the current report but all reports in the project.
71+
</Callout>
72+
73+
## Collaboration and Visibility
74+
75+
- Anyone can create annotations and tags, and each annotation displays its creator.
76+
- Annotations are visible across all reports in the project.
77+
- Use tags and filters to control which annotations appear at the report level.

pages/docs/reports/insights.mdx

Lines changed: 5 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -56,19 +56,19 @@ Depending on the type of behavior selected, Insights will default to a different
5656

5757
![Choose Measurement](/choose-measurement.png)
5858

59-
You can save the metric you built and reuse them in other reports. Select the "..." button in the top right corner of the metric, then click "Save Metric". Note that saving a metric and saving a behavior is different; a saved behavior consists of the events/Funnels/Retention, while a saved metrics consists of the saved behavior and the measurements of the behavior.
59+
You can save the metric you built and reuse it in other reports. Select the "..." button in the top right corner of the metric, then click "Save Metric". Note that saving a metric and saving a behavior are different; a saved behavior consists of the events/Funnels/Retention, while a saved metric consists of the saved behavior and the measurements of the behavior.
6060

6161
Learn more about [Saved Metrics and Behaviors](/docs/features/saved-metrics-and-behaviors).
6262

6363
### Step 3: Choose Filters
6464

65-
Filters exclude unwanted data. In this case, we only care about events performed on the iOS platform. Therefore, add a "Operating System" filter, where OS equals "iOS". At this point, your query should look like this:
65+
Filters exclude unwanted data. In this case, we only care about events performed on the iOS platform. Therefore, add an "Operating System" filter, where OS equals "iOS". At this point, your query should look like this:
6666

6767
![Choose Filters](/choose-filters.png)
6868

6969
### Step 4: Choose Breakdowns
7070

71-
Breakdowns segment data into groups. In this case, we want to count sign ups based on users in different cities. Therefore, add a "City" breakdown. At this point, your query should look like this:
71+
Breakdowns segment data into groups. In this case, we want to count sign-ups based on users in different cities. Therefore, add a "City" breakdown. At this point, your query should look like this:
7272

7373
![Choose Breakdowns](/choose-breakdowns.png)
7474

@@ -303,19 +303,9 @@ Profile metrics allow you to access profile data and visualize your users with f
303303

304304
### Annotations
305305

306-
To clarify the results in your Insights report, add detailed annotations directly to the line chart. Annotations are tied to a specific date on the chart, rather than a specific data point on the chart.
306+
To clarify the results in your Insights report, add detailed annotations directly to your time-series charts (such as line, stacked line, column, and stacked columns charts). Annotations are tied to a specific date on the chart, rather than a particular point of data on the chart.
307307

308-
To add an annotation, hover your mouse over the point on the chart you want to annotate, and click the blue **+** button that appears. Enter a description for the annotation, such as a holiday that occurred on that day or the end date of your fiscal year, then click **Save**. If you accidentally selected the incorrect date on the chart, you can edit the date and time of the annotation in this window.
309-
310-
![Annotations 1](/advanced-annotations-1.png)
311-
312-
View an existing annotation by clicking on the number found at the bottom of a report. You will be able to see who submitted the annotation.
313-
314-
![Annotations 2](/advanced-annotations-2.png)
315-
316-
Hover the cursor over the annotation to edit or delete it. Click on the **pencil icon** to edit an annotation, or the **trash icon** to delete an annotation. Add additional annotations to the same date by clicking **Add annotation**.
317-
318-
![Annotations 3](/advanced-annotations-3.png)
308+
Learn more about [Annotations](/docs/features/annotations).
319309

320310
### Measurements
321311

public/annotations1.png

52.8 KB
Loading

public/annotations2.png

138 KB
Loading

public/annotations3.png

86.9 KB
Loading

public/annotations4.png

188 KB
Loading

public/annotations5.png

49.6 KB
Loading

public/annotations6.png

51.1 KB
Loading

0 commit comments

Comments
 (0)