Analytics

Summary

The Reports REST API provides access to periodic analytics of the API Servers across the enterprise.

Description

With the Reports API, it is possible to track server hardware vitals, client and service invocation, errors, and response times.

Resources

Resource	Since Version	Description
GET /api/reports/alerts		Gets a list of system alerts
GET /api/reports/alerts/{messageId}		Gets alerts for a message by ID.
POST /api/reports/audit		Search audit entries.
GET /api/reports/audit/details/{auditId}		Gets an audit message details.
GET /api/reports/audit/fields		Gets a list of auditable fields.
GET /api/reports/audit/payload/{auditId}		Gets an audit message payload.
GET /api/reports/audit/query		Gets a list of all saved audit query.
POST /api/reports/audit/query		Saves a query for recalling later.
PUT /api/reports/audit/query/{queryid}		Updates a saved audit query by ID.
DELETE /api/reports/audit/query/{queryid}		Deletes a saved audit query by ID.
GET /api/reports/audit/query/{queryid}		Gets a saved audit query by ID.
GET /api/reports/audit/values/{fieldname}		Gets a list of values for a field.
GET /api/reports/custom		Gets a list of reports.
POST /api/reports/custom		Create a report.
PUT /api/reports/custom/{reportid}		Updates a report by ID.
DELETE /api/reports/custom/{reportid}		Deletes a report by ID.
GET /api/reports/custom/{reportid}		Gets a report by ID.
GET /api/reports/download/csv/{jobid}		Downloads a CSV from the result of a completed report generation job.
GET /api/reports/download/pdf/{jobid}		Downloads a PDF from the result of a completed report generation job.
POST /api/reports/generate		Creates a job to manually generate a report.
GET /api/reports/generate/{jobid}		Polls the status of a report generation job.
GET /api/reports/metrics		Check that the server is alive
GET /api/reports/metrics/fields		Gets a list of metric field names available for summary and timeline queries.
GET /api/reports/metrics/groups/{typeName}		Gets a list of process groups.
GET /api/reports/metrics/processes		Gets a list of processes available to query.
GET /api/reports/metrics/processgroups		Gets a list of process groups available to query.
GET /api/reports/metrics/summary/{id}/{level}		Produces a summary report
POST /api/reports/metrics/summary/{level}		Produces a summary report for a custom report
GET /api/reports/metrics/timeline/{id}/{level}/{seriesName}		Produces a timeline report for a stored custom report
POST /api/reports/metrics/timeline/{level}/{seriesName}		Produces a timeline report for a custom report
POST /api/reports/schedule		Creates a scheduled report.
GET /api/reports/schedule		Gets a list of all the scheduled reports.
GET /api/reports/schedule/{reportid}		Gets a scheduled report by ID.
PUT /api/reports/schedule/{reportid}		Updates a scheduled report by ID.
DELETE /api/reports/schedule/{reportid}		Deletes a scheduled report by ID.

GET /api/reports/alerts

Summary

Gets a list of system alerts

Description

Gets a list of system alerts.

Parameters

Parameter	Description	Data Type	Location	Required	Multiple
`from`	The amount of time in some range of months, days, weeks, hours, minutes. E.g. 24h		query	Required

Status Codes

HTTP Status Code	Reason
200	OK
503	Analytics is disabled. See logs for more information.
500	Internal Server Error

Return Value

[{"ALERTLEVEL": "ERROR","MESSAGE": "Missing identifier","ID": "1","ALERTTIMESTAMP": "13:19:53.191"}]

GET /api/reports/alerts/{messageId}

Summary

Gets alerts for a message by ID.

Description

Gets alerts for a message by ID.

Parameters

Parameter	Description	Data Type	Location	Required	Multiple
`messageId`	The message ID.	String	path	Required

Status Codes

HTTP Status Code	Reason
200	OK
503	Analytics is disabled. See logs for more information.
500	Internal Server Error

Return Value

[String]

Example

GET https://localhost:8075/api/reports/alerts/Id-d5cb15fb-e4ac-4ce4-9c3a-27e9f04b2c69?startswith=inst

Response
HTTP 1.1 200 OK

[ "instance-1", "instance-2" ]

POST /api/reports/audit

Summary

Search audit entries.

Description

none

Parameters

Parameter	Description	Data Type	Location
`-`	The query to perform.	Query	body
`Range`	Return results within range. E.g.: items=[offset]-[limit].	String	header
`Sort`	The field to sort and direction (+ ascending, - descending). E.g.: name+	String	header
`Refresh`	Force a refresh of any cached data.	String	header

Status Codes

HTTP Status Code	Reason
200	OK
503	Analytics is disabled. See logs for more information.
400	Bad Request
500	Internal Server Error

Example

POST https://localhost:8075/api/reports/audit

Request

{
  "id" : "Id-0001372322567916-ffffffffec92eba7-1",
  "name" : "Errors last 5 days",
  "summary" : true,
  "fieldsToSelect" : [ "ALERTCOUNT", "ERRORCOUNT", "FATALCOUNT", "LASTTEXT", "LASTSEVERITY", "PASSCOUNT", "GATEWAYNAME", "LOGTIME", "MESSAGEID" ],
  "conditionGroups" : [ {
    "conditions" : [ {
      "name" : "LASTTEXT",
      "operation" : "GTEQ",
      "value" : "Connected"
    } ],
    "logic" : "AND",
    "where" : "OR"
  } ]
}

Response
HTTP 1.1 200 OK

{
  "id" : "Id-0001372322567916-ffffffffec92eba7-1",
  "name" : "Errors last 5 days",
  "summary" : true,
  "fieldsToSelect" : [ "ALERTCOUNT", "ERRORCOUNT", "FATALCOUNT", "LASTTEXT", "LASTSEVERITY", "PASSCOUNT", "GATEWAYNAME", "LOGTIME", "MESSAGEID" ],
  "conditionGroups" : [ {
    "conditions" : [ {
      "name" : "LASTTEXT",
      "operation" : "GTEQ",
      "value" : "Connected"
    } ],
    "logic" : "AND",
    "where" : "OR"
  } ]
}

GET /api/reports/audit/details/{auditId}

Summary

Gets an audit message details.

Description

Gets an audit message details.

Parameters

Parameter	Description	Data Type	Location	Required	Multiple
`auditId`	The audit log ID	int	path	Required

Status Codes

HTTP Status Code	Reason
204	No Content
503	Analytics is disabled. See logs for more information.
400	Bad Request
500	Internal Server Error

Returns Class

MessageDetails

GET /api/reports/audit/fields

Summary

Gets a list of auditable fields.

Description

Gets a list of auditable fields. There are two types, one for summary where there is one aggregated record per message, and detailed, where there can be multiple records per message.

Parameters

