Anotações

Assinale uma data na linha temporal do projeto (o lançamento de uma campanha, uma migração do site, um redesenho) para que um gráfico mostre o que aconteceu e quando. Disponível em todos os planos.

POST`/annotations`

Assinala uma data nas séries temporais do projeto com um título e uma descrição. Disponível em todos os planos.

Corpo (JSON):

project_idobrigatório
titleobrigatório
annotation_dateopcional, ISO YYYY-MM-DD; predefinido hoje
descriptionopcional
coloropcional, hexadecimal
annotation_category_idopcional, tem de pertencer ao projeto

GET /annotations + PATCH/DELETE /annotations/:id

Lista, atualiza e elimina anotações em todos os planos. O GET devolve anotações manuais, automáticas, de testes GEO e da plataforma, da mais recente para a mais antiga. O campo origin distingue-as, e editable indica se o utilizador que fez o pedido pode modificar uma linha. O PATCH e o DELETE só funcionam em anotações manuais pertencentes ao próprio utilizador (caso contrário, 403).

Consulta GET: project_id (obrigatório), from/to (YYYY-MM-DD), annotation_category_id, page, per_page. Corpo do PATCH: qualquer um de title, description, annotation_date, color, annotation_category_id. DELETE: project_id + :id no URL.

Exemplos de código

Download: OpenAPI Swagger Postman

Perguntar à IA: Abrir no ChatGPT Abrir no Claude Ver como Markdown

Linguagem

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());

Anotações

POST/annotations

GET /annotations + PATCH/DELETE /annotations/:id

POST`/annotations`