Get campaign analytics | listmonk unofficial

4 parameters

typestringrequired

The analytics type to retrieve: links, views, clicks, or bounces.

Allowed:linksviewsclicksbounces

fromstringrequired

The start of the date range, in date format.

tostringrequired

The end of the date range.

idstringrequired

The campaign ID or IDs to retrieve analytics for, supplied as a string.

1 status code

200Returns an array in `data` containing campaign IDs, counts, and timestamps for the requested analytics.

dataarray<object>optional

Error handling

The type path parameter must be links, views, clicks, or bounces. The from query parameter must use a date value, and to and id query parameters must also be supplied.

import { Client } from "listmonk-unofficial-sdk";

const client = new Client({
  baseUrl: "http://localhost:9000/api",
  auth: {
    username: process.env.API_USER,
    password: process.env.API_PASS,
  },
});

const result = await client.analytics.get({
  type: "example",
  from: "example",
  to: "example",
  id: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21",
});

{
  "data": [
    {
      "campaign_id": "550e8400-e29b-41d4-a716-446655440000",
      "count": 42,
      "timestamp": "2026-01-15T09:00:00Z"
    }
  ]
}

Request

Response

Errors