# dotdigital V2

### Snapshot

| Features                        | Details                                                                                 |
| ------------------------------- | --------------------------------------------------------------------------------------- |
| Release Status                  | Released                                                                                |
| Source API Version              | v2                                                                                      |
| Table Selection                 | Yes                                                                                     |
| Column Selection                | Yes                                                                                     |
| Edit Integration                | Yes                                                                                     |
| Replication Type Selection      | No                                                                                      |
| Authentication Parameters       | <p>Dotdigital Account Username<br>Dotdigital Account Password<br>Dotdigital  Region</p> |
| Replication Type                | <p>Key Based Replication<br>Full-based Replication</p>                                  |
| Replication Key                 | <p>Date<br>NA</p>                                                                       |
| Suggested Replication Frequency | 24 hrs                                                                                  |

| Tables/APIs Supported  |                              |
| ---------------------- | ---------------------------- |
| AddressBooks           | Campaigns                    |
| CampaignSummary        | CampaignOpens                |
| Segments               | Contacts                     |
| CampaignActivity       | CampaignsClicksAndLinkGroups |
| Programs               | Surveys                      |
| ContactsScoring        | ContactsDataFields           |
| DocumentFolders        | ImageFolders                 |
| ProductRecommendations | SmsCampaigns                 |

Templates

### Integrate DotDigital with Daton

1. Signin to Daton
2. Select DotDigital from Integrations page
3. Provide Integration Name, Replication Frequency, and History. Integration name would be used in creating tables for the integration and cannot be changed later
4. Provide DotDigital region id, DotDigital api user email and Password to authorize Daton to periodically extract data from DotDigital
5. Post successful authentication, you will be prompted to choose from the list of available tables
6. Then select all required fields for each table
7. Submit the integration

### Workflow

1. Integrations would be in Pending state initially and will be moved to Active state as soon as the first job loads data successfully on to the configured warehouse
2. Users would be able to edit/pause/re-activate/delete integration anytime
3. Users can view job status and process logs from the integration details page by clicking on the integration name from the active list

### DotDigital Data

**AddressBooks**

Purpose: Gets all address books

Source API Documentation:  <https://developer.dotdigital.com/reference/address-books#get-address-books>

Replication: Full-Based Replication

Replication Key: NA

**Fields**

| Name       | Target Datatype |
| ---------- | --------------- |
| id         | INTEGER         |
| name       | STRING          |
| visibility | STRING          |
| contacts   | INTEGER         |

**Campaigns**

Purpose: Gets all campaigns

Source API Documentation:  <https://developer.dotdigital.com/reference/campaigns#get-all-campaigns>

Replication: Full-Based Replication

Replication Key: NA

**Fields**

| Name             | Target Datatype |
| ---------------- | --------------- |
| id               | INTEGER         |
| name             | STRING          |
| subject          | STRING          |
| fromName         | STRING          |
| fromAddress      | RECORD          |
| htmlContent      | STRING          |
| plainTextContent | STRING          |
| replyAction      | STRING          |
| replyToAddress   | STRING          |
| isSplitTest      | BOOLEAN         |
| status           | STRING          |

**CampaignSummary**

Purpose: Gets a summary of reporting information for a specified campaign

Source API Documentation:  <https://developer.dotdigital.com/reference/campaigns#get-campaign-summary>

Replication: Full-Based Replication

Replication Key: NA

**Fields**

