Criar anotação no Baremetrics, por uma API

Adiciona uma anotação aos gráficos em uma data, como um lançamento ou uma campanha, e a retorna com seu id. Os cinco campos são obrigatórios.

Identificador
baremetrics_create_annotation

A chamada

POST https://connect.reportei.com/api/tools/baremetrics_create_annotation/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "metric": "<metric>",
    "annotation": "<annotation>",
    "date": "<date>",
    "global": true,
    "user_id": "<user_id>"
  }
}

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âmetroTipoObrigatórioDescrição
metricstringSimName of the metric whose chart shows the annotation, for example mrr.
annotationstringSimText of the annotation.
datestringSimDay of the annotation, YYYY-MM-DD.
globalbooleanSimtrue shows the annotation on every chart, not only on the chart of metric.
user_idstringSimId of the Baremetrics user recorded as the author, from List users.

Conexões possíveis

O seu cliente conecta a conta do Baremetrics 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.

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/baremetrics_create_annotation. Ele vira a definição de tool do seu agente sem conversão.

Outras tools do Baremetrics

Ver as 12 tools

Toolkits da mesma categoria

Ver os 100 toolkits

Veja o Connect aplicado ao seu produto.

Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.