Parameter	Description	Data Type	Location	Required	Multiple
`summary`	Indicates that the fields should be for the summary (true), or detailed report (false). Defaults to true.		query	Required

Status Codes

HTTP Status Code	Reason
200	OK
503	Analytics is disabled. See logs for more information.
500	Internal Server Error

Returns Array

[ AuditField ]

Example

GET https://localhost:8075/api/reports/audit/fields?summary=true

Response
HTTP 1.1 200 OK

[ {
  "name" : "HOST",
  "type" : "String",
  "custom" : false,
  "select" : true,
  "condition" : true,
  "timestampType" : false,
  "binaryType" : false,
  "valuesUrl" : "/api/reports/audit/values/HOST"
}, {
  "name" : "GATEWAYNAME",
  "type" : "String",
  "custom" : false,
  "select" : true,
  "condition" : true,
  "timestampType" : false,
  "binaryType" : false,
  "valuesUrl" : "/api/reports/audit/values/GATEWAYNAME"
}, {
  "name" : "LOGTIME",
  "type" : "Timestamp",
  "custom" : false,
  "select" : true,
  "condition" : true,
  "timestampType" : true,
  "binaryType" : false,
  "valuesUrl" : null
}, {
  "name" : "LASTSEVERITY",
  "type" : "Integer",
  "custom" : false,
  "select" : true,
  "condition" : true,
  "timestampType" : false,
  "binaryType" : false,
  "valuesUrl" : null
}, {
  "name" : "FATALCOUNT",
  "type" : "Integer",
  "custom" : false,
  "select" : true,
  "condition" : false,
  "timestampType" : false,
  "binaryType" : false,
  "valuesUrl" : null
}, {
  "name" : "LASTTEXT",
  "type" : "String",
  "custom" : false,
  "select" : true,
  "condition" : true,
  "timestampType" : false,
  "binaryType" : false,
  "valuesUrl" : null
}, {
  "name" : "ERRORCOUNT",
  "type" : "Integer",
  "custom" : false,
  "select" : true,
  "condition" : false,
  "timestampType" : false,
  "binaryType" : false,
  "valuesUrl" : null
}, {
  "name" : "GATEWAYGROUPNAME",
  "type" : "String",
  "custom" : false,
  "select" : true,
  "condition" : true,
  "timestampType" : false,
  "binaryType" : false,
  "valuesUrl" : "/api/reports/audit/values/GATEWAYGROUPNAME"
}, {
  "name" : "PASSCOUNT",
  "type" : "Integer",
  "custom" : false,
  "select" : true,
  "condition" : false,
  "timestampType" : false,
  "binaryType" : false,
  "valuesUrl" : null
}, {
  "name" : "ALERTCOUNT",
  "type" : "Integer",
  "custom" : false,
  "select" : true,
  "condition" : false,
  "timestampType" : false,
  "binaryType" : false,
  "valuesUrl" : null
}, {
  "name" : "MESSAGEID",
  "type" : "String",
  "custom" : false,
  "select" : true,
  "condition" : true,
  "timestampType" : false,
  "binaryType" : false,
  "valuesUrl" : null
}, {
  "name" : "HASALERTS",
  "type" : "Boolean",
  "custom" : false,
  "select" : false,
  "condition" : true,
  "timestampType" : false,
  "binaryType" : false,
  "valuesUrl" : null
}, {
  "name" : "FILTERNAME",
  "type" : "String",
  "custom" : false,
  "select" : false,
  "condition" : true,
  "timestampType" : false,
  "binaryType" : false,
  "valuesUrl" : "/api/reports/audit/values/FILTERNAME"
}, {
  "name" : "HTTPREQUESTURI",
  "type" : "String",
  "custom" : false,
  "select" : false,
  "condition" : true,
  "timestampType" : false,
  "binaryType" : false,
  "valuesUrl" : "/api/reports/audit/values/HTTPREQUESTURI"
}, {
  "name" : "HTTPREQUESTVERB",
  "type" : "String",
  "custom" : false,
  "select" : false,
  "condition" : true,
  "timestampType" : false,
  "binaryType" : false,
  "valuesUrl" : "/api/reports/audit/values/HTTPREQUESTVERB"
}, {
  "name" : "LOGLEVEL",
  "type" : "Integer",
  "custom" : false,
  "select" : false,
  "condition" : true,
  "timestampType" : false,
  "binaryType" : false,
  "valuesUrl" : null
}, {
  "name" : "HASERRORS",
  "type" : "Boolean",
  "custom" : false,
  "select" : false,
  "condition" : true,
  "timestampType" : false,
  "binaryType" : false,
  "valuesUrl" : null
}, {
  "name" : "FILTERCATEGORY",
  "type" : "String",
  "custom" : false,
  "select" : false,
  "condition" : true,
  "timestampType" : false,
  "binaryType" : false,
  "valuesUrl" : "/api/reports/audit/values/FILTERCATEGORY"
}, {
  "name" : "FILTERTYPE",
  "type" : "String",
  "custom" : false,
  "select" : false,
  "condition" : true,
  "timestampType" : false,
  "binaryType" : false,
  "valuesUrl" : "/api/reports/audit/values/FILTERTYPE"
}, {
  "name" : "MESSAGEHEADER",
  "type" : "Binary",
  "custom" : false,
  "select" : false,
  "condition" : true,
  "timestampType" : false,
  "binaryType" : true,
  "valuesUrl" : null
}, {
  "name" : "TEXT",
  "type" : "String",
  "custom" : false,
  "select" : false,
  "condition" : true,
  "timestampType" : false,
  "binaryType" : false,
  "valuesUrl" : null
}, {
  "name" : "HASFATALS",
  "type" : "Boolean",
  "custom" : false,
  "select" : false,
  "condition" : true,
  "timestampType" : false,
  "binaryType" : false,
  "valuesUrl" : null
}, {
  "name" : "MESSAGEBODY",
  "type" : "Binary",
  "custom" : false,
  "select" : false,
  "condition" : true,
  "timestampType" : false,
  "binaryType" : true,
  "valuesUrl" : null
} ]

GET /api/reports/audit/payload/{auditId}

Summary

Gets an audit message payload.

Description

Gets an audit message payload.

Parameters

Parameter	Description	Data Type	Location	Required	Multiple
`auditId`	The audit log ID	int	path	Required

Status Codes

HTTP Status Code	Reason
200	OK
404	Not Found
503	Analytics is disabled. See logs for more information.
500	Internal Server Error

Return Value

[Byte]

GET /api/reports/audit/query

Summary

Gets a list of all saved audit query.

Description

Gets a list of all saved Query.

Parameters

none

Status Codes

HTTP Status Code	Reason
200	OK
503	Analytics is disabled. See logs for more information.
400	Bad Request
500	Internal Server Error

Returns Array

