aYOUne
← Marketing API

Clicks

Singular: Click — Base URL: https://marketing-api.ayoune.app — Access: read-only

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": {
    "ipLocation": {
      "subdivisions": []
    },
    "ipHash": "",
    "fingerprintView": "",
    "ayoune_actions": [],
    "ayoune_params": [],
    "ayoune_aff_type": "consumer",
    "_id": "65e074f77631a977e1babe8a",
    "channel": "",
    "device": "",
    "country": "",
    "query": "",
    "url": "",
    "adType": "",
    "ad": "",
    "isAd": false,
    "fingerprint": "",
    "referrer": "",
    "ip": "",
    "region": "",
    "city": "",
    "ll": [],
    "timezone": "",
    "createdBy": "6045f4d25704710012485569",
    "createdAt": "2024-02-29T12:13:43.230Z",
    "updatedAt": "2024-02-29T12:13:43.230Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://marketing-api.ayoune.app/clicks/65e074f77631a977e1babe8a",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [
      {
        "rel": "Affiliates",
        "title": "MODEL_AFFILIATE",
        "href": "https://api.ayoune.app/config/affiliates",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.affiliates"
      },
      {
        "rel": "Projects",
        "title": "MODEL_PROJECT",
        "href": "https://api.ayoune.app/pm/projects",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "pm.projects"
      },
      {
        "rel": "Properties",
        "title": "MODEL_PROPERTY",
        "href": "https://api.ayoune.app/config/properties",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.properties"
      }
    ],
    "debugId": "6a619464f78ad61f1990d8aa",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_CLICK",
        "href": "https://api.ayoune.app/marketing/clicks/65e074f77631a977e1babe8a/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_CLICK",
        "href": "https://api.ayoune.app/marketing/clicks/65e074f77631a977e1babe8a/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.24.4",
      "core": "2026.257.1"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2311",
      "reset": "1784783437",
      "resetDate": "Thu Jul 23 2026"
    },
    "responseTime": 71.968618,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

MethodPathDescriptionRight
GET /clicks List with filters/pagination marketing.clicks.view
GET /clicks/:id Single record by ID marketing.clicks.view

SDK

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

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

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

See also