home api list

Hexostore API Documentation

report

/api/report/

List methods: get

Detail methods: None

Generate a report.

In the argument, the field include_metrics define the metrics you want to return:

The arguments range, record, user, start, end, trainingroutine, and activitytype define what data will be analyzed:

In the arguments, you may use the group_by field to group the returned data in various ways:

In the arguments, the field time can also be used to grouped the data by the following periods:

Some metrics represent histograms (the type of the metric is 'histogram'). The report returns a histogram for these metrics.

If you wish to access Metrics by range or record, it is simpler to include the argument include_metrics to the request for the desired objects:

This resource supports responses in a text/csv format:

Fields

activitytype:

list of activitytype used in conjunction with "user", "start" and "end" to filter what data will be analysed

This field may be null

category:

list of category used in conjunction with "user", "start" and "end" to filter what data will be analysed

This field may be null

end:

An integer indicating the number of 256ths of a second that have passed since Jan 1, 1970 UTC, ie. a traditional timestamp, multiplied by 256. The value will be ceil to the next UTC hour.

This field may be null

include_metrics:

List of metric IDs that specify the metrics that will be extracted

range:

list of range on which the metrics are extracted

This field may be null

record:

list of record on which the metrics are extracted

This field may be null

resource_uri:

The unique URI where the object resides.

This field is readonly.

start:

An integer indicating the number of 256ths of a second that have passed since Jan 1, 1970 UTC, ie. a traditional timestamp, multiplied by 256. The value will be floor to the previous UTC hour.

This field may be null

trainingroutine:

list of trainingroutine used in conjunction with "user", "start" and "end" to filter what data will be analysed

This field may be null

Filtering Options

activitytype: exact, in, isnull

category: exact, in

display: exact

'vector'. Display result as vector

end: exact

group_by: exact, day

grouped: exact

include_autodetected: true

If true, return ranges done with autodetection algorithm

include_metrics: exact, in

range: exact, in

record: exact, in

start: exact

time: exact, day

trainingroutine: exact, in, isnull

user: exact, in

User on which the metrics are extracted

Sorting Options

No sorting supported

© 2014 by CarrĂ© Technologies Inc.