Import from DonorDrive Public REST API

The Import from DonorDrive Public REST API template uses the “DonorDrive Public REST API” to import data onto Civis Platform. This API is distinct from and should not be confused with other DonorDrive APIs, especially the “REST API” and “Query API” (for which Civis Platform has another import – please see here).

Parameters

• DonorDrive Instance (required): This is a custom credential on Platform. The password should be the URL domain of your DonorDrive instance in the form of http://try.donordrive.com, where the “try” part should be replaced by the subdomain specific to your DonorDrive instance. For the username of this custom credential, please provide your email address.
• DonorDrive Resource (required): DonorDrive resource to pull data from. Select a resource option. The import job will use the corresponding URL path to fetch data through the DonorDrive Public API. If the path indicates a parameter is needed using braces (e.g., {eventID}), please provide the value(s) of the relevant parameter as well.
  
  

• Event ID (optional): ID of events. To find eventID, visit your Event’s Fundraising Page and look for the &eventID= URL parameter. To fetch data for multiple IDs, provide a comma-separated list of IDs here.
• Participant ID (optional): ID of participants. To find participantID, visit your Participant's Fundraising Page and look for the &participantID= URL parameter. To fetch data for multiple IDs, provide a comma-separated list of IDs here.
• Team ID (optional): ID of teams. To find teamID, visit your Team’s Fundraising Page and look for the &teamID= URL parameter. To fetch data for multiple IDs, provide a comma-separated list of IDs here.
• Group code (optional): Teams group code. To find the groupCode, contact your DonorDrive Administrator. To fetch data for multiple IDs, provide a comma-separated list of IDs here.
• Destination Database (required): The database in which to write records to.
• Destination Database Credential (required): A valid database credential for the cluster.
• Schema and Table (required): The schema and table name you would like to import the data into, e.g., “schema.table”.
• If Table Exists (optional): The action to take if a table with the requested name already exists. Options are:
  • Fail: The sync job fails if the table exists
  • Append: Records will be appended to the existing table
  • Truncate: Records on the table will be wiped out while maintaining the current columns.
  • Drop: Removes the entire table including column information.
  • Upsert: Update or insert records into the specified table. The upsert mode modifies the table by leveraging the Primary key as well as Last modified keys values provided to modify existing records or add new ones. Visit Upsert Mode for more information on how it works.
• Max Errors (optional): The maximum number of rows with errors to remove from the Civis Platform table import before failing. Defaults to 0 (i.e., no errors allowed).
• Dist Style (optional): The distribution style for the resulting table. One of 'even', 'all' or 'key'. Defaults to 'key'.
• Dist Key (optional): The column to use as the distkey for the table. Defaults to 'id'. If you import data that doesn’t have a column named ‘id’, please provide the column name for the primary key.
• Sort Key 1 (optional): The column to use as the sortkey for the table.
• Sort Key 2 (optional): The second column in a compound sortkey for the table.
• Primary Keys (optional): A comma separated list of the primary key column(s) of the destination table that uniquely identifies a record.
• Last Modified Keys (optional): A comma separated list of the columns indicating a record has been updated.
• Log Level (optional): Which level of logging to use. The options are “INFO” (default), “DEBUG” (more verbose), and “WARNING” (less verbose).