POST /api/v1/study/{studyId}/report-file

Send a report file of a study that advertisers can download from the platform. For details about the different options available for sending reports, see Brand lift study integration guide.

Here's what you need to know about sending report files:

The maximum file size is 10 MB.
Uploading a new file overwrites the current one even if both files have different names or types.
Supported file types include the following: PDF, PPT, PPTX, XLS, XLSX.

Path parameters

The following table lists the path parameters that you need to provide to make a request.

Parameter	Required?	Data Type	Description
`studyId`	Required	String	The ID of the study of which you want to update the status.

Request example

To upload a file of a brand lift survey report, in a POST /api/v1/study/{studyId}/report-file call, include the multipart form data of your file.

{
    "file":"/path/survey/results.pdf"
}

A successful response returns an empty object, which indicates the file was uploaded.

Request properties

The following table lists the POST /api/v1/study/{studyId}/report-file request property.

Parameter	Required?	Data Type	Description
`file`	Required	String	The destination path of the file you want to upload.

Error codes and messages

The following table provides a list of common errors and their respective HTTP error codes.

HTTP Code	Status	Description
404	Bad Request	The study was not found or the provider was mismatched.
409	Bad Request	The version was mismatched or the new status is not supported. The status must be one of the supported status values.
413	Bad Request	The file size exceeds 10 MB.
415	Bad Request	Invalid file type.