[ Query ]

Example

GET https://localhost:8075/api/reports/audit/query

Response
HTTP 1.1 200 OK

[ {
  "id" : "Id-0001372322567916-ffffffffec92eba7-2",
  "name" : "Test",
  "fieldsToSelect" : [ "ALERTCOUNT", "ERRORCOUNT", "FATALCOUNT", "LASTTEXT", "LASTSEVERITY", "PASSCOUNT", "GATEWAYNAME", "LOGTIME" ],
  "conditionGroups" : [ {
    "conditions" : [ {
      "name" : "LOGTIME",
      "operation" : "GTEQ",
      "value" : "15mi"
    } ],
    "logic" : "AND",
    "where" : "AND"
  } ],
  "summary" : true
} ]

POST /api/reports/audit/query

Summary

Saves a query for recalling later.

Description

Saves a query for recalling later.

Parameters

Parameter	Description	Data Type	Location	Required	Multiple
`-`	The query to create.	Query	body	Required

Status Codes

HTTP Status Code	Reason
201	Created
503	Analytics is disabled. See logs for more information.
400	Bad Request
500	Internal Server Error

Returns Class

Query

Example

POST https://localhost:8075/api/reports/audit/query

Request

{
  "name" : "Test",
  "fieldsToSelect" : [ "ALERTCOUNT", "ERRORCOUNT", "FATALCOUNT", "LASTTEXT", "LASTSEVERITY", "PASSCOUNT", "GATEWAYNAME", "LOGTIME" ],
  "conditionGroups" : [ {
    "conditions" : [ {
      "name" : "LOGTIME",
      "operation" : "GTEQ",
      "value" : "15mi"
    } ],
    "logic" : "AND",
    "where" : "AND"
  } ],
  "summary" : true
}

Response
HTTP 1.1 201 Created

{
  "id" : "Id-0001372322567916-ffffffffec92eba7-2",
  "name" : "Test",
  "fieldsToSelect" : [ "ALERTCOUNT", "ERRORCOUNT", "FATALCOUNT", "LASTTEXT", "LASTSEVERITY", "PASSCOUNT", "GATEWAYNAME", "LOGTIME" ],
  "conditionGroups" : [ {
    "conditions" : [ {
      "name" : "LOGTIME",
      "operation" : "GTEQ",
      "value" : "15mi"
    } ],
    "logic" : "AND",
    "where" : "AND"
  } ],
  "summary" : true
}

PUT /api/reports/audit/query/{queryid}

Summary

Updates a saved audit query by ID.

Description

Updates a saved audit Query by ID.

Parameters

Parameter	Description	Data Type	Location	Required	Multiple
`-`	The query to update.	Query	body	Required
`queryid`	The query ID.	String	path	Required

Status Codes

HTTP Status Code	Reason
200	OK
503	Analytics is disabled. See logs for more information.
400	Bad Request
500	Internal Server Error

Returns Class

Query

Example

PUT https://localhost:8075/api/reports/audit/query/{queryid}

Request

{
  "id" : "Id-0001372322567916-ffffffffec92eba7-2",
  "name" : "Test",
  "fieldsToSelect" : [ "ALERTCOUNT", "ERRORCOUNT", "FATALCOUNT", "LASTTEXT", "LASTSEVERITY", "PASSCOUNT", "GATEWAYNAME", "LOGTIME" ],
  "conditionGroups" : [ {
    "conditions" : [ {
      "name" : "LOGTIME",
      "operation" : "GTEQ",
      "value" : "15mi"
    } ],
    "logic" : "AND",
    "where" : "AND"
  } ],
  "summary" : true
}

Response
HTTP 1.1 200 OK

{
  "id" : "Id-0001372322567916-ffffffffec92eba7-2",
  "name" : "Test",
  "fieldsToSelect" : [ "ALERTCOUNT", "ERRORCOUNT", "FATALCOUNT", "LASTTEXT", "LASTSEVERITY", "PASSCOUNT", "GATEWAYNAME", "LOGTIME" ],
  "conditionGroups" : [ {
    "conditions" : [ {
      "name" : "LOGTIME",
      "operation" : "GTEQ",
      "value" : "15mi"
    } ],
    "logic" : "AND",
    "where" : "AND"
  } ],
  "summary" : true
}

DELETE /api/reports/audit/query/{queryid}

Summary

Deletes a saved audit query by ID.

Description

Deletes a saved audit Query by ID.

Parameters

Parameter	Description	Data Type	Location	Required	Multiple
`queryid`	The query ID to delete.	String	path	Required

Status Codes

HTTP Status Code	Reason
204	No Content
503	Analytics is disabled. See logs for more information.
400	Bad Request
500	Internal Server Error

GET /api/reports/audit/query/{queryid}

Summary

Gets a saved audit query by ID.

Description

Gets a saved audit Query by ID.

Parameters

Parameter	Description	Data Type	Location	Required	Multiple
`queryid`	The query ID.	String	path	Required

Status Codes

HTTP Status Code	Reason
200	OK
503	Analytics is disabled. See logs for more information.
400	Bad Request
500	Internal Server Error

Returns Class

Query

Example

GET https://localhost:8075/api/reports/audit/query/{queryid}

Response
HTTP 1.1 200 OK

[ {
  "id" : "Id-0001372322567916-ffffffffec92eba7-2",
  "name" : "Test",
  "fieldsToSelect" : [ "ALERTCOUNT", "ERRORCOUNT", "FATALCOUNT", "LASTTEXT", "LASTSEVERITY", "PASSCOUNT", "GATEWAYNAME", "LOGTIME" ],
  "conditionGroups" : [ {
    "conditions" : [ {
      "name" : "LOGTIME",
      "operation" : "GTEQ",
      "value" : "15mi"
    } ],
    "logic" : "AND",
    "where" : "AND"
  } ],
  "summary" : true
} ]

GET /api/reports/audit/values/{fieldname}

Summary

Gets a list of values for a field.

Description

Gets a list of values for a field. The list can be filtered with values matching startsWith.

Parameters

Parameter	Description	Data Type	Location	Required
`fieldname`		String	path	Required
`startswith`	An optional parameter to return values starting with the supplied string.	String	query
`fieldName`	The name of the field for which to obtain values.		query	Required

Status Codes

HTTP Status Code	Reason
200	OK
503	Analytics is disabled. See logs for more information.
500	Internal Server Error

Return Value

[String]

Example

GET https://localhost:8075/api/reports/audit/values/GATEWAYNAME?startswith=inst

Response
HTTP 1.1 200 OK

[ "instance-1", "instance-2" ]

GET /api/reports/custom

Summary

Gets a list of reports.

Description

The list of custom reports includes the system default reports.

Parameters

none

Status Codes

