aYOUne
← Monitoring API

Goals

Singular: Goal — Base URL: https://monitoring-api.ayoune.app — Access: CRUD — Machine-readable spec (JSON · YAML)

play_circle Try it now beta

Requests are proxied through the consumer-app to *.ayoune.app. Tokens stay in your browser and are forwarded per call.

Example response (recorded) sample

A real, previously recorded GET /:id response of this endpoint — not the live call above. Sensitive fields are masked.

{
  "payload": {
    "duration": {
      "hour": 0,
      "minute": 0,
      "second": 0
    },
    "event": {
      "category_condition": "=",
      "action_condition": "=",
      "label_condition": "=",
      "value_condition": "="
    },
    "_id": "65e0b161121b7d48fe159622",
    "name": "",
    "kind": "company",
    "type": "page",
    "targetValue": 0,
    "page": "",
    "views": 0,
    "value": 0,
    "isDraft": true,
    "createdBy": "6045f4d25704710012485569",
    "start": "2024-02-29T16:31:29.068Z",
    "end": "2024-02-29T16:31:29.068Z",
    "pagesteps": [],
    "createdAt": "2024-02-29T16:31:29.069Z",
    "updatedAt": "2024-02-29T16:31:29.069Z",
    "shares": []
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://monitoring-api.ayoune.app/goals/65e0b161121b7d48fe159622",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [
      {
        "rel": "Departments",
        "title": "MODEL_DEPARTMENT",
        "href": "https://api.ayoune.app/config/departments",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.departments"
      },
      {
        "rel": "Teams",
        "title": "MODEL_TEAM",
        "href": "https://api.ayoune.app/config/teams",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.teams"
      }
    ],
    "debugId": "6aa37f0a879c2fac772ac64a",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_GOAL",
        "href": "https://api.ayoune.app/monitoring/goals/65e0b161121b7d48fe159622/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_GOAL",
        "href": "https://api.ayoune.app/monitoring/goals/65e0b161121b7d48fe159622",
        "method": "delete",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.39.1",
      "core": "2026.332.0"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2398",
      "reset": "1789103270",
      "resetDate": "Fri Sep 11 2026"
    },
    "responseTime": 44.198759,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

MethodPathDescriptionRight
GET /goals List with filters/pagination monitoring.goals.view
GET /goals/:id Single record monitoring.goals.view
POST /goals Create new record monitoring.goals.new
PUT /goals Update record monitoring.goals.edit
DELETE /goals/:id Delete record monitoring.goals.delete

SDK

import { aYOUne } from '@tolinax/ayoune';
const ay = new aYOUne('pat_your_token');

// List all
const list = await ay.monitoring.goals.find().limit(10).exec();

// Single record
const one = await ay.monitoring.goals.findById('OBJECT_ID').exec();

// Create
const created = await ay.monitoring.goals.create({ name: 'Foo' });

See also