ReportBase

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/logicmonitor/main/json-schema/logicmonitor-report-base-schema.json",
  "title": "ReportBase",
  "x-generated": "2026-10-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/logicmonitor-report-api-openapi.yml#/components/schemas/ReportBase",
  "type": "object",
  "required": [
    "name",
    "type"
  ],
  "properties": {
    "lastmodifyUserId": {
      "format": "int32",
      "description": "The Id of the user that last modified the report",
      "readOnly": true,
      "type": "integer"
    },
    "delivery": {
      "description": "Whether or not the report is configured to be delivered via email. Acceptable values are: none, email",
      "type": "string"
    },
    "userPermission": {
      "description": "The permissions associated with the user who made the API call",
      "readOnly": true,
      "type": "string"
    },
    "lastGenerateOn": {
      "format": "int64",
      "description": "The time, in epoch format, that the report was last generated",
      "readOnly": true,
      "type": "integer"
    },
    "reportLinkNum": {
      "format": "int32",
      "description": "The number of links associated with the report, where each link corresponds to a generated report",
      "readOnly": true,
      "type": "integer"
    },
    "groupId": {
      "format": "int32",
      "description": "The Id of the group the report is in, where Id=0 is the root report group",
      "type": "integer"
    },
    "format": {
      "description": "The format of the report. Allowable values are: HTML, PDF, CSV, WORD",
      "type": "string"
    },
    "description": {
      "description": "The description of the report",
      "type": "string"
    },
    "lastGenerateSize": {
      "format": "int64",
      "description": "The size of the report, in Bytes, the last time it was generated",
      "readOnly": true,
      "type": "integer"
    },
    "customReportTypeId": {
      "format": "int32",
      "description": "The id of the custom report template, if the report is a custom report. An id of 0 indicates that the report is not a custom report",
      "readOnly": true,
      "type": "integer"
    },
    "type": {
      "description": "The report type. Acceptable values are: Alert,Alert SLA,Alert threshold,Alert trends,Host CPU,Host group inventory,Host inventory,Host metric trends,Interfaces Bandwidth,Netflow device metric,Service Level Agreement,Website Service Overview,Word template,Audit Log,Alert Forecasting,Dashboard,Website SLA,User,Role",
      "type": "string"
    },
    "lastGeneratePages": {
      "format": "int32",
      "description": "The number of pages in the report, the last time it was generated",
      "readOnly": true,
      "type": "integer"
    },
    "reportLinkExpire": {
      "description": "The report link Expire. Allowable values are:High Flexibility,High Security",
      "type": "string"
    },
    "schedule": {
      "description": "A cron schedule that indicates when the report will be delivered via email",
      "type": "string"
    },
    "recipients": {
      "description": "If the report is configured to be delivered via email, this object provides the recipients that the report will be delivered to",
      "type": "array",
      "items": {
        "$ref": "#/$defs/ReportRecipient"
      }
    },
    "customReportTypeName": {
      "description": "The name of the custom report template",
      "readOnly": true,
      "type": "string"
    },
    "name": {
      "description": "The name of the report",
      "type": "string"
    },
    "enableViewAsOtherUser": {
      "description": "Whether or not other users are allowed to view the report as the user who last modified the report",
      "readOnly": true,
      "type": "boolean"
    },
    "lastmodifyUserName": {
      "description": "The username of the user that last modified the report",
      "readOnly": true,
      "type": "string"
    },
    "id": {
      "format": "int32",
      "description": "The id of the report",
      "readOnly": true,
      "type": "integer"
    },
    "scheduleTimezone": {
      "description": "The sepecific timezone for the scheduled report",
      "type": "string"
    }
  },
  "$defs": {
    "ReportRecipient": {
      "type": "object",
      "required": [
        "addr",
        "type"
      ],
      "properties": {
        "additionInfo": {
          "description": "If the type is admin and the method is email, the field should indicate the actual email address of the admin",
          "readOnly": true,
          "type": "string"
        },
        "method": {
          "description": "This should always be email",
          "type": "string"
        },
        "type": {
          "description": "Where admin refers to a user in the account and arbitrary refers to an email address not associated with a user account.Acceptable values are: admin, arbitrary",
          "type": "string"
        },
        "addr": {
          "description": "This should be a username if type=admin, or an email address if type=arbitrary",
          "type": "string"
        }
      }
    }
  }
}