5.348 Fields: Report Samples

See the associated Reports resource section for more information on how to use this resource and supported operations.

Additional references

Type	Value	Additional information
Permissions resource	reports/samples	Permissions
Hooks filename	reports.samples.groovy	Pre- and Post-Processing Hooks
Distinct query-supported	Yes	Distinct

API version 3

Sample

A single snapshot of system state. It can contain all the same information as Datapoint.data in the sample's data field.

Field Name	Type	POST	Description
id	Long	No
agent	String	No	A unique identifier for the agent that recorded this sample.
data	Map<String, Map>	No	Arbitrary data that was recorded for this sample. Defaults to an empty object if none is supplied.
timestamp	Date	No	The date and time at which this sample was recorded. Defaults to the current date if none is supplied.

API version 2

Sample

A single snapshot of system state. It can contain all the same information as Datapoint.data in the sample's data field.

Field Name	Type	POST	Description
id	Long	No
agent	String	No	A unique identifier for the agent that recorded this sample.
data	Map<String, Map>	No	Arbitrary data that was recorded for this sample. Defaults to an empty object if none is supplied.
timestamp	Date	No	The date and time at which this sample was recorded. Defaults to the current date if none is supplied.