| Name                      | Target Datatype |
| ------------------------- | --------------- |
| dateSent                  | TIMESTAMP       |
| numUniqueOpens            | NUMERIC         |
| numUniqueTextOpens        | NUMERIC         |
| numTotalUniqueOpens       | NUMERIC         |
| numOpens                  | NUMERIC         |
| numTextOpens              | NUMERIC         |
| numTotalOpens             | NUMERIC         |
| numClicks                 | NUMERIC         |
| numTextClicks             | NUMERIC         |
| numTotalClicks            | NUMERIC         |
| numPageViews              | NUMERIC         |
| numTotalPageViews         | NUMERIC         |
| numTextPageViews          | NUMERIC         |
| numForwards               | NUMERIC         |
| numTextForwards           | NUMERIC         |
| numEstimatedForwards      | NUMERIC         |
| numTextEstimatedForwards  | NUMERIC         |
| numTotalEstimatedForwards | NUMERIC         |
| numReplies                | NUMERIC         |
| numTextReplies            | NUMERIC         |
| numTotalReplies           | NUMERIC         |
| numHardBounces            | NUMERIC         |
| numTextHardBounces        | NUMERIC         |
| numTotalHardBounces       | NUMERIC         |
| numSoftBounces            | NUMERIC         |
| numTextSoftBounces        | NUMERIC         |
| numTotalSoftBounces       | NUMERIC         |
| numUnsubscribes           | NUMERIC         |
| numTextUnsubscribes       | NUMERIC         |
| numTotalUnsubscribes      | NUMERIC         |
| numIspComplaints          | NUMERIC         |
| numTextIspComplaints      | NUMERIC         |
| numTotalIspComplaints     | NUMERIC         |
| numMailBlocks             | NUMERIC         |
| numTextMailBlocks         | NUMERIC         |
| numTotalMailBlocks        | NUMERIC         |
| numSent                   | NUMERIC         |
| numTextSent               | NUMERIC         |
| numTotalSent              | NUMERIC         |
| numRecipientsClicked      | NUMERIC         |
| numDelivered              | NUMERIC         |
| numTextDelivered          | NUMERIC         |
| numTotalDelivered         | NUMERIC         |
| percentageDelivered       | NUMERIC         |
| percentageUniqueOpens     | NUMERIC         |
| percentageOpens           | NUMERIC         |
| percentageUnsubscribes    | NUMERIC         |
| percentageReplies         | NUMERIC         |
| percentageHardBounces     | NUMERIC         |
| percentageSoftBounces     | NUMERIC         |
| percentageUsersClicked    | NUMERIC         |
| percentageClicksToOpens   | NUMERIC         |

**CampaignOpens**

Purpose: Gets a list of campaign opens

Source API Documentation:  <https://developer.dotdigital.com/reference/campaigns#get-campaign-opens>

Replication: Key-Based Replication

Replication Key: lastRunDate

**Fields**

| Name              | Target Datatype |
| ----------------- | --------------- |
| contactId         | INTEGER         |
| email             | STRING          |
| mailClient        | STRING          |
| mailClientVersion | STRING          |
| ipAddress         | STRING          |
| userAgent         | STRING          |
| isHtml            | BOOLEAN         |
| isForward         | BOOLEAN         |
| dateOpened        | TIMESTSMP       |

**Segments**

Purpose: Gets all segments

Source API Documentation:  <https://developer.dotdigital.com/reference/segments>

Replication: Key-Based Replication

Replication Key: Modified\_Time

**Fields**

| Name     | Target Datatype |
| -------- | --------------- |
| id       | STRING          |
| name     | RECORD          |
| contacts | RECORD          |

**Contacts**

Purpose: Gets a list of created contacts after a specified date

Source API Documentation:  <https://developer.dotdigital.com/reference/contacts#get-contacts-created-since-date>

Replication: Key-Based Replication

Replication Key: lastRunDate

**Fields**

| Name       | Target Datatype |
| ---------- | --------------- |
| id         | STRING          |
| email      | NUMERIC         |
| optInType  | RECORD          |
| emailType  | STRING          |
| dataFields | STRING          |
| status     | RECORD          |

**CampaignActivity**

Purpose: Gets a list of contacts who were sent a campaign, with their activity

Source API Documentation:  <https://developer.dotdigital.com/reference/campaigns#get-campaign-activity>

Replication: Key-Based Replication

