Criar anotação no PostHog, por uma API
Cria uma anotação, uma nota exibida nos gráficos em um momento, como o lançamento de uma campanha. Por padrão aparece em todos os gráficos do projeto.
- Identificador
- posthog_create_annotation
A chamada
POST https://connect.reportei.com/api/tools/posthog_create_annotation/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"project_id": "<project_id>",
"content": "<content>",
"date_marker": "<date_marker>"
}
}Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.
Parâmetros
As descrições dos parâmetros seguem a documentação oficial do app, em inglês.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| project_id | string | Sim | Id of the project: the project_id of a team in List organizations, or the number after /project/ in the URL of PostHog. |
| content | string | Sim | Text shown on the charts. |
| date_marker | string | Sim | Moment of the annotation, for example 2026-10-01T09:00:00Z. |
| scope | string | Não | Where the annotation shows: project, every project of the organization, one dashboard (dashboard_id) or one insight (dashboard_item).Valores: project, organization, dashboard, dashboard_item |
| dashboard_id | integer | Não | With scope dashboard, the id of the dashboard, from List dashboards. |
| dashboard_item | integer | Não | With scope dashboard_item, the numeric id of the insight, from List insights. |
Conexões possíveis
O seu cliente conecta a conta do PostHog uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.
Chave de API
O cliente cola a chave do app numa tela do Connect, ou o seu sistema envia a chave por POST /api/customer-toolkits, sem tela.
Na conexão, o cliente informa também {region}: o endereço da conta dele na API do app.
A resposta
Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.
Pronta para agentes de IA
O input desta tool é um JSON Schema, disponível em GET /api/tools/posthog_create_annotation. Ele vira a definição de tool do seu agente sem conversão.
Outras tools do PostHog
- Listar organizaçõesGETLista as organizações que a chave alcança, cada uma com seus projetos em teams. O project_id de cada team é o que as outras ferramentas pedem. Pagine com limit e offset.
- Listar definições de eventosGETLista os eventos rastreados no projeto com nome, descrição, tags e last_seen_at, para usar em queries e anotações. Pagine com limit e offset.
- Executar queryPOSTExecuta uma query de analytics ad hoc e retorna seus resultados, até 100 linhas a menos que o SQL defina um LIMIT. Não é uma exportação: o PostHog recusa OFFSET, limita cada projeto a 3 queries ao mesmo tempo e debita cada query de um orçamento de leitura por hora.
- Listar insightsGETLista os insights do projeto com id, short_id, nome, descrição e query. A menos que basic seja true, cada um também traz seu resultado em cache. Pagine com limit e offset.
- Obter insightGETRetorna um insight com sua query e resultado. Por padrão o resultado vem do cache, e refresh com blocking o calcula de novo quando está desatualizado.
- Listar dashboardsGETLista os dashboards do projeto com id, nome, descrição, pinned e tags. Pagine com limit e offset.
- Obter dashboardGETRetorna um dashboard com seus filtros e tiles, cada tile com seu insight e o resultado em cache.
- Listar pessoasGETLista as pessoas do projeto com seus distinct_ids e propriedades. search as encontra por email, nome, id da pessoa ou distinct id. Pagine com limit e offset.
Veja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
