Report

Summary

Analytics report definition

Description

The range, fromDate, and toDate fields all have possible values of: today, yesterday, 7days, 30days, 3months, 6months, week, month, year. In addition toDay may also have a value of: now.

Fields

Field Name	Type	Since Version	Description
id	String		The report identifier. Automatically assigned.
name	String		The report name.
type	String		The report type to generate, one of: pdf, csv
reportGroup	String		The report group type, one of: SystemOverview, Service, Client, ServiceUsagePerClient, ServiceUsagePerMethod, RemoteHost, or InboundProtocol
reportParameters	{String, Object}		Internal use only. Automatically assigned.
customReport	CustomReport		The report definition.
email	String		Email recipient(s) to receive the generated report.
enabled	Boolean		Enables the scheduled report for generation.
range	String		Indicates the report should be run on a time range, i.e. fromDate is not a specific date.
fromDate	String		The starting date for the report.
toDate	String		The end date for the report.
scheduled	String		The schedule frequency of the report, values one of: daily, weekly, monthly.
generateTime	String		The time at which the report should be generated in a 24 hour HH:MM format.
dayOfWeek	String		The day of the week at which the report should be generated, values one of: mon, tue, wed, thu, fri, sat, sun.
dayOfMonth	String		The day of month at which the report should be generated if schedule is monthly, values one of: first, last.
lastRun	Long		The timestamp of the last time the report was run.
timeout	Long		The maximum amount of time to wait for the report to generate.

Example JSON

{
  "id" : "Id-0001372322567916-ffffffffec92eba7-1",
  "name" : "My Report",
  "type" : "pdf",
  "reportGroup" : "ServiceUsagePerClient",
  "reportParameters" : {
    "print" : true,
    "level" : 0
  },
  "customReport" : {
    "id" : "Id-0001372322567916-ffffffffec92eba7-1",
    "name" : "My Report",
    "type" : "ServiceUsagePerClient",
    "levels" : [ {
      "type" : "ServiceUsagePerClient",
      "chart" : "line",
      "top" : {
        "top" : 5
      },
      "groupBy" : [ "GROUPNAME", "INSTANCENAME", "CLIENTNAME", "SERVICENAME" ],
      "additionalFields" : [ "DISPLAYNAME" ],
      "hiddenFields" : [ "CLIENTNAME" ],
      "metrics" : [ {
        "name" : "numMessages",
        "visible" : true
      } ],
      "conditionGroups" : [ {
        "conditions" : [ {
          "name" : "LASTTEXT",
          "operation" : "GTEQ",
          "value" : "Connected"
        } ],
        "logic" : "AND",
        "where" : "OR"
      } ]
    } ]
  },
  "email" : "somebody@acme.org",
  "enabled" : true,
  "range" : "today",
  "fromDate" : "today",
  "toDate" : "today",
  "scheduled" : "daily",
  "generateTime" : "09:00",
  "dayOfWeek" : "fri",
  "dayOfMonth" : "first",
  "lastRun" : 0,
  "timeout" : 30000
}