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:

report/?record=1,2&include_metrics=1,3
The available list of metrics is found at: metric

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

A comma separated list of ranges: report/?range=7535,8157&include_metrics=1
A comma separated list of records: report/?record=23512,24086&include_metrics=1
User and timerange: report/?user=1511&start=350049484800&end=350735155200&include_metrics=1
Note: the start field is rounded down to the previous hour, the end field is rounded up to the next hour.
You may further filter timerange data by trainingroutine: report/?user=1511&start=350049484800&end=350735155200&trainingroutine=1,2&include_metrics=1
Or by activitytype: report/?user=1511&start=350049484800&end=350735155200&activitytype=1,2&include_metrics=1

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

All data grouped together: report/?user=athlete@hexoskin.com&include_metrics=1&start=350049484800&end=350735155200&group_by=grouped
Grouped by range: report/?user=athlete@hexoskin.com&include_metrics=1&start=350049484800&end=350735155200&group_by=range
Grouped by record: report/?user=athlete@hexoskin.com&include_metrics=1&start=350049484800&end=350735155200&group_by=record
Grouped by activitytype: report/?user=athlete@hexoskin.com&include_metrics=1&start=350049484800&end=350735155200&group_by=activitytype
Grouped by category: report/?user=athlete@hexoskin.com&include_metrics=1&start=350049484800&end=350735155200&group_by=category
Grouped by trainingroutine: report/?user=athlete@hexoskin.com&include_metrics=1&start=350049484800&end=350735155200&group_by=trainingroutine

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

hour: report/?user=athlete@hexoskin.com&include_metrics=1&start=350049484800&end=350735155200&group_by=time&time=hours
hour_record: report/?record=23512&group_by=time&time=hours
hour_range: report/?range=7535&group_by=time&time=hours
day: report/?user=athlete@hexoskin.com&include_metrics=1&start=350049484800&end=350735155200&group_by=time&time=days
week: report/?user=athlete@hexoskin.com&include_metrics=1&start=350049484800&end=350735155200&group_by=time&time=weeks
month: report/?user=athlete@hexoskin.com&include_metrics=1&start=350049484800&end=350735155200&group_by=time&time=months
year: report/?user=athlete@hexoskin.com&include_metrics=1&start=350049484800&end=350735155200&group_by=time&time=years
When the data are regouped by a period, the results can be returned in a vector fashion by specifying display=vector: report/?user=athlete@hexoskin.com&include_metrics=1&start=350049484800&end=350735155200&group_by=time&time=weeks&display=vector Some metrics represent histograms (the type of the metric is 'histogram'). The report returns a histogram for these metrics.
An heart rate histogram: report/?record=23512,24086&include_metrics=45

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:

range/?id__in=7535,8157&include_metrics=20,22

This resource supports responses in a text/csv format:

Use the Accept header to specify the text/csv output format
Use one of the following api calls report/?range=7535, report/?record=23512

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

This field is required.

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
end: exact
group_by: exact, day
grouped: exact
include_autodetected: true
include_metrics: exact, in
range: exact, in
record: exact, in
start: exact
time: exact, day
trainingroutine: exact, in, isnull
user: exact, in

Sorting Options

No sorting supported