Crear anotación en Baremetrics, con una API

Agrega una anotación a los gráficos en una fecha, como un lanzamiento o una campaña, y la devuelve con su id. Los cinco campos son obligatorios.

Identificador
baremetrics_create_annotation

La llamada

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>"
  }
}

Tu sistema envía el id de la conexión de tu cliente y los argumentos de la tool. Los headers son los mismos de toda la API de Connect: el token de tu producto y el token de tu cliente.

Parámetros

Las descripciones de los parámetros siguen la documentación oficial de la app, en inglés.

ParámetroTipoObligatorioDescripción
metricstringSíName of the metric whose chart shows the annotation, for example mrr.
annotationstringSíText of the annotation.
datestringSíDay of the annotation, YYYY-MM-DD.
globalbooleanSítrue shows the annotation on every chart, not only on the chart of metric.
user_idstringSíId of the Baremetrics user recorded as the author, from List users.

Conexiones posibles

Tu cliente conecta su cuenta de Baremetrics una sola vez, con uno de los modos de abajo. La misma conexión sirve para todas las tools del toolkit.

Clave de API

Tu cliente pega la clave de la app en una pantalla de Connect, o tu sistema envía la clave con POST /api/customer-toolkits, sin pantalla.

La respuesta

Si la llamada tiene éxito, Connect conserva el status y el cuerpo de la respuesta de la app. Los errores HTTP devueltos por la app usan el objeto {error, api_error}; la autenticación o validación pueden fallar antes de la ejecución. El header X-Toolkit-Execution-Id identifica la ejecución registrada, disponible en GET /api/tools/executions/{uuid}.

Lista para agentes de IA

El input de esta tool es un JSON Schema, disponible en GET /api/tools/baremetrics_create_annotation. Se convierte en la definición de tool de tu agente sin conversión.

Otras tools de Baremetrics

Ver las 12 tools

Toolkits de la misma categoría

Ver los 100 toolkits

Mira Connect aplicado a tu producto.

Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.