HTTP Status Code	Reason
200	OK
503	Analytics is disabled. See logs for more information.
500	Internal Server Error

Returns Array

[ CustomReport ]

Example

GET https://localhost:8075/api/reports/custom

Response
HTTP 1.1 200 OK

[ {
  "id" : "api-services-clients-of",
  "name" : "API Services (Clients of)",
  "type" : "Service",
  "levels" : [ {
    "type" : "Service",
    "chart" : "line",
    "top" : { },
    "metrics" : [ {
      "name" : "numMessages",
      "visible" : true
    }, {
      "name" : "successes",
      "visible" : true
    }, {
      "name" : "failures",
      "visible" : true
    }, {
      "name" : "exceptions",
      "visible" : true
    } ],
    "groupBy" : [ "SERVICENAME" ],
    "conditionGroups" : [ ]
  }, {
    "type" : "Service",
    "chart" : "line",
    "top" : { },
    "metrics" : [ {
      "name" : "numMessages",
      "visible" : true
    }, {
      "name" : "successes",
      "visible" : true
    }, {
      "name" : "failures",
      "visible" : true
    }, {
      "name" : "exceptions",
      "visible" : true
    } ],
    "groupBy" : [ "CLIENTNAME" ],
    "conditionGroups" : [ ]
  } ]
} ]

POST /api/reports/custom

Summary

Create a report.

Description

A report is available in Analytics as one of the main tabs.

Parameters

Parameter	Description	Data Type	Location	Required	Multiple
`-`	The report to create.	CustomReport	body	Required

Status Codes

HTTP Status Code	Reason
200	OK
409	A report with that ID already exists
503	Analytics is disabled. See logs for more information.
500	Internal Server Error

Returns Class

CustomReport

Example

POST https://localhost:8075/api/reports/custom

Request

{
  "name" : "API Services (Clients of)",
  "type" : "Service",
  "levels" : [ {
    "type" : "Service",
    "chart" : "line",
    "top" : { },
    "metrics" : [ {
      "name" : "numMessages",
      "visible" : true
    }, {
      "name" : "successes",
      "visible" : true
    }, {
      "name" : "failures",
      "visible" : true
    }, {
      "name" : "exceptions",
      "visible" : true
    } ],
    "groupBy" : [ "SERVICENAME" ],
    "conditionGroups" : [ ]
  }, {
    "type" : "Service",
    "chart" : "line",
    "top" : { },
    "metrics" : [ {
      "name" : "numMessages",
      "visible" : true
    }, {
      "name" : "successes",
      "visible" : true
    }, {
      "name" : "failures",
      "visible" : true
    }, {
      "name" : "exceptions",
      "visible" : true
    } ],
    "groupBy" : [ "CLIENTNAME" ],
    "conditionGroups" : [ ]
  } ]
}

Response
HTTP 1.1 200 OK

{
  "id" : "api-services-clients-of",
  "name" : "API Services (Clients of)",
  "type" : "Service",
  "levels" : [ {
    "type" : "Service",
    "chart" : "line",
    "top" : { },
    "metrics" : [ {
      "name" : "numMessages",
      "visible" : true
    }, {
      "name" : "successes",
      "visible" : true
    }, {
      "name" : "failures",
      "visible" : true
    }, {
      "name" : "exceptions",
      "visible" : true
    } ],
    "groupBy" : [ "SERVICENAME" ],
    "conditionGroups" : [ ]
  }, {
    "type" : "Service",
    "chart" : "line",
    "top" : { },
    "metrics" : [ {
      "name" : "numMessages",
      "visible" : true
    }, {
      "name" : "successes",
      "visible" : true
    }, {
      "name" : "failures",
      "visible" : true
    }, {
      "name" : "exceptions",
      "visible" : true
    } ],
    "groupBy" : [ "CLIENTNAME" ],
    "conditionGroups" : [ ]
  } ]
}

PUT /api/reports/custom/{reportid}

Summary

Updates a report by ID.

Description

none

Parameters

Parameter	Description	Data Type	Location	Required	Multiple
`-`	The report to update.	CustomReport	body	Required
`reportid`		String	path	Required

Status Codes

HTTP Status Code	Reason
200	OK
404	Not Found
503	Analytics is disabled. See logs for more information.
500	Internal Server Error

Returns Class

CustomReport

Example

PUT https://localhost:8075/api/reports/custom/api-services-clients-of

Request

{
  "id" : "api-services-clients-of",
  "name" : "API Services (Clients of)",
  "type" : "Service",
  "levels" : [ {
    "type" : "Service",
    "chart" : "line",
    "top" : { },
    "metrics" : [ {
      "name" : "numMessages",
      "visible" : true
    }, {
      "name" : "successes",
      "visible" : true
    }, {
      "name" : "failures",
      "visible" : true
    }, {
      "name" : "exceptions",
      "visible" : true
    } ],
    "groupBy" : [ "SERVICENAME" ],
    "conditionGroups" : [ ]
  }, {
    "type" : "Service",
    "chart" : "line",
    "top" : { },
    "metrics" : [ {
      "name" : "numMessages",
      "visible" : true
    }, {
      "name" : "successes",
      "visible" : true
    }, {
      "name" : "failures",
      "visible" : true
    }, {
      "name" : "exceptions",
      "visible" : true
    } ],
    "groupBy" : [ "CLIENTNAME" ],
    "conditionGroups" : [ ]
  } ]
}

Response
HTTP 1.1 200 OK

{
  "id" : "api-services-clients-of",
  "name" : "API Services (Clients of)",
  "type" : "Service",
  "levels" : [ {
    "type" : "Service",
    "chart" : "line",
    "top" : { },
    "metrics" : [ {
      "name" : "numMessages",
      "visible" : true
    }, {
      "name" : "successes",
      "visible" : true
    }, {
      "name" : "failures",
      "visible" : true
    }, {
      "name" : "exceptions",
      "visible" : true
    } ],
    "groupBy" : [ "SERVICENAME" ],
    "conditionGroups" : [ ]
  }, {
    "type" : "Service",
    "chart" : "line",
    "top" : { },
    "metrics" : [ {
      "name" : "numMessages",
      "visible" : true
    }, {
      "name" : "successes",
      "visible" : true
    }, {
      "name" : "failures",
      "visible" : true
    }, {
      "name" : "exceptions",
      "visible" : true
    } ],
    "groupBy" : [ "CLIENTNAME" ],
    "conditionGroups" : [ ]
  } ]
}

DELETE /api/reports/custom/{reportid}

Summary

Deletes a report by ID.

Description

none

Parameters

Parameter	Description	Data Type	Location	Required	Multiple
`reportid`		String	path	Required
`report`	The report to update.		query	Required

Status Codes

HTTP Status Code	Reason
204	No Content
503	Analytics is disabled. See logs for more information.
500	Internal Server Error

