CASE FrameworkCASE Framework

List reports

GET
/v1/studies/{studyKey}/data-explorer/reports/

Authorization

BearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

studyKey*string

Query Parameters

reportKey?string

filter by report key

pid?string

filter by participant ID

from?integer

filter by timestamp (greater than or equal to this value)

until?integer

filter by timestamp (less than or equal to this value)

page?integer

page number (starting from 1)

Default1
Range1 <= value
limit?integer

maximum number of reports per page

Default10
Range1 <= value
filter?

bson.M object to filter files

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/studies/string/data-explorer/reports/"
{
  "reports": [
    {
      "id": "string",
      "key": "string",
      "participantID": "string",
      "responseID": "string",
      "timestamp": 0,
      "modifiedAt": "2019-08-24T14:15:22Z",
      "data": [
        {
          "key": "string",
          "value": "string",
          "dtype": "date"
        }
      ]
    }
  ],
  "pagination": {
    "totalCount": 0,
    "currentPage": 0,
    "totalPages": 0,
    "pageSize": 0
  }
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}