The LiveRamp Clean Room API enables you to set up and manage clean rooms and create and run clean room queries without going through the UI. This is most useful for performing actions in bulk or for integrating Clean Room API features directly into your own platform.
Setting up Data Connections
You can use the API to set up data connections.
- Get the necessary data source information with the Data Sources Endpoint.
- Create or update data source credentials with the Credential Sources Endpoint.
- Create, manage, or delete data connections with the Data Connections Endpoint.
- Create, update, and delete organization credentials with the Organization Credentials Endpoint.
Creating and Managing Clean Rooms
With the Clean Rooms Endpoint, you can:
- Create, update, and delete clean rooms.
- Configure clean room datasets.
- Invite partners to a clean room, update partner details, or cancel invitations.
- Add or remove clean room users and manage their clean room roles. (You can use the Organization Users Endpoint get a list of users who can be added.)
- Create clean room measurement reports.
Creating and Managing Questions
- Create, update, or delete questions with the Questions Endpoint.
- Add existing questions to a clean room with the Clean Rooms Endpoint.
- Configure question datasets and permissions, schedule or start question runs, and distribute question results with the Clean Room Questions Endpoint.
Clean Room Python SDK
The LiveRamp Clean Room Python SDK is a Python client for the Clean Room platform that lets developers programmatically manage questions, run analyses, and orchestrate data flows without using the LiveRamp UI or making individual API calls.
You can use the SDK to automate common Clean Room workflows, such as the following:
- Discover clean room assets and datasets.
- Execute question runs, check status, and fetch results data.
- Attach questions to a specific clean room, assign datasets and fields, and remove them when needed.
- Create, retrieve, update, and delete organization-level question templates.
- Create or update flows, assign datasets to flow nodes, inspect flow details, and run or replay flows.
You might prefer using the SDK’s config object code samples, such as CreateQuestionConfig and QuestionRunConfig, rather than making granular API requests and building or parsing each JSON payload.
OpenAPI Specification
You can download the latest LiveRamp Clean Room OpenAPI specification here.
llms.txt
This API's llms.txt file supports AI workflows. For more information, see llmstxt.org.