GET /api/reports/custom/{reportid}

Summary

Gets a report by ID.

Description

none

Parameters

Parameter	Description	Data Type	Location	Required	Multiple
`reportid`		String	path	Required
`report`	The report to create.		query	Required

Status Codes

HTTP Status Code	Reason
200	OK
503	Analytics is disabled. See logs for more information.
500	Internal Server Error

Returns Class

CustomReport

Example

GET https://localhost:8075/api/reports/custom/api-services-clients-of

Response
HTTP 1.1 200 OK

{
  "id" : "api-services-clients-of",
  "name" : "API Services (Clients of)",
  "type" : "Service",
  "levels" : [ {
    "type" : "Service",
    "chart" : "line",
    "top" : { },
    "metrics" : [ {
      "name" : "numMessages",
      "visible" : true
    }, {
      "name" : "successes",
      "visible" : true
    }, {
      "name" : "failures",
      "visible" : true
    }, {
      "name" : "exceptions",
      "visible" : true
    } ],
    "groupBy" : [ "SERVICENAME" ],
    "conditionGroups" : [ ]
  }, {
    "type" : "Service",
    "chart" : "line",
    "top" : { },
    "metrics" : [ {
      "name" : "numMessages",
      "visible" : true
    }, {
      "name" : "successes",
      "visible" : true
    }, {
      "name" : "failures",
      "visible" : true
    }, {
      "name" : "exceptions",
      "visible" : true
    } ],
    "groupBy" : [ "CLIENTNAME" ],
    "conditionGroups" : [ ]
  } ]
}

GET /api/reports/download/csv/{jobid}

Summary

Downloads a CSV from the result of a completed report generation job.

Description

