mirror of
https://github.com/BillyOutlast/posthog.com.git
synced 2026-02-05 20:01:20 +01:00
6b24ea10a1
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com> Co-authored-by: Ian Vanagas <34755028+ivanagas@users.noreply.github.com>
46 lines
2.4 KiB
Plaintext
46 lines
2.4 KiB
Plaintext
---
|
|
title: Annotations
|
|
sidebar: Docs
|
|
showTitle: true
|
|
availability:
|
|
free: full
|
|
selfServe: full
|
|
enterprise: full
|
|
---
|
|
import {ProductScreenshot} from 'components/ProductScreenshot'
|
|
export const annotationLight = "https://res.cloudinary.com/dmukukwp6/image/upload/posthog.com/contents/images/features/annotations/annotation-hn-light-mode.png"
|
|
export const annotationDark = "https://res.cloudinary.com/dmukukwp6/image/upload/posthog.com/contents/images/features/annotations/annotation-hn-dark-mode.png"
|
|
import {ProductVideo} from 'components/ProductVideo'
|
|
export const createAnnotationLight = "https://res.cloudinary.com/dmukukwp6/video/upload/posthog.com/contents/images/features/annotations/create-annotation-light-mode.mp4"
|
|
export const createAnnotationDark = "https://res.cloudinary.com/dmukukwp6/video/upload/posthog.com/contents/images/features/annotations/create-annotation-dark-mode.mp4"
|
|
|
|
Annotations enable you to add written notes to a particular day or time on all your insights and dashboards so you can see how changes or incidents impact your metrics.
|
|
|
|
You can use annotations to mark things like feature updates, version releases, and marketing campaigns, which adds helpful context when you're looking into what might have caused a change in your metrics.
|
|
|
|
## Why Annotations are useful
|
|
|
|
The chart below shows a large spike in website traffic, which has been annotated to explain why that spike occurs. Annotations can be viewed by hovering over them.
|
|
|
|
<ProductScreenshot
|
|
imageLight={annotationLight}
|
|
imageDark={annotationDark}
|
|
alt="PostHog Annotations"
|
|
classes="rounded"
|
|
/>
|
|
|
|
Annotations can be written _after_ the fact, which makes them useful for future reference, or _before_ an event if you want to analyze the future impact of a particular marketing initiative, for example.
|
|
|
|
## Creating an Annotation
|
|
|
|
When editing a chart in Trends, Sessions or in a Dashboard, hover your cursor over the dates at the bottom of the chart to reveal a button with a `+` symbol. Clicking it will then open up a modal where you can create your Annotation, as well as choose to have it specifically for the current chart or all of your charts.
|
|
|
|
With your annotation created, it will now be available at the bottom of your chart, and you can also view all of your existing annotations in `/data-management/annotations`.
|
|
|
|
<ProductVideo
|
|
videoLight={createAnnotationLight}
|
|
videoDark={createAnnotationDark}
|
|
alt="How to create an annotation in PostHog"
|
|
classes="rounded"
|
|
/>
|