Start report export task

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)

type?string

export type: 'csv' to download as table, 'raw' to export as JSON

Default"raw"

Value in"raw" | "csv"

Response Body

`application/json`

curl -X POST "https://example.com/v1/studies/string/data-exporter/reports/"

{
  "task": {
    "id": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "updatedAt": "2019-08-24T14:15:22Z",
    "status": "string",
    "targetCount": 0,
    "processedCount": 0,
    "resultFile": "string",
    "fileType": "string",
    "error": "string"
  }
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}

Start report export task

Authorization

Path Parameters

Query Parameters

Response Body

200application/json

400application/json

401application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`