API Docs

Stats

Found 2 routes
POST

basicFetch

/api/v3/stats/fetch

Performs a basic fetch for a single entity. (available for Business / Enterprise)

If dateFrom & dateTo is not given, alltime stats are returned.
JSON parameters
Name Type Required Description
namespace string X namespace of the entity. Available: team, user, rid
entityId int X ID of the entity. Can be a UUID or a normal numeric ID
dateFrom string if provided stats will begin from this date, e.g. '2020-01-01' (=> stats starting from January 1, 2020)
dateTo string if provided stats will end at this date, e.g. '2020-01-30' (=> stats till January 30, 2020)
POST

overviewFetch

/api/v3/stats/overview-fetch

Performs an overview fetch for a single entity. (available for Business / Enterprise)

An overview fetch is a fetch which divides the provided date range into smaller intervals which then get summarized.
This is useful especially for dashboards which want to show a good stats overview.
JSON parameters
Name Type Required Description
namespace string X namespace of the entity. Available: team, user, rid
entityId int X ID of the entity. Can be a UUID or a normal numeric ID
dateFrom string X stats will begin from this date, e.g. '2020-01-01' (=> stats starting from January 1, 2020)
dateTo string X stats will end at this date, e.g. '2020-01-30' (=> stats till January 30, 2020)