Relesys API Docs

v1.3

https://api.uat.relesystest.net/api/v1.3

Welcome

Introduction Getting access

Concepts

Scopes HTTP Status Codes Request Throttling Pagination Filtering Sorting Patch Requests Permissions Notifications Markdown Syntax Module Settings

Endpoints

Data Points

Get DataPoints
GET /dataSets/{dataSetId}/dataPoints 
https://api.uat.relesystest.net/api/v1.3/dataSets/{dataSetId}/dataPoints
Get a list of DataPoints by the DataSet Id
Scopes: relesys.api, relesys.api:read, relesys.api.kpis, relesys.api.kpis:read
URL Path
dataSetId string / guid required
Query String
dataValue double Filterable Sortable optional
departmentId string / guid Filterable optional
label string Filterable Sortable optional
timeStamp datetimeoffset Filterable Sortable optional
userId string / guid Filterable optional
sort string Comma separated sort order based on sortable properties optional
offset integer Offset value for use in pagination Default: 0 optional
limit integer Total objects to fetch (max 1000) Default: 200 optional
Responses
application/json
200
Schema Example
JSON
{"count":2,"data":[{"label":"Highest Basket Size","timeStamp":"2020-01-19T22:00:00+00:00","value":1337.0,"departmentId":"5ef2be97-a417-4426-8522-5d9acb54c901","userId":"d8d45a9e-4f84-4fd7-a796-2c0c41ad407f"},{"label":"NPS","timeStamp":"2020-01-19T22:00:00+00:00","value":0.9,"departmentId":"703d223f-e88a-4d1a-8507-a3bf4ed69b2c","userId":"b0f6f738-6879-4591-9a3d-5985e70968b2"}]}
object
  count integer      
  ⯈ data array[object]      
   departmentId string / guid      
   label string      
   timeStamp datetimeoffset      
   userId string / guid      
   value double      
  nextUrl string      
  previousUrl string