Skip to content

Iterable V2 #1224

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mvistry wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Iterable V2 #1224

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9b2a2e1
Added v2
mvistry Jul 3, 2026
8285988
Automated commit: Generate foreign keys
invalid-email-address Jul 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1,082 changes: 1,082 additions & 0 deletions _data/taps/schemas/iterable-core/v2/iterable-core-v2-foreign-keys.yml
View file
Open in desktop

Large diffs are not rendered by default.

195 changes: 195 additions & 0 deletions _data/taps/schemas/iterable-core/v2/iterable-core-v2-tables.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,195 @@
tap: iterable-core
version: '2'
tables:
- name: campaigns
description: 'The **{{ table.name }}** table contains information about campaigns
in your {{ integration.display_name }} projcect.

'
links:
singer-schema: https://github.com/singer-io/tap-iterable/tree/master/tap_iterable/schemas/campaigns.json
api-method: https://api.iterable.com/api/docs#campaigns_campaigns
table-details:
replication-method: Key-based Incremental
primary-key: id
replication-key: updatedAt
- name: channels
description: 'The **{{ table.name }}** table contains information about all channels
within your {{ integration.display_name }} project.

'
links:
singer-schema: https://github.com/singer-io/tap-iterable/tree/master/tap_iterable/schemas/channels.json
api-method: https://api.iterable.com/api/docs#channels_channels
table-details:
replication-method: Full Table
primary-key: id
- name: email_bounce
description: 'The **{{ table.name }}** table contains information about bounced
emails within your {{ integration.display_name }} campaign.

'
links:
singer-schema: https://github.com/singer-io/tap-iterable/tree/master/tap_iterable/schemas/email_bounce.json
api-method: https://api.iterable.com/api/docs#export_exportDataJson
table-details:
replication-method: Key-based Incremental
primary-key: email
replication-key: createdAt
- name: email_click
description: 'The **{{ table.name }}** table contains information about clicks on
your {{ integration.display_name }} email campaign.

'
links:
singer-schema: https://github.com/singer-io/tap-iterable/tree/master/tap_iterable/schemas/email_click.json
api-method: https://api.iterable.com/api/docs#export_exportDataJson
table-details:
replication-method: Key-based Incremental
primary-key: email
replication-key: createdAt
- name: email_complaint
description: 'The **{{ table.name }}** table contains information about email recipients
that sent complaints for your {{ integration.display_name }} campain.

'
links:
singer-schema: https://github.com/singer-io/tap-iterable/tree/master/tap_iterable/schemas/email_complaint.json
api-method: https://api.iterable.com/api/docs#export_exportDataJson
table-details:
replication-method: Key-based Incremental
primary-key: email
replication-key: createdAt
- name: email_open
description: 'The **{{ table.name }}** table contains information about email recipients
that opened your {{ integration.display_name }} campaign.

'
links:
singer-schema: https://github.com/singer-io/tap-iterable/tree/master/tap_iterable/schemas/email_open.json
api-method: https://api.iterable.com/api/docs#export_exportDataJson
table-details:
replication-method: Key-based Incremental
primary-key: email
replication-key: createdAt
- name: email_send
description: 'The **{{ table.name }}** table contains information about campaign
emails you sent in your {{ integration.display_name }} account.

'
links:
singer-schema: https://github.com/singer-io/tap-iterable/tree/master/tap_iterable/schemas/email_send.json
api-method: https://api.iterable.com/api/docs#export_exportDataJson
table-details:
replication-method: Key-based Incremental
primary-key: email
replication-key: createdAt
- name: email_send_skip
description: 'The **{{ table.name }}** table contains information about campaign
email recipients that were skipped in your {{ integration.display_name }} account.

'
links:
singer-schema: https://github.com/singer-io/tap-iterable/tree/master/tap_iterable/schemas/email_send_skip.json
api-method: https://api.iterable.com/api/docs#export_exportDataJson
table-details:
replication-method: Key-based Incremental
primary-key: email
replication-key: createdAt
- name: email_subscribe
description: 'The **{{ table.name }}** table contains information about emails subscribed
to your {{ integration.display_name }} campaign.

'
links:
singer-schema: https://github.com/singer-io/tap-iterable/tree/master/tap_iterable/schemas/email_subscribe.json
api-method: https://api.iterable.com/api/docs#export_exportDataJson
table-details:
replication-method: Key-based Incremental
primary-key: email
replication-key: createdAt
- name: email_unsubscribe
description: 'The **{{ table.name }}** table contains information about emails unsubscribed
from your {{ integration.display_name }} campaign.