Replication Key: lastRunDate

**Fields**

| Name                 | Target Datatype |
| -------------------- | --------------- |
| contactId            | RECORD          |
| email                | STRING          |
| numOpens             | STRING          |
| numPageViews         | STRING          |
| numClicks            | STRING          |
| numForwards          | STRING          |
| numEstimatedForwards | STRING          |
| numReplies           | STRING          |
| dateSent             | STRING          |
| dateFirstOpened      | STRING          |
| dateLastOpened       | STRING          |
| firstOpenIp          | STRING          |
| unsubscribed         | STRING          |
| softBounced          | STRING          |
| hardBounced          | STRING          |

**CampaignsClicksAndLinkGroups**

Purpose: Gets a list of link clicks for a campaign after a specified date

Source API Documentation:  <https://developer.dotdigital.com/reference/campaigns#get-campaign-clicks-since-date>

Replication: Key-Based Replication

Replication Key: lastRunDate

**Fields**

| fullname                | type      |
| ----------------------- | --------- |
| contactId               | NUMERIC   |
| email                   | STRING    |
| url                     | STRING    |
| ipAddress               | STRING    |
| userAgent               | STRING    |
| dateClicked             | TIMESTAMP |
| keyword                 | STRING    |
| \_daton\_user\_id       | NUMERIC   |
| \_daton\_batch\_runtime | NUMERIC   |
| \_daton\_batch\_id      | NUMERIC   |
| Campaign\_Id            | STRING    |

**Programs**

Purpose: Gets all programs

Source API Documentation:  <https://developer.dotdigital.com/reference/programs#get-programs>

Replication: Full-Based Replication

Replication Key: NA

**Fields**

| Name        | Target Datatype |
| ----------- | --------------- |
| id          | NUMERIC         |
| name        | STRING          |
| status      | STRING          |
| dateCreated | TIMESTAMP       |

**ContactsScoring**

Purpose: AGets contact scoring for all contacts in the account

Source API Documentation:  <https://developer.dotdigital.com/reference/contacts#get-scoring-for-contacts>

Replication: Full-Based Replication

Replication Key: NA

**Fields**

| Name         | Target Datatype |
| ------------ | --------------- |
| contactId    | STRING          |
| email        | RECORD          |
| dateModified | RECORD          |
| scoreLabel   | STRING          |
| score        | STRING          |
| engagement   | STRING          |
| suitability  | STRING          |

**ContactsDataFields**

Purpose: Lists all contact data fields within the account

Source API Documentation:  <https://developer.dotdigital.com/reference/contact-data-fields#get-contact-data-fields>

Replication: Full-Based Replication

Replication Key: NA

**Fields**

| Name         | Target Datatype |
| ------------ | --------------- |
| name         | BOOLEAN         |
| type         | RECORD          |
| visibility   | STRING          |
| defaultValue | STRING          |
| Description  | STRING          |

**DocumentFolders**

Purpose: Fetches the document folder tree structure

Source API Documentation:  <https://developer.dotdigital.com/reference/document-folders#get-document-folders>

Replication: Full-Based Replication

Replication Key: NA

**Fields**

| Name         | Target Datatype |
| ------------ | --------------- |
| id           | INTEGER         |
| name         | STRING          |
| childFolders | RECORD          |

**ImageFolders**

Purpose:Fetches the campaign image folder tree structure

Source API Documentation:  <https://developer.dotdigital.com/reference/image-folders#get-image-folders>

Replication: Full-Based Replication

Replication Key: NA

**Fields**

| Name         | Target Datatype |
| ------------ | --------------- |
| id           | INTEGER         |
| name         | STRING          |
| childFolders | RECORD          |

**ProductRecommendations**

Purpose: Gets all product recommendations

Source API Documentation:  <https://developer.dotdigital.com/reference/product-recommendations#get-all-product-recommendations-1>

Replication: Full-Based Replication

Replication Key: NA