The job identifier is returned from the generate report method. The job must be complete. Ensure the job is complete by first (checking the job status)[#ReportsResourcegetGenerateReportStatus].

Parameters

Parameter	Description	Data Type	Location	Required	Multiple
`jobid`	The job identifier	String	path	Required

Status Codes

HTTP Status Code	Reason
200	OK
503	Analytics is disabled. See logs for more information.
500	Internal Server Error

GET /api/reports/download/pdf/{jobid}

Summary

Downloads a PDF from the result of a completed report generation job.

Description

The job identifier is returned from the generate report method. The job must be complete. Ensure the job is complete by first (checking the job status)[#ReportsResourcegetGenerateReportStatus].

Parameters

Parameter	Description	Data Type	Location	Required	Multiple
`jobid`	The job identifier	String	path	Required

Status Codes

HTTP Status Code	Reason
200	OK
503	Analytics is disabled. See logs for more information.
500	Internal Server Error

POST /api/reports/generate

Summary

Creates a job to manually generate a report.

Description

Report generation begins immediately, ignoring the schedule settings. The response contains an job "id" identifier. The identifier is used to query the status of the job.

Parameters

Parameter	Description	Data Type	Location	Required	Multiple
`-`	The report to generate	Report	body	Required

Status Codes

HTTP Status Code	Reason
200	OK
503	Analytics is disabled. See logs for more information.
500	Internal Server Error

Example

POST https://localhost:8075/api/reports/generate

Request

{
  "name" : "systems-1day-${yyyyMMdd}.pdf",
  "type" : "pdf",
  "reportGroup" : "SystemOverview",
  "reportParameters" : {
    "print" : true,
    "level" : 0
  },
  "customReport" : {
    "id" : "",
    "name" : "Systems",
    "type" : "SystemOverview",
    "levels" : [ {
      "type" : "SystemOverview",
      "chart" : "line",
      "top" : { },
      "metrics" : [ {
        "name" : "successes",
        "visible" : true
      }, {
        "name" : "failures",
        "visible" : true
      }, {
        "name" : "exceptions",
        "visible" : true
      }, {
        "name" : "active",
        "visible" : true
      }, {
        "name" : "numSLABreaches",
        "visible" : true
      }, {
        "name" : "numClients",
        "visible" : true
      } ],
      "groupBy" : [ "INSTANCENAME", "GROUPNAME" ],
      "conditionGroups" : [ ]
    } ]
  },
  "email" : "somebody@acme.org",
  "enabled" : true,
  "range" : "today",
  "fromDate" : "today",
  "toDate" : "now",
  "scheduled" : "daily",
  "generateTime" : "09:00",
  "dayOfWeek" : "mon",
  "dayOfMonth" : "first",
  "lastRun" : 0,
  "timeout" : 30000
}

Response
HTTP 1.1 200 OK

{
  "type" : "pdf",
  "status" : "running",
  "id" : "systems-1day-20130628"
}

GET /api/reports/generate/{jobid}

Summary

Polls the status of a report generation job.

Description

The job identifier is returned from the generate report method.

Parameters

Parameter	Description	Data Type	Location	Required	Multiple
`jobid`	The job identifier	String	path	Required

Status Codes

HTTP Status Code	Reason
200	OK
503	Analytics is disabled. See logs for more information.
500	Internal Server Error

Example

GET https://localhost:8075/api/reports/generate/systems-1day-20130628

Response
HTTP 1.1 200 OK

{
  "id" : "systems-1day-20130628",
  "type" : "pdf",
  "status" : "complete"
}

GET /api/reports/metrics

Summary

Check that the server is alive

Description

Returns 'OK'

Parameters

none

Status Codes

HTTP Status Code	Reason
200	OK

Return Value

String

GET /api/reports/metrics/fields

Summary

Gets a list of metric field names available for summary and timeline queries.

Description

Retrieves a set of metric fields for a metricGroupType that may be used when querying or interpreting the summary and timeline reports for that type. Valid metricGroupType are: SystemOverview, Service, Client, ServiceUsagePerClient, TargetServer. The metricType is the metric name. The aggreggateName is the metric name for the aggregated metricType.

Parameters

Parameter	Description	Data Type	Location	Required	Multiple
`metricGroupType`		String	query

Status Codes

HTTP Status Code	Reason
200	OK
503	Analytics is disabled. See logs for more information.
500	Internal Server Error

Returns Array

[ MetricField ]

Example

GET https://localhost:8075/api/reports/metrics/fields?metricGroupType=ServiceUsagePerClient

Response
HTTP 1.1 200 OK

[ {
  "metricType" : "exceptions",
  "aggregateName" : "totalExceptions"
}, {
  "metricType" : "failures",
  "aggregateName" : "totalFailures"
}, {
  "metricType" : "numMessages",
  "aggregateName" : "totalNumMessages"
}, {
  "metricType" : "successes",
  "aggregateName" : "totalSuccesses"
}, {
  "metricType" : "processingTime",
  "aggregateName" : "totalProcessingTime"
}, {
  "metricType" : "processingTimeMin",
  "aggregateName" : "minimumProcessingTimeMin"
}, {
  "metricType" : "processingTimeMax",
  "aggregateName" : "maximumProcessingTimeMax"
}, {
  "metricType" : "processingTimeAvg",
  "aggregateName" : "maximumProcessingTimeAvg"
} ]

GET /api/reports/metrics/groups/{typeName}

Summary

Gets a list of process groups.

Description

none

Parameters

Parameter	Description	Data Type	Location	Required
`typeName`	The metric group type name	String	path	Required
`value`		String	query
`query`	Optional query string		query

Status Codes

HTTP Status Code	Reason
200	OK
503	Analytics is disabled. See logs for more information.
500	Internal Server Error

Return Value

Collection<Map<String,String>>

Example

GET https://localhost:8075/api/reports/metrics/groups/SystemOverview

Response
HTTP 1.1 200 OK

[ {
  "value" : "System overview"
} ]

GET /api/reports/metrics/processes

Summary

Gets a list of processes available to query.

Description

none

Parameters

Parameter	Description	Data Type	Location	Required	Multiple
`value`		String	query
`query`	Optional query string		query

Status Codes

HTTP Status Code	Reason
200	OK
503	Analytics is disabled. See logs for more information.
500	Internal Server Error

Return Value

[{"value":"instance-1"}]

GET /api/reports/metrics/processgroups

Summary

Gets a list of process groups available to query.

Description

none

Parameters

Parameter	Description	Data Type	Location	Required	Multiple
`value`		String	query
`query`	Optional query string		query

Status Codes

HTTP Status Code	Reason
200	OK
503	Analytics is disabled. See logs for more information.
500	Internal Server Error

Return Value

[{"value":"DMZ"}]

GET /api/reports/metrics/summary/{id}/{level}

Summary

Produces a summary report

Description

The summary report aggregates metrics usage information over a specified period of time, between from and to, where from and to are date times in a URL encoded ISO-8601 combined date and time format (e.g. 2013-03-13T00%3A00%3A00Z).

Analytics reports name a set of fields that are grouped-by for the report, and metrics are aggregated for that group. At level 0, the summary report will aggregate all possible groups int he specified period of time. However, to provide drill-down (level 1), the summary report requires additional query parameters to select the specific group. The parameters depend on the group-by settings of the report.

This method returns an array where each item in the array is a set of attribute values that include the group by fields, as well as a aggregated values for metrics (see fields).

Parameters

Parameter	Description	Data Type	Location	Required
`id`	The custom report identifier	String	path	Required
`level`	The report level (0 or 1 for drill-through)	Integer	path	Required
`from`	The starting date/time for the report.	String	query	Required
`to`	The end date/time for the report.	String	query	Required
`GROUPNAME`	Specified at level 1, the group-by field for drill-down.	String	query
`INSTANCENAME`	Specified at level 1, the group-by field for drill-down.	String	query
`CLIENTNAME`	Specified at level 1, the group-by field for drill-down.	String	query
`SERVICENAME`	Specified at level 1, the group-by field for drill-down.	String	query
`HOSTNAME`	Specified at level 1, the group-by field for drill-down.	String	query
`PROTOCOLNAME`	Specified at level 1, the group-by field for drill-down.	String	query

Status Codes

HTTP Status Code	Reason
200	OK
503	Analytics is disabled. See logs for more information.
400	Bad Request
500	Internal Server Error

Example

GET https://localhost:8075/api/reports/metrics/summary/{id}/{level}?from=2013-06-26T23%3A00%3A00Z&to=2013-06-27T09%3A10%3A00Z&level=1&INSTANCENAME=instance-1&GROUPNAME=DMZ

Response
HTTP 1.1 200 OK

{
  "result" : [ {
    "totalNumClients" : 0,
    "totalExceptions" : 0,
    "INSTANCENAME" : "instance-1",
    "totalNumSLABreaches" : 0,
    "totalActive" : 6,
    "totalFailures" : 0,
    "totalSuccesses" : 0
  } ]
}

POST /api/reports/metrics/summary/{level}

Summary

Produces a summary report for a custom report

Description

Produces an aggregated summary report from a CustomReport. The report is not stored. At level 1, the drill-through requires that you choose values from the report's group-by and specify them as level 1 optional parameters.

Parameters

Parameter	Description	Data Type	Location	Required
`level`	The report level (0 or 1 for drill-through).	Integer	path	Required
`-`	The report for which to generate a summary.	CustomReport	body	Required
`from`	The starting date/time for the report.	String	query	Required
`to`	The end date/time for the report.	String	query	Required
`customReport`	The CustomReport for which to produce the report.	CustomReport	query	Required
`GROUPNAME`	Specified at level 1, the group-by field for drill-down.	String	query
`INSTANCENAME`	Specified at level 1, the group-by field for drill-down.	String	query
`CLIENTNAME`	Specified at level 1, the group-by field for drill-down.	String	query
`SERVICENAME`	Specified at level 1, the group-by field for drill-down.	String	query
`HOSTNAME`	Specified at level 1, the group-by field for drill-down.	String	query
`PROTOCOLNAME`	Specified at level 1, the group-by field for drill-down.	String	query

Status Codes

HTTP Status Code	Reason
200	OK
503	Analytics is disabled. See logs for more information.
400	Bad Request
500	Internal Server Error

Example

POST https://localhost:8075/api/reports/metrics/summary/{level}?from=2013-06-26T23%3A00%3A00Z&to=2013-06-27T09%3A10%3A00Z&level=1&INSTANCENAME=instance-1&GROUPNAME=DMZ

Response
HTTP 1.1 200 OK

{
  "result" : [ {
    "totalNumClients" : 0,
    "totalExceptions" : 0,
    "INSTANCENAME" : "instance-1",
    "totalNumSLABreaches" : 0,
    "totalActive" : 6,
    "totalFailures" : 0,
    "totalSuccesses" : 0
  } ]
}

GET /api/reports/metrics/timeline/{id}/{level}/{seriesName}

Summary

Produces a timeline report for a stored custom report

Description

Produces an timeline report from a stored CustomReport. The seriesName is a series name specified from the report. At level 1, the drill-through requires that you choose values from the report's group-by and specify them as level 1 optional parameters.

Parameters

Parameter	Description	Data Type	Location	Required
`id`	The stored report ID	String	path	Required
`level`	The report level (0 or 1 for drill-through).	Integer	path	Required
`seriesName`	The name of the metric for which to return a series (e.g. "numMessages").	string	path	Required
`from`	The starting date/time for the report.	String	query	Required
`to`	The end date/time for the report.	String	query	Required
`GROUPNAME`	Specified at level 1, the group-by field for drill-down.	String	query
`INSTANCENAME`	Specified at level 1, the group-by field for drill-down.	String	query
`CLIENTNAME`	Specified at level 1, the group-by field for drill-down.	String	query
`SERVICENAME`	Specified at level 1, the group-by field for drill-down.	String	query
`HOSTNAME`	Specified at level 1, the group-by field for drill-down.	String	query
`PROTOCOLNAME`	Specified at level 1, the group-by field for drill-down.	String	query

Status Codes

HTTP Status Code	Reason
200	OK
503	Analytics is disabled. See logs for more information.
400	Bad Request
500	Internal Server Error

Returns Class

MetricTimeline

Example

GET https://localhost:8075/api/reports/metrics/timeline/{id}/{level}/{seriesName}?from=2013-06-27T23%3A00%3A00Z&to=2013-06-28T08%3A36%3A00Z&level=0

Response
HTTP 1.1 200 OK

{
  "result" : {
    "name" : "successes",
    "series" : [ {
      "name" : "successes",
      "pointInterval" : 300000,
      "pointStart" : 1372374000000,
      "data" : [ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 ]
    } ]
  }
}

POST /api/reports/metrics/timeline/{level}/{seriesName}

Summary

Produces a timeline report for a custom report

Description

Produces an aggregated summary report from a CustomReport. The report is not stored. The seriesName is a series name specified from the report. At level 1, the drill-through requires that you choose values from the report's group-by and specify them as level 1 optional parameters.

Parameters

Parameter	Description	Data Type	Location	Required
`level`	The report level (0 or 1 for drill-through).	Integer	path	Required
`seriesName`	The name of the metric for which to return a series (e.g. "numMessages").	string	path	Required
`-`	The report for which to generate a timeline.	CustomReport	body	Required
`from`	The starting date/time for the report.	String	query	Required
`to`	The end date/time for the report.	String	query	Required
`GROUPNAME`	Specified at level 1, the group-by field for drill-down.	String	query
`INSTANCENAME`	Specified at level 1, the group-by field for drill-down.	String	query
`CLIENTNAME`	Specified at level 1, the group-by field for drill-down.	String	query
`SERVICENAME`	Specified at level 1, the group-by field for drill-down.	String	query
`HOSTNAME`	Specified at level 1, the group-by field for drill-down.	String	query
`PROTOCOLNAME`	Specified at level 1, the group-by field for drill-down.	String	query

Status Codes

HTTP Status Code	Reason
200	OK
503	Analytics is disabled. See logs for more information.
400	Bad Request
500	Internal Server Error

Returns Class

MetricTimeline

Example

POST https://localhost:8075/api/reports/metrics/timeline/{level}/{seriesName}?from=2013-06-27T23%3A00%3A00Z&to=2013-06-28T08%3A36%3A00Z&level=0

Response
HTTP 1.1 200 OK

{
  "result" : {
    "name" : "successes",
    "series" : [ {
      "name" : "successes",
      "pointInterval" : 300000,
      "pointStart" : 1372374000000,
      "data" : [ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 ]
    } ]
  }
}

POST /api/reports/schedule

Summary

Creates a scheduled report.

Description

Reports can be scheduled to run periodically.

Parameters

Parameter	Description	Data Type	Location	Required	Multiple
`-`	The report to schedule	Report	body	Required

Status Codes

HTTP Status Code	Reason
201	Created
400	Bad Request
503	Analytics is disabled. See logs for more information.
500	Internal Server Error

Returns Class

Report

Example

POST https://localhost:8075/api/reports/schedule

Request

{
  "name" : "systems-1day-${yyyyMMdd}.pdf",
  "type" : "pdf",
  "reportGroup" : "SystemOverview",
  "reportParameters" : {
    "print" : true,
    "level" : 0
  },
  "customReport" : {
    "id" : "",
    "name" : "Systems",
    "type" : "SystemOverview",
    "levels" : [ {
      "type" : "SystemOverview",
      "chart" : "line",
      "top" : { },
      "metrics" : [ {
        "name" : "successes",
        "visible" : true
      }, {
        "name" : "failures",
        "visible" : true
      }, {
        "name" : "exceptions",
        "visible" : true
      }, {
        "name" : "active",
        "visible" : true
      }, {
        "name" : "numSLABreaches",
        "visible" : true
      }, {
        "name" : "numClients",
        "visible" : true
      } ],
      "groupBy" : [ "INSTANCENAME", "GROUPNAME" ],
      "conditionGroups" : [ ]
    } ]
  },
  "email" : "somebody@acme.org",
  "enabled" : true,
  "range" : "today",
  "fromDate" : "today",
  "toDate" : "now",
  "scheduled" : "daily",
  "generateTime" : "09:00",
  "dayOfWeek" : "mon",
  "dayOfMonth" : "first",
  "lastRun" : 0,
  "timeout" : 30000
}

Response
HTTP 1.1 201 Created

{
  "id" : "Id-0001372322567916-ffffffffec92eba7-1",
  "name" : "systems-1day-${yyyyMMdd}.pdf",
  "type" : "pdf",
  "reportGroup" : "SystemOverview",
  "reportParameters" : {
    "print" : true,
    "level" : 0
  },
  "customReport" : {
    "id" : "",
    "name" : "Systems",
    "type" : "SystemOverview",
    "levels" : [ {
      "type" : "SystemOverview",
      "chart" : "line",
      "top" : { },
      "metrics" : [ {
        "name" : "successes",
        "visible" : true
      }, {
        "name" : "failures",
        "visible" : true
      }, {
        "name" : "exceptions",
        "visible" : true
      }, {
        "name" : "active",
        "visible" : true
      }, {
        "name" : "numSLABreaches",
        "visible" : true
      }, {
        "name" : "numClients",
        "visible" : true
      } ],
      "groupBy" : [ "INSTANCENAME", "GROUPNAME" ],
      "conditionGroups" : [ ]
    } ]
  },
  "email" : "somebody@acme.org",
  "enabled" : true,
  "range" : "today",
  "fromDate" : "today",
  "toDate" : "now",
  "scheduled" : "daily",
  "generateTime" : "09:00",
  "dayOfWeek" : "mon",
  "dayOfMonth" : "first",
  "lastRun" : 0,
  "timeout" : 30000
}

GET /api/reports/schedule

Summary

Gets a list of all the scheduled reports.

Description

none

Parameters

none

Status Codes

HTTP Status Code	Reason
200	OK
503	Analytics is disabled. See logs for more information.
500	Internal Server Error

Returns Array

[ Report ]

Example

GET https://localhost:8075/api/reports/schedule

Response
HTTP 1.1 200 OK

[ {
  "id" : "Id-0001372322567916-ffffffffec92eba7-1",
  "name" : "systems-1day-${yyyyMMdd}.pdf",
  "type" : "pdf",
  "reportGroup" : "SystemOverview",
  "reportParameters" : {
    "print" : true,
    "level" : 0
  },
  "customReport" : {
    "id" : "",
    "name" : "Systems",
    "type" : "SystemOverview",
    "levels" : [ {
      "type" : "SystemOverview",
      "chart" : "line",
      "top" : { },
      "metrics" : [ {
        "name" : "successes",
        "visible" : true
      }, {
        "name" : "failures",
        "visible" : true
      }, {
        "name" : "exceptions",
        "visible" : true
      }, {
        "name" : "active",
        "visible" : true
      }, {
        "name" : "numSLABreaches",
        "visible" : true
      }, {
        "name" : "numClients",
        "visible" : true
      } ],
      "groupBy" : [ "INSTANCENAME", "GROUPNAME" ],
      "conditionGroups" : [ ]
    } ]
  },
  "email" : "somebody@acme.org",
  "enabled" : true,
  "range" : "today",
  "fromDate" : "today",
  "toDate" : "now",
  "scheduled" : "daily",
  "generateTime" : "09:00",
  "dayOfWeek" : "mon",
  "dayOfMonth" : "first",
  "lastRun" : 0,
  "timeout" : 30000
} ]

GET /api/reports/schedule/{reportid}

Summary

Gets a scheduled report by ID.

Description

none

Parameters

Parameter	Description	Data Type	Location	Required	Multiple
`reportid`	The report identifier.	String	path	Required

Status Codes

HTTP Status Code	Reason
200	OK
503	Analytics is disabled. See logs for more information.
500	Internal Server Error

Returns Class

Report

Example

GET https://localhost:8075/api/reports/schedule/Id-0001372322567916-ffffffffec92eba7-1

Response
HTTP 1.1 200 OK

{
  "id" : "Id-0001372322567916-ffffffffec92eba7-1",
  "name" : "systems-1day-${yyyyMMdd}.pdf",
  "type" : "pdf",
  "reportGroup" : "SystemOverview",
  "reportParameters" : {
    "print" : true,
    "level" : 0
  },
  "customReport" : {
    "id" : "",
    "name" : "Systems",
    "type" : "SystemOverview",
    "levels" : [ {
      "type" : "SystemOverview",
      "chart" : "line",
      "top" : { },
      "metrics" : [ {
        "name" : "successes",
        "visible" : true
      }, {
        "name" : "failures",
        "visible" : true
      }, {
        "name" : "exceptions",
        "visible" : true
      }, {
        "name" : "active",
        "visible" : true
      }, {
        "name" : "numSLABreaches",
        "visible" : true
      }, {
        "name" : "numClients",
        "visible" : true
      } ],
      "groupBy" : [ "INSTANCENAME", "GROUPNAME" ],
      "conditionGroups" : [ ]
    } ]
  },
  "email" : "somebody@acme.org",
  "enabled" : true,
  "range" : "today",
  "fromDate" : "today",
  "toDate" : "now",
  "scheduled" : "daily",
  "generateTime" : "09:00",
  "dayOfWeek" : "mon",
  "dayOfMonth" : "first",
  "lastRun" : 0,
  "timeout" : 30000
}

PUT /api/reports/schedule/{reportid}

Summary

Updates a scheduled report by ID.

Description

none

Parameters

Parameter	Description	Data Type	Location	Required	Multiple
`reportid`	The report identifier.	String	path	Required
`-`	The report.	Report	body	Required

Status Codes

HTTP Status Code	Reason
200	OK
503	Analytics is disabled. See logs for more information.
500	Internal Server Error

Returns Class

Report

Example

PUT https://localhost:8075/api/reports/schedule/Id-0001372322567916-ffffffffec92eba7-1

Request

{
  "id" : "Id-0001372322567916-ffffffffec92eba7-1",
  "name" : "systems-1day-${yyyyMMdd}.pdf",
  "type" : "pdf",
  "reportGroup" : "SystemOverview",
  "reportParameters" : {
    "print" : true,
    "level" : 0
  },
  "customReport" : {
    "id" : "",
    "name" : "Systems",
    "type" : "SystemOverview",
    "levels" : [ {
      "type" : "SystemOverview",
      "chart" : "line",
      "top" : { },
      "metrics" : [ {
        "name" : "successes",
        "visible" : true
      }, {
        "name" : "failures",
        "visible" : true
      }, {
        "name" : "exceptions",
        "visible" : true
      }, {
        "name" : "active",
        "visible" : true
      }, {
        "name" : "numSLABreaches",
        "visible" : true
      }, {
        "name" : "numClients",
        "visible" : true
      } ],
      "groupBy" : [ "INSTANCENAME", "GROUPNAME" ],
      "conditionGroups" : [ ]
    } ]
  },
  "email" : "somebody@acme.org",
  "enabled" : true,
  "range" : "today",
  "fromDate" : "today",
  "toDate" : "now",
  "scheduled" : "daily",
  "generateTime" : "09:00",
  "dayOfWeek" : "mon",
  "dayOfMonth" : "first",
  "lastRun" : 0,
  "timeout" : 30000
}

Response
HTTP 1.1 200 OK

{
  "id" : "Id-0001372322567916-ffffffffec92eba7-1",
  "name" : "systems-1day-${yyyyMMdd}.pdf",
  "type" : "pdf",
  "reportGroup" : "SystemOverview",
  "reportParameters" : {
    "print" : true,
    "level" : 0
  },
  "customReport" : {
    "id" : "",
    "name" : "Systems",
    "type" : "SystemOverview",
    "levels" : [ {
      "type" : "SystemOverview",
      "chart" : "line",
      "top" : { },
      "metrics" : [ {
        "name" : "successes",
        "visible" : true
      }, {
        "name" : "failures",
        "visible" : true
      }, {
        "name" : "exceptions",
        "visible" : true
      }, {
        "name" : "active",
        "visible" : true
      }, {
        "name" : "numSLABreaches",
        "visible" : true
      }, {
        "name" : "numClients",
        "visible" : true
      } ],
      "groupBy" : [ "INSTANCENAME", "GROUPNAME" ],
      "conditionGroups" : [ ]
    } ]
  },
  "email" : "somebody@acme.org",
  "enabled" : true,
  "range" : "today",
  "fromDate" : "today",
  "toDate" : "now",
  "scheduled" : "daily",
  "generateTime" : "09:00",
  "dayOfWeek" : "mon",
  "dayOfMonth" : "first",
  "lastRun" : 0,
  "timeout" : 30000
}

DELETE /api/reports/schedule/{reportid}

Summary

Deletes a scheduled report by ID.

Description

none

Parameters

Parameter	Description	Data Type	Location	Required	Multiple
`reportid`	The report identifier.	String	path	Required

Status Codes

HTTP Status Code	Reason
204	No Content
503	Analytics is disabled. See logs for more information.
500	Internal Server Error