'
links:
singer-schema: https://github.com/singer-io/tap-iterable/tree/master/tap_iterable/schemas/email_unsubscribe.json
api-method: https://api.iterable.com/api/docs#export_exportDataJson
table-details:
replication-method: Key-based Incremental
primary-key: email
replication-key: createdAt
- name: lists
description: 'The **{{ table.name }}** tablecontains information about lists within
your {{ integration.display_name }} project.

'
links:
singer-schema: https://github.com/singer-io/tap-iterable/tree/master/tap_iterable/schemas/lists.json
api-method: https://api.iterable.com/api/docs#lists_getLists
table-details:
replication-method: Full Table
primary-key: id
- name: list_users
description: 'The **{{ table.name }}** table contains information about users in
a list in your {{ integration.display_name }} account.

'
links:
singer-schema: https://github.com/singer-io/tap-iterable/tree/master/tap_iterable/schemas/list_users.json
api-method: https://api.iterable.com/api/docs#lists_getLists_0
table-details:
replication-method: Full Table
primary-keys:
- email
- listId
- name: message_types
description: 'The **{{ table.name }}** table contains information about all message
types within your {{ integration.display_name }} project.

'
links:
singer-schema: https://github.com/singer-io/tap-iterable/tree/master/tap_iterable/schemas/message_types.json
api-method: https://api.iterable.com/api/docs#messageTypes_messageTypes
table-details:
replication-method: Full Table
primary-key: id
- name: metadata
description: 'The **{{ table.name }}** table contains the metadata for a single
key in your {{ integration.display_name }} account.

'
links:
singer-schema: https://github.com/singer-io/tap-iterable/tree/master/tap_iterable/schemas/metadata.json
api-method: https://api.iterable.com/api/docs#metadata_get
table-details:
replication-method: Full Table
primary-key: key
- name: templates
description: 'The **{{ table.name }}** table contains information about project
templates in you {{ integration.display_name }} account.

'
links:
singer-schema: https://github.com/singer-io/tap-iterable/tree/master/tap_iterable/schemas/templates.json
api-method: https://api.iterable.com/api/docs#templates_getTemplates
table-details:
replication-method: Key-based Incremental
primary-key: templateId
replication-key: updatedAt
- name: users
description: 'The **{{ table.name }}** table contains information about all users
in your {{ integration.display_name }} account.

'
links:
doc-link: https://api.iterable.com/api/docs#export_exportDataJson
singer-schema: https://github.com/singer-io/tap-iterable/tree/master/tap_iterable/schemas/users.json
api-method: ttps://api.iterable.com/api/docs#export_exportDataJson
table-details:
replication-method: Key-based Incremental
primary-key: email
replication-key: profileUpdatedAt
tap-repo-schemas: true

129 changes: 129 additions & 0 deletions _data/taps/schemas/iterable-core/v2/json/campaigns.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,129 @@
{
"properties": {
"campaignState": {
"type": [
"null",
"string"
]
},
"createdAt": {
"type": [
"null",
"date-time"
]
},
"createdByUserId": {
"type": [
"null",
"string"
]
},
"endedAt": {
"type": [
"null",
"date-time"
]
},
"id": {
"type": [
"null",
"integer"
]
},
"labels": {
"items": {},
"type": [
"null",
"array"
]
},
"listIds": {
"items": {
"type": [
"null",
"integer"
]
},
"type": [
"null",
"array"
]
},
"messageMedium": {
"type": [
"null",
"string"
]
},
"name": {
"type": [
"null",
"string"
]
},
"recurringCampaignId": {
"type": [
"null",
"integer"
]
},
"sendSize": {
"type": [
"null",
"number"
]
},
"startAt": {
"type": [
"null",
"date-time"
]
},
"suppressionListIds": {
"items": {
"type": [
"null",
"integer"
]
},
"type": [
"null",
"array"
]
},
"templateId": {
"type": [
"null",
"integer"
]
},
"type": {
"type": [
"null",
"string"
]
},
"updatedAt": {
"type": [
"null",
"date-time"
]
},
"updatedByUserId": {
"type": [
"null",
"string"
]
},
"workflowId": {
"type": [
"null",
"integer"
]
}
},
"type": [
"null",
"object"
]
}
32 changes: 32 additions & 0 deletions _data/taps/schemas/iterable-core/v2/json/channels.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
{
"properties": {
"channelType": {
"type": [
"null",
"string"
]
},
"id": {
"type": [
"null",
"integer"
]
},
"messageMedium": {
"type": [
"null",
"string"
]
},
"name": {
"type": [
"null",
"string"
]
}
},
"type": [
"null",
"object"
]
}
Loading