Delete campaign analytics by type

1 parameter · 1 body field

typestringrequired

The type of campaign analytics to garbage collect.

Form-encoded date cutoff for deleting campaign analytics.

before_datestringoptional

The cutoff date in `YYYY-MM-DD` format.

1 status code

200Returns a boolean in `data` indicating the deletion result.

databooleanoptional

Error handling

The type path parameter specifies the campaign analytics category to delete. before_date must use the YYYY-MM-DD date format.

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.delete({
  type: "example",
  beforeDate: "2024-01-15T09:30:00Z",
});

{
  "data": true
}

Request

Response

Errors