Brand Lift Study API reference
To manage testing and production-release processes, the Brand Lift API uses two sets of APIs: one for setting up your brand lift study workflow, and another set for testing your workflow in the sandbox environment. Here's what you need to know:
- When you first set up your brand lift study workflow, you must use the sandbox environment.
- To use the production environment, you must receive approval from your Technical Account Manager.
- You can test your workflow only in the sandbox environment.
IMPORTANT: The Brand Lift Study API uses token authentication with only standard tokens from The Trade Desk.
To specify which environment to make calls to, use the base URL, as shown in the following table.
| Environment | Base URL |
|---|---|
| Sandbox | https://ext-api.sb.thetradedesk.com/brandlift-sb |
| Production | https://gateway.gen.adsrvr.org/brandlift |
Brand Lift Study endpoints
The following table lists all the endpoints for the Brand Lift Study API for managing studies and sending reports to the platform.
| Endpoint | Description |
|---|---|
| GET /api/v1/study | Retrieve a list of studies that were updated after a specified date. |
| GET /api/v1/study/studyid | Retrieve a specific study by its ID. |
| PATCH /api/v1/study/{studyId}/version | Update the status of a study. |
| POST /api/v1/study/{studyId}/report | Send an aggregated report of the study to the platform. |
| POST /api/v1/study/{studyId}/report-file | Upload a report of the study to the platform. |
| GET /api/v1/study/{studyId}/report | Retrieve the latest aggregated report of a study. |
| GET /api/v1/study/{studyId}/report-file | Retrieve the latest report of the study. |
| GET /api/v1/study/{studyId}/attachment/{attachmentId} | Download an attachment that is associated with a question of a study. |
Brand lift test study endpoints
During your workflow setup process, you can create and manage test studies and use their IDs to retrieve their status and update their end date. The following table lists all of the endpoints for creating and managing test studies. For details, see Create and manage test studies.
IMPORTANT: You can use these endpoints only in the sandbox environment.
| Endpoint | Description |
|---|---|
| GET /api/v1/test/study/get-provider-id | Retrieve your provider ID. TIP: You can use this endpoint to test your authentication token in the sandbox environment. |
| POST /api/v1/test/study/create-random-test-study | Create a test study. |
| POST /api/v1/test/study/update-study/{studyId} | Update the end date of a test study by its ID. |
| POST /api/v1/test/study/turnoff-study/{studyId} | Turn off a test study by its ID. |
For response details that some endpoints return, see Study object. For details about how to integrate with the platform, see Brand lift study integration guide.