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_idrequired
titlerequired
annotation_dateoptional ISO YYYY-MM-DD; default today
descriptionoptional
coloroptional hex
annotation_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, GEO test, 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 of title, description, annotation_date, color, annotation_category_id. DELETE: project_id + :id in URL.

Code Examples

Download: OpenAPI Swagger Postman

Ask AI: Open in ChatGPT Open in Claude View as Markdown

Language

Request

curl -X POST -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d '{"project_id":"PROJECT_ID","title":"Launched pricing campaign","annotation_date":"2026-06-01","color":"#2563eb"}' \
  "https://api.llmpulse.ai/api/v1/annotations"

const response = await fetch("https://api.llmpulse.ai/api/v1/annotations", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({"project_id":"PROJECT_ID","title":"Launched pricing campaign","annotation_date":"2026-06-01","color":"#2563eb"})
});
const data = await response.json();

import requests

response = requests.post(
    "https://api.llmpulse.ai/api/v1/annotations",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    json={"project_id":"PROJECT_ID","title":"Launched pricing campaign","annotation_date":"2026-06-01","color":"#2563eb"}
)
data = response.json()

require 'httparty'

response = HTTParty.post(
  "https://api.llmpulse.ai/api/v1/annotations",
  headers: { "Authorization" => "Bearer YOUR_API_KEY" },
  body: {"project_id":"PROJECT_ID","title":"Launched pricing campaign","annotation_date":"2026-06-01","color":"#2563eb"}
)
data = response.parsed_response

req, _ := http.NewRequest("POST", "https://api.llmpulse.ai/api/v1/annotations", strings.NewReader(`{"project_id":"PROJECT_ID","title":"Launched pricing campaign","annotation_date":"2026-06-01","color":"#2563eb"}`))
req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
req.Header.Set("Content-Type", "application/json")
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()

$client = new GuzzleHttp\Client();
$response = $client->request('POST', 'https://api.llmpulse.ai/api/v1/annotations', [
    'headers' => ['Authorization' => 'Bearer YOUR_API_KEY'],
    'json' => {"project_id":"PROJECT_ID","title":"Launched pricing campaign","annotation_date":"2026-06-01","color":"#2563eb"}
]);
$data = json_decode($response->getBody(), true);

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.llmpulse.ai/api/v1/annotations"))
    .header("Authorization", "Bearer YOUR_API_KEY")
    .header("Content-Type", "application/json")
    .POST(HttpRequest.BodyPublishers.ofString("{\"project_id\":\"PROJECT_ID\",\"title\":\"Launched pricing campaign\",\"annotation_date\":\"2026-06-01\",\"color\":\"#2563eb\"}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());