# AbiliTec API Documentation > The AbiliTec API is a secure, real-time interface that provides direct access to AbiliTec, the LiveRamp industry-leading offline identity-matching service. ## API Reference - [The Basics](https://developers.liveramp.com/abilitec-api/reference/the-basics.md): Learn about the AbiliTec API. - [The AbiliTec Identity Graph](https://developers.liveramp.com/abilitec-api/reference/the-abilitec-identity-graph-2.md): Learn about the AbiliTec Identity Graph, how it's used by the AbiliTec API, and how it's updated. - [AbiliTec Identifiers](https://developers.liveramp.com/abilitec-api/reference/abilitec-identifiers-1.md): Learn about the AbiliTec identifiers returned for API calls, including ID types and versions. - [Single Transaction and Batch Request Calls](https://developers.liveramp.com/abilitec-api/reference/single-transaction-and-batch-request-calls.md) - [About AbiliTec Identity Resolution](https://developers.liveramp.com/abilitec-api/reference/about-abilitec-identity-resolution-1.md): Learn how AbiliTec identity resolution works. - [Data You Can Send](https://developers.liveramp.com/abilitec-api/reference/data-you-can-send.md): Learn about the data you can send in an AbiliTec API call. - [Data That is Returned](https://developers.liveramp.com/abilitec-api/reference/data-that-is-returned.md): Learn about the data the API returns, including AbiliTec IDs and match metadata. - [Authentication](https://developers.liveramp.com/abilitec-api/reference/getting-started.md): Learn about the AbiliTec API authentication process. - [Request an Access Token](https://developers.liveramp.com/abilitec-api/reference/request-an-access-token-1.md): You need an access token to use the AbiliTec API. - [Rate Limits](https://developers.liveramp.com/abilitec-api/reference/rate-limits.md) - [About Response Documents](https://developers.liveramp.com/abilitec-api/reference/about-response-documents-1.md): Learn about the types of data that are returned. - [Entity Documents](https://developers.liveramp.com/abilitec-api/reference/entity-documents-1.md) - [Group Documents](https://developers.liveramp.com/abilitec-api/reference/group-documents-1.md) - [Batch Documents](https://developers.liveramp.com/abilitec-api/reference/batch-documents-1.md) - [Error Documents](https://developers.liveramp.com/abilitec-api/reference/error-documents-1.md) - [About Data Bundles](https://developers.liveramp.com/abilitec-api/reference/about-data-bundles-1.md): Learn how AbiliTec API data bundles organize response data. - [AbiliTec ID Bundles](https://developers.liveramp.com/abilitec-api/reference/abilitec-id-bundles-1.md): Learn about the different types of AbiliTec ID bundles. - [Metadata Bundles](https://developers.liveramp.com/abilitec-api/reference/metadata-bundles-1.md) - [contactFlags Bundle](https://developers.liveramp.com/abilitec-api/reference/contactflags-bundle-1.md) - [emailInsights Bundle](https://developers.liveramp.com/abilitec-api/reference/emailinsights-bundle-1.md) - [matchMetadata Bundle](https://developers.liveramp.com/abilitec-api/reference/matchmetadata-bundle-1.md) - [validationErrors Bundle](https://developers.liveramp.com/abilitec-api/reference/validationerrors-bundle-1.md) - [Match Endpoint](https://developers.liveramp.com/abilitec-api/reference/match-endpoint.md): Use the Match endpoint to send plaintext PII. - [Match Endpoint - Single Transaction Calls](https://developers.liveramp.com/abilitec-api/reference/match-single-transaction-calls.md) - [Match Endpoint - Batch Request Calls](https://developers.liveramp.com/abilitec-api/reference/match-batch-request-calls.md) - [Lookup Endpoint](https://developers.liveramp.com/abilitec-api/reference/lookup-endpoints-1.md): Use the Lookup endpoint when you don't want to send plaintext PII. - [Lookup Endpoint - Single Transaction Calls](https://developers.liveramp.com/abilitec-api/reference/lookup-endpoint-single-transaction.md): Make single transaction calls to the lookup endpoint to match an individual record. - [Lookup Endpoint - Batch Request Calls](https://developers.liveramp.com/abilitec-api/reference/batch-request-endpoint-lookup.md): Make batch request calls to the lookup endpoint to match multiple records in one call. ## Changelog - [Authentication Upgrade](https://developers.liveramp.com/abilitec-api/changelog/authentication-upgrade.md) - [Added llms.txt](https://developers.liveramp.com/abilitec-api/changelog/added-llmstxt.md) - [New AbiliTec API Documentation Structure](https://developers.liveramp.com/abilitec-api/changelog/new-abilitec-api-documentation-structure.md) - [AbiliTec API Security Enhancements](https://developers.liveramp.com/abilitec-api/changelog/identity-api-security-enhancements.md) - [Return derived links when hashed input does not match any maintained links](https://developers.liveramp.com/abilitec-api/changelog/return-derived-links-when-hashed-input-does-not-match-any-maintained-links.md) - [Update to Error Documents](https://developers.liveramp.com/abilitec-api/changelog/update-to-error-documents.md) # Activation API Documentation > The LiveRamp Activation API offers programmatic access to LiveRamp advanced marketing solutions. ## API Reference - [The Basics](https://developers.liveramp.com/activation-api/reference/distribution-api-overview.md): Learn about the Activation API. - [Basic Integration](https://developers.liveramp.com/activation-api/reference/basic-level-integration-example-1.md): Learn about distributing one segment to a single destination. - [Advanced Integration](https://developers.liveramp.com/activation-api/reference/advanced-level-integration-example.md): Learn about distributing multiple segments to multiple destination accounts. - [Uploading Files to LiveRamp](https://developers.liveramp.com/activation-api/reference/uploading-files-to-liveramp-1.md): Learn about the file format requirements for uploading files. - [About the Activation API Authentication](https://developers.liveramp.com/activation-api/reference/getting-started-1.md): Learn what's required to use the Activation API. - [Request an Access Token](https://developers.liveramp.com/activation-api/reference/oauth2defaultv1token.md): The Activation API requires an access token for you and your customers. - [Customer Access](https://developers.liveramp.com/activation-api/reference/customer-access.md): Learn how to set up access for your customer. - [Segments](https://developers.liveramp.com/activation-api/reference/segment-related-capabilities-1.md): Use the Activation API to return information about segments. - [Configure Distributions](https://developers.liveramp.com/activation-api/reference/destination-account-related-capabilities-1.md): Use the Activation API to manage integration connections. - [Distribute Data](https://developers.liveramp.com/activation-api/reference/distribution-related-capabilities-1.md): Use the Activation API to manage segment data distributions. - [Fetch a list of Destinations](https://developers.liveramp.com/activation-api/reference/get-v2destinations.md) - [Fetch a single Destination](https://developers.liveramp.com/activation-api/reference/get-v2destination.md) - [Fetch a list of Integrations within a Destination](https://developers.liveramp.com/activation-api/reference/get-v2destinationintegrations.md) - [Fetch a single Integration](https://developers.liveramp.com/activation-api/reference/get-v2destinationintegration.md) - [Create an Integration Connection](https://developers.liveramp.com/activation-api/reference/create-v2integrationconnection.md) - [Update an Integration Connection](https://developers.liveramp.com/activation-api/reference/modify-v2integrationconnection.md) - [Fetch a list of Integration Connections](https://developers.liveramp.com/activation-api/reference/get-v2integrationconnections.md) - [Fetch a single Integration Connection](https://developers.liveramp.com/activation-api/reference/get-v2integrationconnection.md) - [Delete an Integration Connection](https://developers.liveramp.com/activation-api/reference/delete-v2integrationconnection.md) - [Create a Distribution Manager](https://developers.liveramp.com/activation-api/reference/create-v2distributionmanager.md) - [Update a Distribution Manager](https://developers.liveramp.com/activation-api/reference/modify-v2distributionmanager.md) - [Fetch a list of Distribution Managers](https://developers.liveramp.com/activation-api/reference/get-v2distributionmanagers.md) - [Fetch a single Distribution Manager](https://developers.liveramp.com/activation-api/reference/get-v2distributionmanager.md) - [Delete a Distribution Manager](https://developers.liveramp.com/activation-api/reference/delete-v2distributionmanager.md) - [Add Segments to a Distribution Manager. Limited to 500 segments at a time.](https://developers.liveramp.com/activation-api/reference/create-v2distributionmanagersegmentconfigs.md) - [Fetch a list of Segments within a Distribution Manager](https://developers.liveramp.com/activation-api/reference/get-v2distributionmanagersegmentconfigs.md) - [Fetch a single Segment within a Distribution Manager](https://developers.liveramp.com/activation-api/reference/get-v2distributionmanagersegmentconfig.md) - [Remove Segments from a Distribution Manager. Limited to 500 segments at a time.](https://developers.liveramp.com/activation-api/reference/delete-v2distributionmanagersegmentconfigs.md) - [Fetch a list of Deliveries](https://developers.liveramp.com/activation-api/reference/get-v2deliveries.md) - [OAuth Configuration](https://developers.liveramp.com/activation-api/reference/oauth-configuration.md) - [Begin an OAuth authorization flow](https://developers.liveramp.com/activation-api/reference/create-v2oauthconnectionattempt-1.md) - [Fetch a list of OAuth Connections](https://developers.liveramp.com/activation-api/reference/get-v2oauthconnections-1.md) - [Fetch a single OAuth Connection](https://developers.liveramp.com/activation-api/reference/get-v2oauthconnection-1.md) - [Fetch the status of an OAuth flow](https://developers.liveramp.com/activation-api/reference/get-v2oauthconnectionattempt-1.md) - [Fetch a list of Segments' statuses.](https://developers.liveramp.com/activation-api/reference/get-v2segmentstatuses.md): Limited to either first-party (onboarding) or data marketplace segments. Exactly one of these segmentID params must be passed in - [Fetch a list of Segments](https://developers.liveramp.com/activation-api/reference/get-v2segments.md) - [Fetch a single Segment](https://developers.liveramp.com/activation-api/reference/get-v2segment.md) ## Changelog - [Added OpenAPI Specification](https://developers.liveramp.com/activation-api/changelog/added-openapi-specification.md) - [Added llms.txt](https://developers.liveramp.com/activation-api/changelog/added-llmstxt.md) - [New OAuth Status for Integration Connections](https://developers.liveramp.com/activation-api/changelog/new-oauth-status-for-integration-connections.md) - [New Activation API Documentation Structure](https://developers.liveramp.com/activation-api/changelog/new-activation-api-documentation-structure.md) - [New URL for Activation API Access Tokens](https://developers.liveramp.com/activation-api/changelog/new-url-for-activation-api-access-tokens.md) - [LR-Org-Id replaces LR-Customer-Id](https://developers.liveramp.com/activation-api/changelog/lr-org-id-replaces-lr-customer-id.md) # Authenticated Traffic Solution API Documentation > LiveRamp's Authenticated Traffic Solution provides a safe, addressable channel to the programmatic advertising ecosystem. ## Guides - [The Basics](https://developers.liveramp.com/authenticatedtraffic-api/docs/the-basics.md): Learn about the Authenticated Traffic Solution. - [Implementation Methods](https://developers.liveramp.com/authenticatedtraffic-api/docs/implementation-methods.md): Learn how you can integrate ATS into your inventory. - [1. Obtain a Placement ID](https://developers.liveramp.com/authenticatedtraffic-api/docs/1-obtain-a-placement-id.md) - [2. Provide a Valid Consent String](https://developers.liveramp.com/authenticatedtraffic-api/docs/2-provide-a-valid-consent-string.md) - [3. Prepare the Identifiers](https://developers.liveramp.com/authenticatedtraffic-api/docs/3-prepare-the-identifiers.md) - [4. Call the ATS Envelope API](https://developers.liveramp.com/authenticatedtraffic-api/docs/4-call-the-ats-envelope-api.md) - [5. Store the Identity Envelope With a Timestamp](https://developers.liveramp.com/authenticatedtraffic-api/docs/5-store-the-identity-envelope.md) - [6. Return Stored Identity Envelopes](https://developers.liveramp.com/authenticatedtraffic-api/docs/6-return-stored-rampid-eenvelopes.md) - [7. Implement the ATS Refresh Envelope API](https://developers.liveramp.com/authenticatedtraffic-api/docs/7-implement-the-ats-refresh-envelope-api.md) - [8. Configure Your Programmatic Advertising Solution](https://developers.liveramp.com/authenticatedtraffic-api/docs/8-configure-your-programmatic-advertising-solution.md) - [Best Practices](https://developers.liveramp.com/authenticatedtraffic-api/docs/about-the-ats-api.md): Learn about the normalization and hashing of identifiers. - [ATS API Implementation Guide for Mobile Publishers](https://developers.liveramp.com/authenticatedtraffic-api/docs/ats-api-implementation-guide-for-mobile-publishers.md) - [Pass Mobile Identity Envelopes to the Bidstream](https://developers.liveramp.com/authenticatedtraffic-api/docs/pass-mobile-envelopes-to-the-bidstream.md) - [Secure Signals for Mobile Publishers ](https://developers.liveramp.com/authenticatedtraffic-api/docs/secure-signals-for-mobile-publishers.md) - [Implement a Custom GMA Adapter for iOS](https://developers.liveramp.com/authenticatedtraffic-api/docs/implement-a-custom-gma-adapter-for-liveramp-secure-signals-ios.md) - [Implement a Custom GMA Adapter for Android](https://developers.liveramp.com/authenticatedtraffic-api/docs/implement-a-custom-gma-adapter-for-android.md) - [Test Your Custom GMA Adapter (Android)](https://developers.liveramp.com/authenticatedtraffic-api/docs/test-and-troubleshooting-information-for-custom-gma-adapter.md) - [Google Secure Signals for Web Publishers](https://developers.liveramp.com/authenticatedtraffic-api/docs/google-secure-signals-for-publishers.md) - [ATS Direct](https://developers.liveramp.com/authenticatedtraffic-api/docs/implement-ats-direct-via-api.md): Learn how to implement ATS Direct with direct API calls - [Google PAIR](https://developers.liveramp.com/authenticatedtraffic-api/docs/google-pair.md) - [Server-to-Server Implementation for Google PAIR](https://developers.liveramp.com/authenticatedtraffic-api/docs/server-to-server-implementation-for-google-pair.md): Learn how you can implement Google PAIR in a server-to-server environment - [The Online Conversions API Connectors](https://developers.liveramp.com/authenticatedtraffic-api/docs/the-online-conversions-api-program-for-api-implementation.md): Learn how you can implement LiveRamps's Online CAPI to send conversion data to multiple platforms. - [About the Android ATS Mobile SDK](https://developers.liveramp.com/authenticatedtraffic-api/docs/ats-mobile-sdk-for-android.md) - [1. Add ATS Mobile SDK to Project](https://developers.liveramp.com/authenticatedtraffic-api/docs/add-android-ats-mobile-sdk-to-project.md) - [2. Initialize the Android SDK](https://developers.liveramp.com/authenticatedtraffic-api/docs/initialize-android-ats-sdk.md) - [3. Call the APIs](https://developers.liveramp.com/authenticatedtraffic-api/docs/android-api-reference.md) - [ATS Mobile SDK Events](https://developers.liveramp.com/authenticatedtraffic-api/docs/android-sdk-events.md): See all the events exposed by Android ATS Mobile SDK. - [About the iOS ATS Mobile SDK](https://developers.liveramp.com/authenticatedtraffic-api/docs/ats-mobile-sdk-for-ios.md) - [1. Add the LRAtsSDK to Project](https://developers.liveramp.com/authenticatedtraffic-api/docs/add-the-ios-sdk-to-your-project.md): Learn the first step of LiveRamp's iOS Mobile SDK implementation. - [2. Initialize the iOS SDK](https://developers.liveramp.com/authenticatedtraffic-api/docs/intilialize-the-ios-sdk.md) - [3. Call the APIs](https://developers.liveramp.com/authenticatedtraffic-api/docs/ios-api-reference-1.md) - [Methods](https://developers.liveramp.com/authenticatedtraffic-api/docs/ios-api-reference.md): Learn all the available methods for iOS you utilize with ATS Mobile SDK. - [Properties](https://developers.liveramp.com/authenticatedtraffic-api/docs/ios-sdk-properties.md): See various properties of the LRAtsSDK for iOS. - [Classes](https://developers.liveramp.com/authenticatedtraffic-api/docs/ios-sdk-classes.md): See all classes that implement the LRIdentifierData protocol and other related classes for iOS SDK. - [Events](https://developers.liveramp.com/authenticatedtraffic-api/docs/ios-sdk-events.md): Learn all cases of LREvent for iOS SDK. - [Enumerations](https://developers.liveramp.com/authenticatedtraffic-api/docs/ios-sdk-enumerations.md): Learn more about the enumerations used in the iOS ATS Mobile SDK covering error states, SDK statuses, and more. - [Generate and Pass Identity Envelopes With LiveRamp Secure Signals Adapter](https://developers.liveramp.com/authenticatedtraffic-api/docs/generate-and-pass-identity-envelopes-with-liveramp-secure-signals-adapter.md) - [iOS Methods for LRAtsMediationAdapter](https://developers.liveramp.com/authenticatedtraffic-api/docs/ios-methods-for-lratsmediationadapter.md): View all available methods and properties for iOS when implementing LRAtsMediationAdapter - [Android Methods for LRAtsMediationAdapter](https://developers.liveramp.com/authenticatedtraffic-api/docs/android-methods-for-lratsmediationadapter.md): View all available methods and properties for Android when implementing LRAtsMediationAdapter - [ATS Direct for ATS Mobile SDK](https://developers.liveramp.com/authenticatedtraffic-api/docs/ats-direct-for-mobile-sdk.md): Learn how you can implement ATS Direct ## API Reference - [Retrieving envelopes - identified](https://developers.liveramp.com/authenticatedtraffic-api/reference/retrieving-envelopes.md): Retrieve envelopes using (hashed) identifiers. - [Refreshing envelopes - identified](https://developers.liveramp.com/authenticatedtraffic-api/reference/refreshing-envelopes-identified.md): Refreshing envelopes is an important step to keep the match rate as high as possible for your users. Existing envelopes can be exchanged for fresh envelopes by calling this endpoint. - [Retrieving envelopes - cookieable](https://developers.liveramp.com/authenticatedtraffic-api/reference/retrieving-envelopes-cookieable.md): Retrieve envelopes using the LiveRamp third-party cookie footprint. ## Changelog - [ATS Mobile SDK Deprecated: Users to Transition to ATS API](https://developers.liveramp.com/authenticatedtraffic-api/changelog/ats-mobile-sdk-users-to-transition-to-ats-api.md) - [Added llms.txt](https://developers.liveramp.com/authenticatedtraffic-api/changelog/added-llmstxt.md) - [ATS Mobile SDK (v3.1.0) Has Been Released](https://developers.liveramp.com/authenticatedtraffic-api/changelog/ats-mobile-sdk-v310-has-been-released.md) - [ATS Mobile SDK (v3.0.0) Has Been Released](https://developers.liveramp.com/authenticatedtraffic-api/changelog/ats-mobile-sdk-v300-has-been-released.md) - [Android ATS Mobile SDK (v2.10.0) Has Been Released](https://developers.liveramp.com/authenticatedtraffic-api/changelog/android-ats-mobile-sdk-v2100-has-been-released.md) - [Send Mobile App Events to Meta and TikTok CAPI](https://developers.liveramp.com/authenticatedtraffic-api/changelog/send-mobile-app-events-to-tiktok-and-meta-capi.md) - [ATS Mobile SDK (v2.9.0) Has Been Released](https://developers.liveramp.com/authenticatedtraffic-api/changelog/ats-mobile-sdk-v290-has-been-released.md) - [ATS Mobile SDK (v2.8.0) Has Been Released](https://developers.liveramp.com/authenticatedtraffic-api/changelog/ats-mobile-sdk-v280-has-been-released.md) - [ATS Mobile SDK (v2.7.0) Has Been Released](https://developers.liveramp.com/authenticatedtraffic-api/changelog/ats-mobile-sdk-v270-has-been-released.md) - [ATS Mobile SDK (v2.6.1) Has Been Released](https://developers.liveramp.com/authenticatedtraffic-api/changelog/ats-mobile-sdk-v261-has-been-released.md) # Clean Room API Documentation > 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 integrating Clean Room API features directly into your platform. ## API Reference - [About the Clean Room API](https://developers.liveramp.com/clean-room-api/reference/about-the-clean-room-api.md) - [API Limits](https://developers.liveramp.com/clean-room-api/reference/api-limits.md) - [Python Tutorial for Creating and Running Questions](https://developers.liveramp.com/clean-room-api/reference/python-tutorial-for-creating-and-running-questions.md): This tutorial provides a sample workflow for using Python to create and run question runs. - [Step 1: Environmental Configuration](https://developers.liveramp.com/clean-room-api/reference/environmental-configuration.md): You can store environmental variables in a YAML file in your local environment. - [Step 2: Defining API Operations](https://developers.liveramp.com/clean-room-api/reference/step-2-defining-api-operations.md) - [Step 3: Creating a Clean Room](https://developers.liveramp.com/clean-room-api/reference/step-3-creating-a-clean-room.md): (Optional) If you already have a test clean room set up for use with the Clean Room API, you can skip this step. - [Step 4: Provisioning Datasets](https://developers.liveramp.com/clean-room-api/reference/step-4-provisioning-datasets.md) - [Step 5: Creating Analytical Questions](https://developers.liveramp.com/clean-room-api/reference/step-5-creating-analytical-questions.md): Now that you have provisioned datasets to the clean room, you are ready to create an analytical question to get some insights. - [Step 6: Assign Datasets to Questions](https://developers.liveramp.com/clean-room-api/reference/step-6-assign-datasets-to-questions.md): Now that we've created our question, we need to assign the right datasets to the specified dataset macros in order to run it. - [Step 7: Run Questions](https://developers.liveramp.com/clean-room-api/reference/step-7-run-questions.md) - [Step 8: Get Question Run Status and Results](https://developers.liveramp.com/clean-room-api/reference/step-7-get-question-run-status-and-results.md) - [Step 9: Creating Flows](https://developers.liveramp.com/clean-room-api/reference/optional-step-9-creating-flows.md) - [Creating Questions and Flow Runs](https://developers.liveramp.com/clean-room-api/reference/using-the-question-api.md) - [Example Question Workflow](https://developers.liveramp.com/clean-room-api/reference/example-question-workflow.md) - [Example Flow Run Workflow](https://developers.liveramp.com/clean-room-api/reference/example-flow-run-workflow.md) - [Where to Find Relevant Metadata](https://developers.liveramp.com/clean-room-api/reference/where-to-find-relevant-metadata.md) - [Configuring a Clean Room API User](https://developers.liveramp.com/clean-room-api/reference/configuring-a-clean-room-api-user.md) - [Request an Access Token](https://developers.liveramp.com/clean-room-api/reference/request-an-access-token.md) - [Clean Room API Endpoints](https://developers.liveramp.com/clean-room-api/reference/clean-room-api-endpoints.md): The following endpoints are prefixed with the "https://api.habu.com/v1" base URL. - [Fetch a list of all Data Sources](https://developers.liveramp.com/clean-room-api/reference/getalldatasources-1.md): This operation fetches a list of all the Data Sources that are available to create a new Data Connection for this Customer Integration. - [Fetch a Data Source by ID](https://developers.liveramp.com/clean-room-api/reference/getdatasourcebyid-1.md): This operation fetches a Data Source by ID. - [Fetch a list of all Data Connections](https://developers.liveramp.com/clean-room-api/reference/getalldataconnections-1.md): This operation fetches a list of all the data connections created as part of this Customer Integration. - [Fetch a Data Connection by ID](https://developers.liveramp.com/clean-room-api/reference/getdataconnectionbyid-1.md): This operation fetches a data connection by ID. - [Create Data Connection](https://developers.liveramp.com/clean-room-api/reference/createdataconnection-1.md): This operation creates a new data connection. - [Update a Data Connection by ID](https://developers.liveramp.com/clean-room-api/reference/updatedataconnection-1.md): This operation updates a data connection by ID. - [Fetch a list of all Field Configurations](https://developers.liveramp.com/clean-room-api/reference/getallfieldconfigurations-1.md): This operation fetches a list of all the Field Configurations for the given Data Connection. - [Map Field Configurations](https://developers.liveramp.com/clean-room-api/reference/mapfieldconfigurations-1.md): This operation maps the Field Configurations for the given Data Connection. - [Retry a Data Connection Job by ID](https://developers.liveramp.com/clean-room-api/reference/retrydataconnectionjob.md): This operation retries a data connection job by ID. - [Fetch a list of all Identifier Types for Field Mapping](https://developers.liveramp.com/clean-room-api/reference/getallidentifiertypes-1.md): This operation fetches a list of all the Identifier Types to select from for mapping a Field - this is applicable during the mapping step of a Data Connection. - [Delete a Data Connection by ID](https://developers.liveramp.com/clean-room-api/reference/deletedataconnection-1.md): This operation deletes a data connection by ID. - [Fetch a list of all Credential Sources](https://developers.liveramp.com/clean-room-api/reference/getallcredentialsources-1.md): This operation fetches a list of all the Credential Sources created for this Customer Integration. - [Fetch a Credential Source by ID](https://developers.liveramp.com/clean-room-api/reference/getcredentialsourcebyid-1.md): This operation fetches a Credential Source by ID. - [Fetch a Credential Source by Name](https://developers.liveramp.com/clean-room-api/reference/getcredentialsourcebyname.md): This operation fetches a Credential Source by Name. - [Fetch a list of Data Types](https://developers.liveramp.com/clean-room-api/reference/getalldatatypes.md): This operation fetches a list of all the Data Types for a Data Source ID. - [Fetch a Data Type by ID](https://developers.liveramp.com/clean-room-api/reference/getdatatypebyid.md): This operation fetches a Data Type by ID. - [Fetch all Data Source Parameters](https://developers.liveramp.com/clean-room-api/reference/getalldatasourceparameters-1.md): This operation fetches all the Data Source Parameters for the given data source and data type. - [Fetch a list of all Import Data Types](https://developers.liveramp.com/clean-room-api/reference/getallimportdatatypes.md): This operation fetches a list of all the Import Data Types that are available to the organization. - [Fetch a list of all Data Connection Views](https://developers.liveramp.com/clean-room-api/reference/getalldataconnectionviews.md): This operation fetches a paginated list of data connection views for the organization. - [Fetch a Data Connection View by ID](https://developers.liveramp.com/clean-room-api/reference/getdataconnectionviewbyid.md): This operation fetches a data connection view by ID. - [Create a Data Connection View](https://developers.liveramp.com/clean-room-api/reference/createdataconnectionview.md): This operation creates a new data connection view from a SQL query and source data connections. - [Update a Data Connection View by ID](https://developers.liveramp.com/clean-room-api/reference/updatedataconnectionview.md): This operation updates a data connection view by ID. - [Delete a Data Connection View by ID](https://developers.liveramp.com/clean-room-api/reference/deletedataconnectionview.md): This operation deletes a data connection view by ID. - [Fetch a list of all Organization Users](https://developers.liveramp.com/clean-room-api/reference/getallorganizationusers.md): This operation fetches a list of all the users created for this organization. - [Fetch a list of all Organization Credentials](https://developers.liveramp.com/clean-room-api/reference/getallorganizationcredentials.md): This operation fetches a list of all the Organization Credentials created for this Customer Integration. Ensure that the credentials are configured on the Habu platform before they can be accessed via external APIs. Creation of credentials is not exposed via external APIs to prevent potential security issues with transmitting raw credential values. - [Fetch an Organization Credential by ID](https://developers.liveramp.com/clean-room-api/reference/getorganizationcredentialbyid.md): This operation fetches an Organization Credential by ID. - [Create Organization Credentials](https://developers.liveramp.com/clean-room-api/reference/createorganizationcredential.md): This operation creates a new credential. - [Update Organization Credentials](https://developers.liveramp.com/clean-room-api/reference/updateorganizationcredential.md): This operation updates an existing credential. - [Delete an Organization Credential by ID](https://developers.liveramp.com/clean-room-api/reference/deleteorganizationcredential.md): This operation deletes an organization credential by ID. - [Fetch a list of all Cleanrooms](https://developers.liveramp.com/clean-room-api/reference/getallcleanrooms-1.md): This operation fetches a list of all the Cleanrooms that are created for the Customer Integration. - [Fetch a Cleanroom by ID](https://developers.liveramp.com/clean-room-api/reference/getcleanroombyid-1.md): This operation fetches a Cleanroom by ID. - [Create Cleanroom](https://developers.liveramp.com/clean-room-api/reference/createcleanroom-1.md): This operation creates a new Cleanroom. - [Update Cleanroom](https://developers.liveramp.com/clean-room-api/reference/updatecleanroom-1.md): This operation updates an existing cleanroom. - [Fetch all Cleanroom Types](https://developers.liveramp.com/clean-room-api/reference/getcleanroomtypes-1.md): This operation fetches all the available Cleanroom Types. - [Get comprehensive asset details for cleanroom operations](https://developers.liveramp.com/clean-room-api/reference/getcleanroomassetdetails.md): This operation fetches comprehensive asset details including questions, datasets, compute capacity options, field types, and stakeholders for cleanroom operations. - [Delete Cleanroom](https://developers.liveramp.com/clean-room-api/reference/deletecleanroom-1.md): This operation deletes an existing cleanroom. - [Fetch a list of all Cleanroom Partners](https://developers.liveramp.com/clean-room-api/reference/getallcleanroompartners.md): This operation fetches a list of all the Cleanroom partners in a cleanroom and their respective users. - [Fetch a Cleanroom Partner by Partner ID](https://developers.liveramp.com/clean-room-api/reference/getcleanroompartnerbyid.md): This operation fetches a Cleanroom Partner by Partner ID. - [Add Cleanroom Partner](https://developers.liveramp.com/clean-room-api/reference/addcleanroompartner.md): This operation adds a new partner to an existing cleanroom. - [Update a partner cleanroom user role](https://developers.liveramp.com/clean-room-api/reference/updatecleanroompartneruserrole.md): This operation updates a partner cleanroom user role except Administrator and Partner Administrator Role. - [Get Cleanroom Partner Roles in Cleanroom](https://developers.liveramp.com/clean-room-api/reference/getcleanroompartnerroles.md): This operation fetches the Cleanroom partner roles in a cleanroom. - [Get Cleanroom Partner Role by ID](https://developers.liveramp.com/clean-room-api/reference/getcleanroompartnerrolebyid.md): This operation fetches the Cleanroom partner role by Id. - [Remove Cleanroom Partner User](https://developers.liveramp.com/clean-room-api/reference/deletecleanroompartneruser.md): This operation removes an existing partner user from a cleanroom. - [Delete Cleanroom Partner](https://developers.liveramp.com/clean-room-api/reference/deletecleanroompartner.md): This operation deletes an existing partner from a cleanroom. - [List Cleanroom Partner Invitations For a Cleanroom Inviter](https://developers.liveramp.com/clean-room-api/reference/listpartnerinvitationsforinviter.md): This operation lists a invitation list for a CleanRoom Inviter. - [Cancel Cleanroom Partner Invitation](https://developers.liveramp.com/clean-room-api/reference/cancelpartnerinvitationbyemail.md): This operation cancels a invitation for a CleanRoom Inviter. - [Cancel Cleanroom Partner Invitation](https://developers.liveramp.com/clean-room-api/reference/cancelpartnerinvitationbyid.md): This operation cancels a invitation for a CleanRoom Inviter. - [Fetch a list of all Cleanroom Questions for a Cleanroom](https://developers.liveramp.com/clean-room-api/reference/getallcleanroomquestions.md): This operation fetches a list of all the Cleanroom Questions that are tied to a Cleanroom. - [Fetch a Cleanroom Question by ID](https://developers.liveramp.com/clean-room-api/reference/getcleanroomquestionbyid.md): This operation fetches a Cleanroom Question by ID. - [Get Cleanroom Question by Cleanroom ID and Question ID](https://developers.liveramp.com/clean-room-api/reference/getcleanroomquestion.md): This operation fetches a Cleanroom Question for a given Cleanroom ID and Question ID. - [Add Cleanroom Question](https://developers.liveramp.com/clean-room-api/reference/addcleanroomquestion.md): This operation adds a question to an existing cleanroom. - [Enable segmentation for a Cleanroom Question](https://developers.liveramp.com/clean-room-api/reference/enablecleanroomquestionsegmentation.md): This operation enables segmentation for a Cleanroom Question. - [Update segmentation for a Cleanroom Question](https://developers.liveramp.com/clean-room-api/reference/updatecleanroomquestionsegmentation.md): This operation updates segmentation for a Cleanroom Question. - [Update the compute capacity for a cleanroom question](https://developers.liveramp.com/clean-room-api/reference/updatecleanroomquestioncomputecapacity.md): This operation updates the compute capacity for a cleanroom question. This is currently only supported for Snowflake and Hybrid Cleanrooms - [Delete Cleanroom Question](https://developers.liveramp.com/clean-room-api/reference/deletecleanroomquestion.md): This operation deletes an existing cleanroom question. - [Fetch a list of cleanRoom roles](https://developers.liveramp.com/clean-room-api/reference/getcleanroomroles.md): This operation fetches a list of roles applicable to the given cleanroom in this organization. - [Fetch a cleanroom role by ID](https://developers.liveramp.com/clean-room-api/reference/getcleanroomrolebyid.md): This operation fetches a Cleanroom role by ID. - [Fetch a list of Cleanroom Users](https://developers.liveramp.com/clean-room-api/reference/getcleanroomusers.md): This operation fetches a list of the Cleanroom users in a cleanroom. - [Fetch a Cleanroom User by ID](https://developers.liveramp.com/clean-room-api/reference/getcleanroomuserbyid.md): This operation fetches a Cleanroom user by ID. - [Add Cleanroom User](https://developers.liveramp.com/clean-room-api/reference/addcleanroomuser.md): This operation adds a new user to an existing cleanroom. - [Update Cleanroom User Role](https://developers.liveramp.com/clean-room-api/reference/updatecleanroomuserrole.md): This operation updates cleanroom user role. - [Remove Cleanroom User](https://developers.liveramp.com/clean-room-api/reference/deletecleanroomuser.md): This operation removes an existing user from a cleanroom. - [Fetch a list of all Cleanroom Datasets](https://developers.liveramp.com/clean-room-api/reference/getcleanroomdatasets.md): This operation fetches a list of all the Datasets that can be assigned or configured for a Cleanroom. - [Get a Cleanroom Dataset by ID](https://developers.liveramp.com/clean-room-api/reference/getcleanroomdatasetbyid.md): This operation gets a Cleanroom Dataset by ID. - [Configure a Cleanroom Dataset by Data Connection ID](https://developers.liveramp.com/clean-room-api/reference/configurecleanroomdataset.md): This operation configures a Cleanroom Dataset based on Data Connection ID. - [Configure whether a partner can assign a Cleanroom Dataset](https://developers.liveramp.com/clean-room-api/reference/updatecleanroomdatasetpartnerassignment.md): This operation configure whether a partner can assign a Cleanroom Dataset - [Update a Cleanroom Dataset by ID](https://developers.liveramp.com/clean-room-api/reference/updatecleanroomdatasetbyid.md): This operation updates the field mappings and field filters for a Cleanroom Dataset. - [Fetch question details](https://developers.liveramp.com/clean-room-api/reference/getquestiondetails.md): This operation fetches the details of a question by the question ID. - [Create question](https://developers.liveramp.com/clean-room-api/reference/createquestion.md): This operation creates a question. - [Update question](https://developers.liveramp.com/clean-room-api/reference/updatequestion.md): This operation updates a question. - [Fetch question data types](https://developers.liveramp.com/clean-room-api/reference/getquestiondatatypes.md): This operation fetches the question types by the question ID. - [Delete question](https://developers.liveramp.com/clean-room-api/reference/deletequestion.md): This operation deletes a question given its ID - [Fetch a list of all Cleanroom Question Runs for a Cleanroom Question](https://developers.liveramp.com/clean-room-api/reference/getallcleanroomquestionruns.md): This operation fetches a list of all the Cleanroom Question Runs (including metadata) for a given Cleanroom Question. The Customer can optionally use the status parameter to filter the list of Cleanroom Question Runs. - [Fetch a Cleanroom Question Run by ID](https://developers.liveramp.com/clean-room-api/reference/getcleanroomquestionrunbyid.md): This operation fetches a Cleanroom Question Run (including metadata) by Cleanroom Question Run ID. - [Create a Cleanroom Question Run for a Cleanroom Question](https://developers.liveramp.com/clean-room-api/reference/createcleanroomquestionrun.md): This operation facilitates creation of a Cleanroom Question Run for a given Cleanroom Question. The Cleanroom Question must be in the READY state before a run can be created. If datasets have not yet been configured, use the `configureCleanroomQuestionDatasets` operation (`POST /cleanroom-questions/{cleanroomQuestionId}/datasets`) first. - [Update Question Run Status](https://developers.liveramp.com/clean-room-api/reference/updatecleanroomquestionrunstatus.md): This operation lets the Customer share an update on the status of an in-progress Cleanroom Question Run with Habu. It also lets them send the status and details for a completed/failed Cleanroom Question Run to Habu. - [Get the result data for Cleanroom Question Run](https://developers.liveramp.com/clean-room-api/reference/getcleanroomquestionrundata.md): This operation is to get the result data for the Cleanroom Question Run. - [Get the output file for Cleanroom Question Run](https://developers.liveramp.com/clean-room-api/reference/getcleanroomquestionrunoutputfile.md): This operation is to get the output file for the Cleanroom Question Run. - [Get the count of result data for Cleanroom Question Run](https://developers.liveramp.com/clean-room-api/reference/getcleanroomquestionrundatacount.md): This operation is to get the count of result data for the Cleanroom Question Run. - [Get audit details for Cleanroom Question Run](https://developers.liveramp.com/clean-room-api/reference/getcleanroomquestionrunaudit.md): This operation is to get the audit details for the Cleanroom Question Run. - [Fetch the Activation Summary for a Cleanroom question run](https://developers.liveramp.com/clean-room-api/reference/getcleanroomquestionrunactivationsummaries.md): This operation fetches a list the Activation Summary for a Cleanroom question run - [Fetch the Partition Parameters for a Cleanroom question run](https://developers.liveramp.com/clean-room-api/reference/getcleanroomquestionrunpartitionparameters.md): This operation fetches a list of the partition parameters for a Cleanroom question run - [Get the explain plan for a SQL Cleanroom Question Run](https://developers.liveramp.com/clean-room-api/reference/getcleanroomquestionrunexplainplan.md): This operation returns the execution plan (explain plan) for the specified Cleanroom Question Run. This operation applies only to Cleanroom Questions of type SQL; it is not supported for other question types. - [Delete Cleanroom Question Run](https://developers.liveramp.com/clean-room-api/reference/deletecleanroomquestionrun.md): This operation lets the Customer delete a Cleanroom Question Run by ID. - [Get the possible sharing options for the result of a Cleanroom Question](https://developers.liveramp.com/clean-room-api/reference/getcleanroomquestionresultshares.md): This operation fetches a the possible sharing options for the result of a Cleanroom Question. - [Upsert clean room question result shares](https://developers.liveramp.com/clean-room-api/reference/upsertcleanroomquestionresultshares.md): This operation shares the results of a cleanroom question. - [Get the tags for a Cleanroom Question](https://developers.liveramp.com/clean-room-api/reference/getcleanroomquestiontags.md): This operation fetches a the tags for a Cleanroom Question. - [Get all Cleanroom Question Run Schedules for a Cleanroom Question](https://developers.liveramp.com/clean-room-api/reference/getcleanroomquestionrunschedules.md): This operation fetches all run schedules for a cleanroom question - [Get a Cleanroom Question Run Schedule by ID](https://developers.liveramp.com/clean-room-api/reference/getcleanroomquestionrunschedulebyid.md): This operation fetches a the a Cleanroom Question Run Schedule by ID. - [Create a new run schedule for a cleanroom question](https://developers.liveramp.com/clean-room-api/reference/createcleanroomquestionrunschedule.md): This operation creates a new run schedule for a cleanroom question - [Update a run schedule for a cleanroom question](https://developers.liveramp.com/clean-room-api/reference/patchcleanroomquestionrunschedulebyid.md): This operation modifies a run schedule for a cleanroom question - [delete a Cleanroom Question Run Schedule by ID](https://developers.liveramp.com/clean-room-api/reference/deletecleanroomquestionrunschedulebyid.md): This operation deletes a Cleanroom Question Run Schedule by ID. - [Fetch a list of all Cleanroom Question Datasets](https://developers.liveramp.com/clean-room-api/reference/getallcleanroomquestiondatasets.md): This operation fetches a list of all Cleanroom Question Datasets. - [Fetch a list of stakeholders for this cleanroom](https://developers.liveramp.com/clean-room-api/reference/getcleanroomstakeholders.md): This operation fetches a list of stakeholders for this Cleanroom that need datasets assigned while managing datasets for Cleanroom Question. - [Configure Cleanroom Question Datasets](https://developers.liveramp.com/clean-room-api/reference/configurecleanroomquestiondatasets.md): This operation configures and assigns Datasets to a Cleanroom Question. - [Get the parameters for a Cleanroom Question](https://developers.liveramp.com/clean-room-api/reference/getcleanroomquestionparameters.md): This operation fetches a the parameters for a Cleanroom Question. - [Fetch a list of data type options for this cleanroom question](https://developers.liveramp.com/clean-room-api/reference/getcleanroomquestiondatatypeoptions.md): This operation fetches a list of DataTypeOptions for this Cleanroom Question. - [Assign Cleanroom Question Datasets Ownership](https://developers.liveramp.com/clean-room-api/reference/assigncleanroomquestiondatasetsownership.md): This operation assigns ownership to a Cleanroom Question Datasets. - [Get the permissions for a Cleanroom Question](https://developers.liveramp.com/clean-room-api/reference/getcleanroomquestionpermissions.md): This operation fetches the existing permissions for a Cleanroom Question. - [Configure the permissions for a Cleanroom Question](https://developers.liveramp.com/clean-room-api/reference/configurecleanroomquestionpermissions.md): This operation configures cleanroom question permissions - [Fetch a list of all Cleanroom Exports](https://developers.liveramp.com/clean-room-api/reference/getalldataexportjobs.md): This operation fetches a list of all the Cleanroom Exports that are available to the organization. - [Fetch a list of all Cleanroom Exports](https://developers.liveramp.com/clean-room-api/reference/getdataexportjobruns.md): This operation fetches the runs for a data export job - [Create cleanroom export job](https://developers.liveramp.com/clean-room-api/reference/createdataexportjobs.md): This operation creates new data export jobs - [Change export job status](https://developers.liveramp.com/clean-room-api/reference/changejobstatus.md): Sets the job schedule status to ACTIVE or PAUSED. - [Delete a data export job](https://developers.liveramp.com/clean-room-api/reference/deletedataexportjob.md): Deletes a data export job for the organization. - [List destination partners](https://developers.liveramp.com/clean-room-api/reference/listdestinationpartners.md): This operation fetches the list of destination partners available. - [List destination connections](https://developers.liveramp.com/clean-room-api/reference/listdestinations.md): This operation fetches a list destination connections (partner accounts) for the organisation. - [Create destination connection](https://developers.liveramp.com/clean-room-api/reference/createdestination.md): Creates a destination connection (partner account) for the organisation. requires name and partner id; credential and publicKey are optional depending on partner type. - [Update destination connection](https://developers.liveramp.com/clean-room-api/reference/updatedestinationconnection.md): Updates an existing destination connection (partner account) for the organization. Partner cannot be changed; only name, credential, and publicKey may be updated. - [Delete destination connection](https://developers.liveramp.com/clean-room-api/reference/deletedestinationconnection.md): Deletes a destination connection (partner account) for the organization. - [List destinations provisioned in a cleanroom](https://developers.liveramp.com/clean-room-api/reference/listcleanroomdestinations.md): Lists destinations provisioned to this cleanroom. Each item includes the partner account, whether the org is owner or partner, and the activation channel status. Paginate with limit and offset (defaults 30 and 0; limit may not exceed 100). You can optionally filter by partner type. - [Provision destinations to a cleanroom](https://developers.liveramp.com/clean-room-api/reference/provisioncleanroomdestinations.md): This operation provisions a destination to a cleanroom - [Approve or reject a destination provisioning request](https://developers.liveramp.com/clean-room-api/reference/reviewdestinationprovisioningrequest.md): Approve or reject a pending destination provisioning request for a single partner account in the cleanroom. - [Deprovision a destination from a cleanroom](https://developers.liveramp.com/clean-room-api/reference/deprovisioncleanroomdestination.md): Deprovisions a destination connection from a cleanroom. The destination connection must belong to the organization and must not be in use for activation. - [Get a Cleanroom Flow by ID](https://developers.liveramp.com/clean-room-api/reference/getcleanroomflow.md): This operation fetches a Cleanroom Flow by its ID, including flow structure (nodes, edges) and version information. - [Create or update a cleanroom flow](https://developers.liveramp.com/clean-room-api/reference/createorupdatecleanroomflow.md): This operation creates or updates a Cleanroom Flow. - [Assign datasets and fields to a cleanroom flow](https://developers.liveramp.com/clean-room-api/reference/assigncleanroomflowdatasets.md): This operation assigns datasets and field mappings to nodes in a cleanroom flow using dataset and organization names instead of IDs. - [List Cleanroom Flows](https://developers.liveramp.com/clean-room-api/reference/listcleanroomflows.md): List cleanroom flows for a cleanroom with pagination, filters and search. - [Set Cleanroom Flow Version](https://developers.liveramp.com/clean-room-api/reference/setcleanroomflowversion.md): This operation changes a cleanroom flow to use a specific existing flow version. Use this for rollback or switching between flow versions. - [Get comprehensive node details for a cleanroom flow](https://developers.liveramp.com/clean-room-api/reference/getcleanroomflownodedetails.md): This operation retrieves comprehensive details for all nodes in a cleanroom flow including question metadata and flow position information. - [Get organization information for datasets by UUID or name](https://developers.liveramp.com/clean-room-api/reference/getdatasetorganizations.md): This operation retrieves organization information for datasets by UUID or name within a cleanroom context. - [Bulk list flow node export jobs](https://developers.liveramp.com/clean-room-api/reference/listflownodeexportjobs.md): Lists all export jobs for one or more flow nodes. Pass a comma-separated list of node IDs via the nodeIds query parameter. - [Bulk get flow node export job runs](https://developers.liveramp.com/clean-room-api/reference/getflownodeexportjobruns.md): Returns run history for all export jobs associated with the specified flow nodes. - [Bulk create flow node export jobs](https://developers.liveramp.com/clean-room-api/reference/createflownodeexportjobs.md): Creates export jobs for one or more flow nodes in a single call. Each item specifies a node ID, the partner accounts to export to, and optional export parameters. Only question nodes are supported. One export job is created per partner account per node. - [Bulk update flow node export job status](https://developers.liveramp.com/clean-room-api/reference/updateflownodeexportjobsstatus.md): Updates the status of all export jobs for the specified flow nodes. Status must be ACTIVE or PAUSED. - [Bulk delete flow node export jobs](https://developers.liveramp.com/clean-room-api/reference/deleteflownodeexportjobs.md): Deletes all export jobs for the specified flow nodes. All jobs associated with each node are deleted. - [Get decision configuration for a cleanroom flow](https://developers.liveramp.com/clean-room-api/reference/getflowdecisionconfiguration.md): Fetches decision configuration for a cleanroom flow. If nodeIdentifier is provided, returns configuration for that specific node only. Otherwise returns all decision configurations for the flow. - [Create or update decision configuration for a cleanroom flow](https://developers.liveramp.com/clean-room-api/reference/createorupdateflowdecisionconfiguration.md): Creates or updates decision configuration for one or more nodes in a cleanroom flow. Each decision node includes conditions, retry configuration, and gated edges. - [Delete decision configuration for a cleanroom flow](https://developers.liveramp.com/clean-room-api/reference/deleteflowdecisionconfiguration.md): Deletes decision configuration for a cleanroom flow. If nodeIdentifier is provided, deletes configuration for that specific node only. Otherwise deletes all decision configurations for the flow. - [Fetch a Cleanroom Flow Run by ID](https://developers.liveramp.com/clean-room-api/reference/getcleanroomflowrunbyid.md): This operation fetches a Cleanroom Flow Run (including metadata) by Cleanroom Flow Run ID and Clean Room ID. - [List Cleanroom Flow Runs](https://developers.liveramp.com/clean-room-api/reference/listcleanroomflowruns.md): List cleanroom flow runs for a given cleanroom flow with optional search filters and pagination. - [Create a Cleanroom Flow Run](https://developers.liveramp.com/clean-room-api/reference/createorupdatecleanroomflowrun.md): This operation creates a Cleanroom Flow Run. - [get the status of a Cleanroom Flow Run](https://developers.liveramp.com/clean-room-api/reference/getcleanroomflowrunstatus.md): This operation fetches the status of a Cleanroom Flow Run. - [Get Flow Run Parameters](https://developers.liveramp.com/clean-room-api/reference/getcleanroomflowrunparameters.md): This operation gets run parameters for a cleanroom flow - [Preview Flow Run Parameters](https://developers.liveramp.com/clean-room-api/reference/previewflowrunparameters.md): Returns the expected runtime and partition parameters for each question node that would be included in a flow run, without actually creating a run. Accepts the same request shape as Create Cleanroom Flow Run. If parentFlowRunId is set on the request, it is treated as a replay scenario. - [Fetch a Cleanroom Flow Run Report](https://developers.liveramp.com/clean-room-api/reference/getcleanroomflowrunreport.md): This operation fetches a Cleanroom Flow Run Report (including metadata) by Cleanroom Flow Run ID and Clean Room ID. - [Fetch output nodes for a Cleanroom Flow Run Report](https://developers.liveramp.com/clean-room-api/reference/getcleanroomflowrunoutputnodes.md): This operation fetches the output nodes for a cleanroom flow run. It is the canonical way to list all nodes in the run and retrieve their UUIDs (the recommended identifier). Note: The label field in this response represents the node's display name (e.g., "Brand Awareness") and cannot be used as a node identifier. API clients should use the returned UUID for all node-specific operations to ensure uniqueness and stability. - [Download output file for a Cleanroom Flow Run node](https://developers.liveramp.com/clean-room-api/reference/getcleanroomflowrunnodeoutputfile.md): This operation downloads an output file for a specific node in a cleanroom flow run - [Resume a Cleanroom Flow Run](https://developers.liveramp.com/clean-room-api/reference/resumecleanroomflowrun.md): This operation resumes a Cleanroom Flow Run. - [replay a Cleanroom Flow Run](https://developers.liveramp.com/clean-room-api/reference/replaycleanroomflowrun.md): This operation replays a Cleanroom Flow Run. - [Check API availability](https://developers.liveramp.com/clean-room-api/reference/gethealth.md): Returns the health status of the API. Unauthenticated — use this to verify connectivity before making authenticated calls. - [Get billable config](https://developers.liveramp.com/clean-room-api/reference/getbillableconfig.md): Fetches the billable config for a given source ID and source type. Absence of a config row means the source inherits billability from the hierarchy above it. See unhygienix billing-status documentation for resolution order. - [Upsert billable config](https://developers.liveramp.com/clean-room-api/reference/upsertbillableconfig.md): Creates or updates a billable config for the given source. Use after creating a question run or flow run to opt out of billing (`value: "false"`). Leaving billing enabled requires no row — the hierarchy above applies. - [Delete billable config](https://developers.liveramp.com/clean-room-api/reference/deletebillableconfig.md): Deletes the billable config by its config ID (from a prior GET or upsert response). Returns 404 if no config with that ID was deleted. To resolve sourceId/sourceType to a config ID, call GET /billable-configs first. ## Changelog - [Clean Room API Changelog](https://developers.liveramp.com/clean-room-api/changelog/welcome-to-clean-room-api.md) # Data Marketplace Buyer API Documentation > Documentation for Data Marketplace Buyer API ## Guides - [About the documentation](https://developers.liveramp.com/datamarketplace-buyer-api/docs/about-the-documentation.md): The Data Marketplace Buyer API documentation set includes the Data Marketplace Buyer API Guide and the Data Marketplace Buyer API Reference. - [Segments](https://developers.liveramp.com/datamarketplace-buyer-api/docs/segment-endpoints.md): Learn about the Data Marketplace Buyer API segment endpoints. ## Changelog - [Added llms.txt](https://developers.liveramp.com/datamarketplace-buyer-api/changelog/added-llmstxt.md) - [Planned Buyer API Downtime – May 16, 8–10 PM PDT](https://developers.liveramp.com/datamarketplace-buyer-api/changelog/planned-buyer-api-downtime-may-16-810-pm-pst.md) - [Removed Segment Details Route from v3](https://developers.liveramp.com/datamarketplace-buyer-api/changelog/removed-segment-details-route-from-v3.md) - [Seller Storefront](https://developers.liveramp.com/datamarketplace-buyer-api/changelog/seller-storefront.md) - [Filters](https://developers.liveramp.com/datamarketplace-buyer-api/changelog/filters.md) - [Enable Data Marketplace Segments for Distribution by Activation API](https://developers.liveramp.com/datamarketplace-buyer-api/changelog/enable-data-marketplace-segments-for-distribution-by-activation-api.md) - [Buyer API URL update](https://developers.liveramp.com/datamarketplace-buyer-api/changelog/buyer-api-url-update.md) - [TLS Requirement Update](https://developers.liveramp.com/datamarketplace-buyer-api/changelog/tls-requirement-update.md) - [Destination and Distribution endpoints disabled](https://developers.liveramp.com/datamarketplace-buyer-api/changelog/destination-and-distribution-endpoints-disabled.md) # Data Pipeline Visibility API - Beta Documentation > LiveRamp Data Pipeline Visibility API ## API Reference - [The Basics](https://developers.liveramp.com/data-pipeline-visibility-api/reference/getting-started.md): Learn about the Data Pipeline Visibility API. - [Request an Access Token](https://developers.liveramp.com/data-pipeline-visibility-api/reference/request-an-access-token.md): Authenticate to the Data Pipeline Visibility API. - [Get IngestionRequests](https://developers.liveramp.com/data-pipeline-visibility-api/reference/get-ingestionrequests.md): Information about the ingestion status of your files. ## Changelog - [Added llms.txt](https://developers.liveramp.com/data-pipeline-visibility-api/changelog/added-llmstxt.md) - [New Data Pipeline Visibility API Documentation Structure](https://developers.liveramp.com/data-pipeline-visibility-api/changelog/new-data-pipeline-visibility-api-documentation-structure.md) - [Welcome to Data Pipeline Visibility API](https://developers.liveramp.com/data-pipeline-visibility-api/changelog/welcome-to-data-visibility-pipeline-api.md) # Data Seller API Documentation > The LiveRamp Data Seller API enables you to programmatically create new segments, update segment metadata, and monetize segments within the Data Marketplace. ## Guides - [Selling Data with the Data Marketplace](https://developers.liveramp.com/data-seller-api/docs/getting-started.md): Learn about how the Data Seller API fits into the LiveRamp Data Marketplace. - [Enabling Data Marketplace Segments](https://developers.liveramp.com/data-seller-api/docs/data-provider-workflow.md): Learn how to use the Data Seller API to enable Data Marketplace segments. - [Data Seller API Example Workflow](https://developers.liveramp.com/data-seller-api/docs/data-seller-api-workflow.md): Learn how to use LiveRamp's Data Seller API and Activation API to configure and distribute first-party data segments in the Data Marketplace. - [Create first-party data segments](https://developers.liveramp.com/data-seller-api/docs/create-first-party-data-segments.md): You can use the Data Seller API to configure first-party data segments in the Data Marketplace. - [Check approval status](https://developers.liveramp.com/data-seller-api/docs/check-approval-status.md): You can use the Data Seller API to check the approval status of a segment. - [Retrieve the activation segment ID](https://developers.liveramp.com/data-seller-api/docs/retrieve-activation-segment-id.md): You can use the Data Seller API provides the ID needed to use the Activation API. - [Create a destination account and distribute a custom segment](https://developers.liveramp.com/data-seller-api/docs/create-destination-account-and-distribute-a-custom-segment.md) - [View the status of a distributed segment](https://developers.liveramp.com/data-seller-api/docs/view-status-of-distributed-segment.md): You can use the Data Seller API to view the status of the distributed segment. - [Selling Data with the Data Marketplace Using Seller Direct](https://developers.liveramp.com/data-seller-api/docs/selling-data-with-the-data-marketplace-seller-direct.md): Learn how to use the Seller Direct feature to sell data with the Data Marketplace - [About the Documentation](https://developers.liveramp.com/data-seller-api/docs/about-the-documentation.md): The Data Seller API documentation set includes the Data Seller API Guide and the Data Seller API Reference. ## API Reference - [Request an Access Token](https://developers.liveramp.com/data-seller-api/reference/about-data-seller-api-authorization.md): Authenticate to the Data Seller API. - [List Data Marketplace Segments](https://developers.liveramp.com/data-seller-api/reference/get-v1segments.md): List Data Marketplace segments. - [Find Data Marketplace Segments](https://developers.liveramp.com/data-seller-api/reference/get-v1segment.md): Find segments by Data Marketplace segment ID. - [Enable Data Marketplace Segments](https://developers.liveramp.com/data-seller-api/reference/create-v1segment.md): Create and enable a Data Marketplace segment based on an existing first-party segment. - [Update a Data Marketplace Segment](https://developers.liveramp.com/data-seller-api/reference/modify-v1segment.md): Update the metadata for a Data Marketplace segment. - [Lists supported platforms for a seller](https://developers.liveramp.com/data-seller-api/reference/get-v1platforms.md): Lists a seller’s available platform Ad network IDs. - [License segments for Google destinations](https://developers.liveramp.com/data-seller-api/reference/bulk-batchcreate-v1googlelicensingrequest-1.md) ## Changelog - [Segment Delivery Information Endpoint](https://developers.liveramp.com/data-seller-api/changelog/segment-delivery-information-endpoint.md) - [Data Seller API is now GA](https://developers.liveramp.com/data-seller-api/changelog/data-seller-api-is-now-ga.md) - [Support for Seller Direct](https://developers.liveramp.com/data-seller-api/changelog/support-for-seller-direct.md) - [Added llms.txt](https://developers.liveramp.com/data-seller-api/changelog/added-llmstxt.md) - [Update Data Marketplace segment metadata](https://developers.liveramp.com/data-seller-api/changelog/update-data-marketplace-segment-metadata.md) - [Data Marketplace Segment Distribution Status](https://developers.liveramp.com/data-seller-api/changelog/data-marketplace-segment-distribution-status.md) - [Enable Segments for Combination](https://developers.liveramp.com/data-seller-api/changelog/enable-segments-for-combination.md) - [Use Activation API first-party segmentID to create or search for Data Seller segments](https://developers.liveramp.com/data-seller-api/changelog/use-activation-api-first-party-segmentid-to-create-or-search-for-data-provider-segments.md) - [Welcome to Data Seller API](https://developers.liveramp.com/data-seller-api/changelog/welcome-to-data-provider-api.md) # Job Management API Documentation > You can use the Job Management API to automate your Python and Pyspark jobs in LiveRamp Safe Haven's Analytics Environment. ## API Reference - [About the Analytics Environment Job Management API](https://developers.liveramp.com/ae-job-management-api/reference/about-the-analytics-environment-job-management-api.md) - [Authentication](https://developers.liveramp.com/ae-job-management-api/reference/authentication.md): How to authenticate to the LiveRamp Safe Haven Analytics Environment Job Management API - [Best Practices](https://developers.liveramp.com/ae-job-management-api/reference/best-practices.md): Learn about best practices for using the Job Management API. - [Request an Access Token](https://developers.liveramp.com/ae-job-management-api/reference/request-an-access-token.md): The Job Management API requires an access token. - [Get DataprocJobHistories](https://developers.liveramp.com/ae-job-management-api/reference/get-dataprocjobhistories.md): Get Dataproc Jobs - [Get ScheduleJobs](https://developers.liveramp.com/ae-job-management-api/reference/get-schedulejobs.md): Get all schedule jobs - [Get ScheduleJob](https://developers.liveramp.com/ae-job-management-api/reference/get-schedulejob.md): Get a schedule job - [Create ScheduleJob](https://developers.liveramp.com/ae-job-management-api/reference/create-schedulejob.md): create a schedule job - [Patch ScheduleJob](https://developers.liveramp.com/ae-job-management-api/reference/patch-schedulejob.md): Update Schedule Job - [Delete ScheduleJob](https://developers.liveramp.com/ae-job-management-api/reference/delete-schedulejob.md): Delete Schedule Job - [Get analytics job history](https://developers.liveramp.com/ae-job-management-api/reference/get-analytics-job-history.md): Return the history of the specified analytics job that was scheduled and run in the Job Management UI. This includes PySpark, Python, and BigQuery jobs. For information about Job Management, see "[Manage Jobs](https://docs.liveramp.com/safe-haven/en/the-job-management-page.html)". - [Get DataprocImageVersions](https://developers.liveramp.com/ae-job-management-api/reference/get-dataprocimageversions.md): Get Dataproc images version - [Run ScheduleJob](https://developers.liveramp.com/ae-job-management-api/reference/run-schedulejob-1.md): Your job will run according to the schedule that you specified when you created it. If you need to run it immediately, you can use the run endpoint. - [Stop ScheduleJob](https://developers.liveramp.com/ae-job-management-api/reference/stop-schedulejob-1.md): Your job will run according to the schedule that you specified when you created it. If you need to stop it immediately, you can use the stop endpoint. - [Get multiple BlobTrees](https://developers.liveramp.com/ae-job-management-api/reference/get-multiple-blobtrees.md): Get GCS blobs - [Modify EmailAlert](https://developers.liveramp.com/ae-job-management-api/reference/modify-emailalert.md): update email alert in batch - [Get Flows](https://developers.liveramp.com/ae-job-management-api/reference/get-flows.md): Get flow - [Create Flow](https://developers.liveramp.com/ae-job-management-api/reference/create-flow.md): Create flow - [Run Flow](https://developers.liveramp.com/ae-job-management-api/reference/run-flow-1.md): Run a job flow. - [Delete Flow](https://developers.liveramp.com/ae-job-management-api/reference/delete-flow.md): Delete flow ## Changelog - [Job Management API Updates](https://developers.liveramp.com/ae-job-management-api/changelog/welcome-to-ae-job-management.md) # Privacy API Documentation > The Privacy API handles data subject requests (DSRs, AKA “opt-outs and deletions“) one at a time, and monitors the success of the submissions. ## API Reference - [About the Privacy API](https://developers.liveramp.com/privacy-api/reference/about-the-privacy-api.md) - [Authentication](https://developers.liveramp.com/privacy-api/reference/authentication.md): How to authenticate to the LiveRamp Privacy API - [Best Practices](https://developers.liveramp.com/privacy-api/reference/best-practices.md): Learn about best practices for using the Privacy API. - [Request an Access Token](https://developers.liveramp.com/privacy-api/reference/request-an-access-token.md): The Privacy API requires an access token. - [Error Handling and Retries](https://developers.liveramp.com/privacy-api/reference/error-handling-retries.md) - [Get privacy requests](https://developers.liveramp.com/privacy-api/reference/get-privacyrequests-1.md): Retrieves privacy requests with optional filtering. If a UUID is provided as a query parameter, a single request is returned; otherwise a paginated list of requests is returned. - [Create privacy requests](https://developers.liveramp.com/privacy-api/reference/create-privacyrequests-1.md): Creates a new privacy request for data deletion or opt-out. Accepts personal information (email, name, address) or mobile advertising identifiers (MAID) to identify the data subject and processes the request according to the specified type. At least one identifier (email or MAID) must be provided. Returns a unique request UUID for tracking and handles duplicate detection. ## Changelog - [Privacy API Changelog](https://developers.liveramp.com/privacy-api/changelog/privacy-api-changelog.md) # RampID API Documentation > The RampID API is a secure, real-time interface that provides direct access to the LiveRamp industry-leading offline identity-matching service. ## API Reference - [About the RampID API](https://developers.liveramp.com/rampid-api/reference/the-basics.md): Learn about the RampID API. - [About RampIDs](https://developers.liveramp.com/rampid-api/reference/rampids.md): Learn about the RampIDs returned for API calls, including ID versions and ID formats. - [RampID API Endpoints](https://developers.liveramp.com/rampid-api/reference/rampid-api-endpoints.md) - [Batch Request Calls](https://developers.liveramp.com/rampid-api/reference/batch-request-calls.md): Learn about the Retrieval API batch request calls and how they're used. - [API Roles](https://developers.liveramp.com/rampid-api/reference/api-roles.md) - [Request an Access Token](https://developers.liveramp.com/rampid-api/reference/request-an-access-token-1.md): Learn how to authenticate to the RampID API. - [About LiveRamp Identity Resolution](https://developers.liveramp.com/rampid-api/reference/about-liveramp-identity-resolution.md): Learn how to match data to RampIDs. - [Data You Can Send with the Retrieval API](https://developers.liveramp.com/rampid-api/reference/data-you-can-send.md): Learn about types of input data accepted by the Retrieval API. - [Data Returned by the Retrieval API](https://developers.liveramp.com/rampid-api/reference/data-that-is-returned.md): Learn about the data that's returned by the Retrieval API, including RampIDs and match metadata. - [Requesting Multiple RampID Matching](https://developers.liveramp.com/rampid-api/reference/requesting-more-than-one-rampid-match.md): With the 1:1 permission, you may request multiple RampID matches for one PII record. - [About Response Documents](https://developers.liveramp.com/rampid-api/reference/response-documents.md): Learn about response documents' content and structure. - [Person Documents](https://developers.liveramp.com/rampid-api/reference/person-documents.md) - [Group Documents](https://developers.liveramp.com/rampid-api/reference/group-documents.md) - [Batch Documents](https://developers.liveramp.com/rampid-api/reference/batch-documents.md) - [Error Documents](https://developers.liveramp.com/rampid-api/reference/error-document.md): Learn about the error documents returned when the API encounters an error with one of the records in a batch. - [About Data Bundles](https://developers.liveramp.com/rampid-api/reference/about-data-bundles.md): Learn how the Retrieval API data bundles organize response data. - [Anonymous AbiliTec Bundle](https://developers.liveramp.com/rampid-api/reference/anonymous-abilitec-bundle.md) - [Computed Touchpoint Links Bundle](https://developers.liveramp.com/rampid-api/reference/computed-touchpoint-links-bundle.md) - [Metadata Bundles](https://developers.liveramp.com/rampid-api/reference/metadata-bundles.md) - [matchMetadata Bundle](https://developers.liveramp.com/rampid-api/reference/matchmetadata-bundle.md) - [validationErrors Bundle](https://developers.liveramp.com/rampid-api/reference/validationerrors-bundle.md) - [contactFlags Bundle](https://developers.liveramp.com/rampid-api/reference/contactflags-bundle.md) - [emailInsights Bundle](https://developers.liveramp.com/rampid-api/reference/emailinsights-bundle.md) - [Match Raw PII to RampID](https://developers.liveramp.com/rampid-api/reference/batch-request-calls-match.md): Use the Match endpoint to match raw PII data to a RampID. - [Match Hashed PII to RampID](https://developers.liveramp.com/rampid-api/reference/batch-request-calls-lookup.md): Use the Lookup endpoint to match hashed PII data to a RampID. - [About Identity Envelopes](https://developers.liveramp.com/rampid-api/reference/the-identity-envelope-decryption-endpoint.md): Learn what identity envelopes are. - [Create Identity Envelopes](https://developers.liveramp.com/rampid-api/reference/create-identity-envelopes.md): Use the API to create encrypted identity envelopes for RampIDs. - [Create Identity Envelopes (Batch Request)](https://developers.liveramp.com/rampid-api/reference/create-batched-identity-envelopes.md): Create encrypted identity envelopes for multiple RampIDs using a batch call. - [Create Identity Envelope (Single Transaction)](https://developers.liveramp.com/rampid-api/reference/create-a-single-identity-envelope.md): Create an encrypted identity envelope for a single RampID. - [Decrypt Identity Envelopes](https://developers.liveramp.com/rampid-api/reference/decrypt-identity-envelopes-1.md): Use the API to decrypt identity envelopes. - [Decrypt Identity Envelopes (Batch Request)](https://developers.liveramp.com/rampid-api/reference/decrypt-identity-envelopes-batch-request.md): Use the Identity Envelope API to decrypt multiple identity envelopes and receive their underlying RampIDs. - [Decrypt an Identity Envelope (Single Transaction)](https://developers.liveramp.com/rampid-api/reference/single-transaction-decrypt.md): Use the Identity Evelope API to decrypt a single identity envelope and receive a RampID. - [About RampID Translation](https://developers.liveramp.com/rampid-api/reference/transcode-rampids-1.md): Use the Translation endpoint to translate RampIDs from one partner encoding to another. - [Translate RampIDs (Batch Request)](https://developers.liveramp.com/rampid-api/reference/batch-request-calls-transcode-rampids.md): Use the Translation API to translate multiple RampIDs from one partner encoding to another. - [Translate RampIDs (Single Transaction)](https://developers.liveramp.com/rampid-api/reference/single-transaction-transcode.md): Use the Translation API to translate a single RampID from one partner encoding to another, either from your encoding to a partner's or from a partner's encoding to yours. ## Changelog - [Authentication Upgrade](https://developers.liveramp.com/rampid-api/changelog/authentication-upgrade.md) - [Added llms.txt](https://developers.liveramp.com/rampid-api/changelog/llmstxt.md) - [New RampID API Documentation Structure](https://developers.liveramp.com/rampid-api/changelog/new-rampid-api-documentation-structure.md) - [RampID API Security Enhancements](https://developers.liveramp.com/rampid-api/changelog/rampid-api-security-enhancements.md) - [Update to Error Documents](https://developers.liveramp.com/rampid-api/changelog/update-to-error-documents.md) - [TLS Requirement Upgrade](https://developers.liveramp.com/rampid-api/changelog/tls-requirement-upgrade.md) - [Site reorganization](https://developers.liveramp.com/rampid-api/changelog/site-reorganization.md)