Fibion Report API (BETA)

Fibion Report resources can be delivered to end users, researchers, intermediaries, or apps in multiple ways: desktop, mobile, print, data, or custom method. This document describes the parameters, syntaxes, and examples of the different methods of accessing the reports. Fibion Report API is an HTTP GET API for singular report resources, i.e. the resources are consumed one at a time. No authentication is required. The report resources are always anonymized.

Get Started

Fibion Report API is available as beta. A web browser or a programmatic API client can be used to access the resources.

Syntax

https://beta.fibion.com/report/{id}[/param1/param2/...]

Desktop

This is the default method for accessing the online reports from a web browser.

Parameters

• id: report id
• language: {default=en,fi,de,sv}
• type: {watch,energy,recommendation,health,goal}

Syntax

https://beta.fibion.com/report/{id}[/{language}][#{type}]

Examples

View online reports in English (default):
https://beta.fibion.com/report/B5p4GzhDfaKV

View online reports in Finnish with the Activity Balance report as a starting view:
https://beta.fibion.com/report/B5p4GzhDfaKV/fi#health

Mobile

This is a method that can be used to access the mobile-friendly versions of the report resources.

Parameters

• id: report id
• mobile: mobile version
• type: {watch,energy,recommendation,health,when omitted=all}

Syntax

https://beta.fibion.com/report/{id}/mobile[/type]

Examples

View mobile reports (default):
https://beta.fibion.com/report/B5p4GzhDfaKV/mobile

View mobile Energy Expenditure report:
https://beta.fibion.com/report/B5p4GzhDfaKV/mobile/energy

Print

This is a method that can be used to access the printer-friendly versions of the report resources.

Parameters

• id: report id
• type: {summary,goals,text}
• view_mode: {full,when omitted=lightbox}
• format: {pdf,when omitted=html}
• language: {default=en,fi,de,sv}

Syntax

https://beta.fibion.com/report/{id}[/{type}][/{view_mode}][/{format}][/{language}]

Examples

Download Report Summary in English (default) as PDF:
https://beta.fibion.com/report/B5p4GzhDfaKV/summary/pdf

View Goal Summary in Finnish in full screen:
https://beta.fibion.com/report/B5p4GzhDfaKV/goals/full/fi

View Text Format in German in a lightbox on top of the Desktop reports:
https://beta.fibion.com/report/B5p4GzhDfaKV/text/de

Data

This is a method that researchers can use to access the report data for further analysis. API clients can consume the data directly from the endpoint, too. The data is available in CSV and JSON.

Parameters

• id: report id
• resource: {results,tsrs,ctsrs}
  • results: daily, average, and total sum data of the analysis
  • tsrs: timeseries data of the activity watch (5min avg blocks)
  • ctsrs: timeseries data of the activity watch (1h avg blocks)
• format: {csv,json}

Syntax

https://beta.fibion.com/report/{id}[/{resource}][/{format}]

Examples

Download the results data as CSV
https://beta.fibion.com/report/B5p4GzhDfaKV/results/csv

Download the timeseries data (5min avg blocks) as JSON
https://beta.fibion.com/report/B5p4GzhDfaKV/tsrs/json

Download the timeseries data (1h avg blocks) as CSV
https://beta.fibion.com/report/B5p4GzhDfaKV/5cir2a/ctsrs/csv

Custom Method

Partner up with Fibion and get your custom method to access the reports. Contact us: contact@fibion.com.