**Fields**

| Name                     | Target Datatype |
| ------------------------ | --------------- |
| id                       | INTEGER         |
| dateLastRefreshed        | TIMESTAMP       |
| dateModified             | TIMESTAMP       |
| dateLastUsed             | TIMESTAMP       |
| name                     | STRING          |
| type                     | STRING          |
| status                   | STRING          |
| fallbackRecommendationId | NUMERIC         |
| revenue                  | NUMERIC         |

**SmsCampaigns**

Purpose: Returns existing SMS campaigns

Source API Documentation:  <https://developer.dotdigital.com/reference/sms#copy-sms-campaign>

Replication: Full-Based Replication

Replication Key: NA

**Fields**

| Name              | Target Datatype |
| ----------------- | --------------- |
| id                | INTEGER         |
| name              | STRING          |
| message           | STRING          |
| sendingIdentityId | STRING          |
| sendingIdentity   | STRING          |
| status            | STRING          |
| toggleShortLinks  | STRING          |

**Surveys**

Purpose: Gets a list of all surveys in the account

Source API Documentation:  <https://developer.dotdigital.com/reference/survey-and-forms#get-surveys>

Replication: Full-Based Replication

Replication Key: NA

**Fields**

| Name                             | Target Datatype |
| -------------------------------- | --------------- |
| id                               | INTEGER         |
| name                             | STRING          |
| url                              | STRING          |
| dateSurveyCreated                | TIMESTAMP       |
| dateSurveyModified               | TIMESTAMP       |
| state                            | STRING          |
| firstActiveDate                  | TIMESTAMP       |
| lastInactiveDate                 | TIMESTAMP       |
| scheduledStartDate               | TIMESTAMP       |
| scheduledEndDate                 | TIMESTAMP       |
| confirmationMode                 | STRING          |
| submissionMode                   | STRING          |
| fieldCount                       | NUMERIC         |
| notifyCreatorOnResponse          | BOOLEAN         |
| respondentNotificationType       | STRING          |
| respondentNotificationCampaignId | STRING          |
| isAssignedToAddressBook          | BOOLEAN         |
| assignedAddressBookTarget        | STRING          |
| assignedSpecificAddressBookId    | STRING          |
| firstResponseDate                | STRING          |
| lastResponseDate                 | STRING          |
| totalCompleteResponses           | NUMERIC         |
| totalCompleteResponsesInLastDay  | NUMERIC         |
| totalCompleteResponsesInLastWeek | NUMERIC         |
| totalIncompleteResponses         | NUMERIC         |
| totalViews                       | NUMERIC         |
| totalBounces                     | NUMERIC         |
| timeToCompleteMax                | NUMERIC         |
| timeToCompleteMin                | NUMERIC         |
| timeToCompleteTotal              | NUMERIC         |
| sourceDirectTotal                | NUMERIC         |
| sourceEmailTotal                 | NUMERIC         |
| sourceEmbeddedTotal              | NUMERIC         |
| sourcePopoverTotal               | NUMERIC         |
| sourceFacebookTotal              | NUMERIC         |
| sourceTwitterTotal               | NUMERIC         |
| sourceGooglePlusTotal            | NUMERIC         |
| sourceOtherTotal                 | NUMERIC         |

**Templates**

Purpose: Gets list of all templates

Source API Documentation:  <https://developer.dotdigital.com/reference/templates#get-templates>

Replication: Full-Based Replication

Replication Key: NA

**Fields**

| Name             | Target Datatype |
| ---------------- | --------------- |
| id               | INTEGER         |
| name             | STRING          |
| subject          | STRING          |
| fromName         | STRING          |
| htmlContent      | STRING          |
| plainTextContent | STRING          |
| replyAction      | STRING          |
| replyToAddress   | STRING          |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://daton-sarasanalytics.gitbook.io/daton/integrations/data-sources/saas-integrations/dotdigital-1.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.