Sending to DDx Exchange

Overview

DDx Exchange clients can easily upload data to the Exchange via the Dataset Exchange API, a product of the DDx API team.

With a storage bucket provisioned and maintained by the DDx API team, data is securely transferred to the Exchange and ingested for credits. Exchange clients can enable a set-it-and-forget-it integration which automatically transfers data to the Exchange whenever a client adds new data to be transferred.

The DDx Exchange App currently only supports data ingestion. To receive subscriptions & one-time downloads from the Exchange, you will need to use the DDx Exchange Subscriptions App. You can find more information here about receiving data from DDx.

Workflow Setup Requirements

To set up the Dataset Exchange API to DDx Exchange workflow, the following items are required:

• A current Exchange client agreement as either single organization or an enterprise member organization
• Data to share with the DDx Exchange
• Use of Google Cloud Platform (GCP)
  • Sign Up For Google Cloud Platform
  • How to: Configure access using GCP
• Clients who use S3 will continue to be able to use flat file transfer and will be supported on the Dataset Exchange API later in 2026!
• A DDx API Console Account:
  • The DDx API Console requires users to be part of an Organizational Workspace for configuring integrations. This is where Exchange clients can connect to the Exchange via the Dataset Exchange API. Once an account is created, the Exchange client status will be verified and access to setting up the connection will be approved. To set up an Organizational Workspace, review the steps here!
    Existing Exchange clients with Personal Workspaces:

    Request an Organizational Workspace by reaching out to [email protected] or directly to the Client Success Team. Your Organizational Workspace will have the same naming as your Exchange client slug.

    Existing Exchange clients with Organizational Workspaces:

    Confirm your Organizational Workspace name matches your Exchange client slug and reach out to [email protected] if you have any questions!

    New Exchange Clients:

    Get an Organizational Workspace by submitting a request to [email protected]

  • If you are an Exchange client who uses the flat file transfer service, you have the option to migrate your transfer to the Dataset Exchange API flow.

  ---

  Data Transfer Formatting Requirements

  Data Formatting Requirements

  DDx API follows the standard data type names from DDx’s data dictionary and you must set up your CSV file to follow the same column order of DDx's data dictionary. Data will not be transferred correctly for use in the DDx Exchange if data type names differ and/or columns are out of order. If that is the case, you may be required to resubmit your data. Reach out to [email protected] if you need an updated copy of the data dictionary!

  • Review the folder structure and standardization in the example below to ensure your data is properly uploaded into your bucket, using the GCS folder setup instructions.
  • Ensure your file path and filenames match i.e. the voter_registration_submissions file path should have a filename with the same convention. No shorthand!
  • If you are submitting survey response files and survey question metadata, please follow the respective column header ID.
  • If you require access to the DDx Data Dictionary, you can access it via your DDx Dashboard under the Resources tab, contact your DDx Exchange Client Representative, or reach out to [email protected].

File Structure Example

Please note: If you would like to upload a person list to share, this will be done directly in your DDx Dashboard under ‘Manage Lists’ using the List Uploader Feature.

Sending Data to the Exchange

1. Log in to your Organizational Workspace
2. Select View & Manage Datasets under the Dataset Exchange API tile
3. Select the Apps & Workspace Info tab and click the + Connect Application button

4. On the Connect an Application page, select the DDx Exchange App.
   • Note: Only select the DDx Exchange option. If you are interested in being able to use the Dataset Exchange API to connect to other available vendors you use, reach out to [email protected].
5. Confirm the permissions provided to the DDx Exchange App by clicking Next.
   

6. To receive the JSON credentials, select Generate One-Time Credentials .
7. View and copy the credentials into your GCP account to set up the bucket. DDx API provides a Google Cloud Platform (GCP) bucket where data can be added for transfer to the Exchange.

   JSON credentials can only be viewed/copied one time

   IMPORTANT: For security purposes, the JSON credentials can only be viewed/copied one time. Please be ready to input those credentials into GCP before clicking the button to generate the credentials.

   • If selecting Skip This Step, credentials can be accessed under the Apps & Workspace ID tab.

8. Copy the credentials and paste those credentials into a file to use for authentication when connecting to the bucket.

9. Once data is uploaded to the provided bucket, it will be picked up and transferred to the Exchange via the Dataset Exchange API.

• If you have a Snowflake set up or similar configuration that requires DDx API to access your service account, contact us at [email protected] to ensure proper set up!

10. Ensure any data that is uploaded follows the DDx Data Dictionary and is structured correctly for being ingested into the Exchange. Review the Data Transfer Requirements above prior to upload!