Annotations
Mark a date on the project timeline (a campaign launch, a site migration, a redesign) so a chart shows what happened when. Available on every plan.
POST/annotations
Mark a date in the project timeseries with a title + description. Available on every plan.
Body (JSON):
project_idrequiredtitlerequiredannotation_dateoptional ISO YYYY-MM-DD; default todaydescriptionoptionalcoloroptional hexannotation_category_idoptional, must belong to the project
GET /annotations + PATCH/DELETE /annotations/:id
List, update, and delete annotations on every plan. GET returns manual, automatic, and platform annotations newest first. The origin field distinguishes them, and editable says whether the requesting user may modify a row. PATCH and DELETE only work on manual annotations belonging to your own user (403 otherwise).
- GET query:
project_id(required),from/to(YYYY-MM-DD),annotation_category_id,page,per_page. PATCH body: any oftitle,description,annotation_date,color,annotation_category_id. DELETE:project_id+:idin URL.