MarketingEmailRevisionsByEmailIdAndRevisionId |
Get a revision of a marketing email.Get a specific revision of a marketing email.
Catalog: MarketingEmailsV33
Schema: MarketingEmails
Label: {res:itgen_hubspot_marketingemailrevisionsbyemailidandrevisionid_plural}
This is a read-only table function. The HubSpot API may not support changing the data or the Invantive UniversalSQL driver for HubSpot does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the HubSpot API.
Parameters of Table Function
The following parameters can be used to control the behaviour of the table function MarketingEmailRevisionsByEmailIdAndRevisionId. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be evaluated using their default values.
Value specification by position is done by listing all values from the first to the last needed value. For example: a `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.
Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.
Name |
Data Type |
Required |
Default Value |
Documentation |
---|---|---|---|---|
emailId |
string |
☑ |
|
The marketing email ID. |
revisionId |
string |
☑ |
|
The ID of a revision. |
Columns of Table Function
The columns of the table function MarketingEmailRevisionsByEmailIdAndRevisionId are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
---|---|---|---|---|
id |
string |
ID |
☐ |
ID of this marketing email version. |
object_activeDomain |
string |
{res:itgen_hubspot_object_activedomain} |
☐ |
The active domain of the email. |
object_archived |
boolean |
Object Archived |
☐ |
Determines if the email is archived or not. |
object_businessUnitId |
string |
{res:itgen_hubspot_object_businessunitid} |
☐ |
|
object_campaign |
string |
Object Campaign |
☐ |
The ID of the campaign this email is associated to. |
object_content_flexAreas |
string |
{res:itgen_hubspot_object_content_flexareas} |
☐ |
|
object_content_plainTextVersion |
string |
{res:itgen_hubspot_object_content_plaintextversion} |
☐ |
|
object_content_smartFields |
string |
{res:itgen_hubspot_object_content_smartfields} |
☐ |
|
object_content_styleSettings |
string |
{res:itgen_hubspot_object_content_stylesettings} |
☐ |
|
object_content_templatePath |
string |
{res:itgen_hubspot_object_content_templatepath} |
☐ |
|
object_content_themeSettingsValues |
string |
{res:itgen_hubspot_object_content_themesettingsvalues} |
☐ |
|
object_content_widgetContainers |
string |
{res:itgen_hubspot_object_content_widgetcontainers} |
☐ |
|
object_content_widgets |
string |
{res:itgen_hubspot_object_content_widgets} |
☐ |
|
object_createdAt |
datetime |
{res:itgen_hubspot_object_createdat} |
☐ |
The date and time of the email's creation, in ISO8601 representation. |
object_createdById |
string |
Object Created by ID |
☐ |
The id of the user who created the email. |
object_deletedAt |
datetime |
Object Deleted at |
☐ |
|
object_feedbackSurveyId |
string |
{res:itgen_hubspot_object_feedbacksurveyid} |
☐ |
The ID of the feedback survey linked to the email. |
object_folderId |
int64 |
Object Folder ID |
☐ |
|
object_from_customReplyTo |
string |
{res:itgen_hubspot_object_from_customreplyto} |
☐ |
The reply to recipients will see. |
object_from_fromName |
string |
{res:itgen_hubspot_object_from_fromname} |
☐ |
The name recipients will see. |
object_from_replyTo |
string |
{res:itgen_hubspot_object_from_replyto} |
☐ |
The from address and reply to email address (if no customReplyTo defined) recipients will see. |
object_id |
string |
Object ID |
☐ |
The email ID. |
object_isPublished |
boolean |
{res:itgen_hubspot_object_ispublished} |
☐ |
Returns the published status of the email. This is read only. |
object_isTransactional |
boolean |
{res:itgen_hubspot_object_istransactional} |
☐ |
Returns whether the email is a transactional email or not. This is read only. |
object_language |
string |
Object Language |
☐ |
|
object_name |
string |
Object Name |
☐ |
The name of the email, as displayed on the email dashboard. |
object_publishDate |
datetime |
Object Publish Date |
☐ |
The date and time the email is scheduled for, in ISO8601 representation. This is only used in local time or scheduled emails. |
object_publishedAt |
datetime |
{res:itgen_hubspot_object_publishedat} |
☐ |
The date and time the email was published at, in ISO8601 representation. |
object_publishedById |
string |
{res:itgen_hubspot_object_publishedbyid} |
☐ |
|
object_rssData_blogEmailType |
string |
{res:itgen_hubspot_object_rssdata_blogemailtype} |
☐ |
|
object_rssData_blogImageMaxWidth |
int32 |
{res:itgen_hubspot_object_rssdata_blogimagemaxwidth} |
☐ |
|
object_rssData_blogLayout |
string |
{res:itgen_hubspot_object_rssdata_bloglayout} |
☐ |
|
object_rssData_hubspotBlogId |
string |
{res:itgen_hubspot_object_rssdata_hubspotblogid} |
☐ |
|
object_rssData_maxEntries |
int32 |
{res:itgen_hubspot_object_rssdata_maxentries} |
☐ |
|
object_rssData_rssEntryTemplate |
string |
{res:itgen_hubspot_object_rssdata_rssentrytemplate} |
☐ |
|
object_rssData_timing |
string |
{res:itgen_hubspot_object_rssdata_timing} |
☐ |
|
object_rssData_url |
string |
{res:itgen_hubspot_object_rssdata_url} |
☐ |
|
object_rssData_useHeadlineAsSubject |
boolean |
{res:itgen_hubspot_object_rssdata_useheadlineassubject} |
☐ |
|
object_sendOnPublish |
boolean |
{res:itgen_hubspot_object_sendonpublish} |
☐ |
Determines whether the email will be sent immediately on publish. |
object_state |
string |
Object State |
☐ |
The email state. |
object_stats_counters |
string |
{res:itgen_hubspot_object_stats_counters} |
☐ |
Counters like number of `sent`, `open` or `delivered`. |
object_stats_deviceBreakdown |
string |
{res:itgen_hubspot_object_stats_devicebreakdown} |
☐ |
Statistics by device. |
object_stats_qualifierStats |
string |
{res:itgen_hubspot_object_stats_qualifierstats} |
☐ |
Number of emails that were dropped and bounced. |
object_stats_ratios |
string |
{res:itgen_hubspot_object_stats_ratios} |
☐ |
Ratios like `openratio` or `clickratio` |
object_subcategory |
string |
{res:itgen_hubspot_object_subcategory} |
☐ |
The email subcategory. |
object_subject |
string |
{res:itgen_hubspot_object_subject} |
☐ |
The subject of the email. |
object_subscriptionDetails_officeLocationId |
string |
{res:itgen_hubspot_object_subscriptiondetails_officelocationid} |
☐ |
ID of the selected office location. |
object_subscriptionDetails_preferencesGroupId |
string |
{res:itgen_hubspot_object_subscriptiondetails_preferencesgroupid} |
☐ |
|
object_subscriptionDetails_subscriptionId |
string |
{res:itgen_hubspot_object_subscriptiondetails_subscriptionid} |
☐ |
ID of the subscription. |
object_testing_abSampleSizeDefault |
string |
{res:itgen_hubspot_object_testing_absamplesizedefault} |
☐ |
Version of the email that should be sent if there are too few recipients to conduct an AB test. |
object_testing_abSamplingDefault |
string |
{res:itgen_hubspot_object_testing_absamplingdefault} |
☐ |
Version of the email that should be sent if the results are inconclusive after the test period, master or variant. |
object_testing_abStatus |
string |
{res:itgen_hubspot_object_testing_abstatus} |
☐ |
Status of the AB test. |
object_testing_abSuccessMetric |
string |
{res:itgen_hubspot_object_testing_absuccessmetric} |
☐ |
Metric to determine the version that will be sent to the remaining contacts. |
object_testing_abTestPercentage |
int32 |
{res:itgen_hubspot_object_testing_abtestpercentage} |
☐ |
The size of your test group. |
object_testing_hoursToWait |
int32 |
{res:itgen_hubspot_object_testing_hourstowait} |
☐ |
Time limit on gathering test results. After this time is up, the winning version will be sent to the remaining contacts. |
object_testing_testId |
string |
{res:itgen_hubspot_object_testing_testid} |
☐ |
The ID of the AB test. |
object_to_limitSendFrequency |
boolean |
{res:itgen_hubspot_object_to_limitsendfrequency} |
☐ |
|
object_to_suppressGraymail |
boolean |
{res:itgen_hubspot_object_to_suppressgraymail} |
☐ |
|
object_type |
string |
{res:itgen_hubspot_object_type} |
☐ |
The email type, this is derived from other properties on the email such as subcategory. |
object_updatedAt |
datetime |
{res:itgen_hubspot_object_updatedat} |
☐ |
The date and time of the last update to the email, in ISO8601 representation. |
object_updatedById |
string |
Object Updated by ID |
☐ |
The id of the user who last updated the email. |
object_webversion_domain |
string |
{res:itgen_hubspot_object_webversion_domain} |
☐ |
|
object_webversion_expiresAt |
datetime |
{res:itgen_hubspot_object_webversion_expiresat} |
☐ |
|
object_webversion_metaDescription |
string |
{res:itgen_hubspot_object_webversion_metadescription} |
☐ |
|
object_webversion_redirectToPageId |
string |
{res:itgen_hubspot_object_webversion_redirecttopageid} |
☐ |
|
object_webversion_redirectToUrl |
string |
{res:itgen_hubspot_object_webversion_redirecttourl} |
☐ |
|
object_webversion_slug |
string |
{res:itgen_hubspot_object_webversion_slug} |
☐ |
|
object_webversion_title |
string |
{res:itgen_hubspot_object_webversion_title} |
☐ |
|
updatedAt |
datetime |
Updated at |
☐ |
|
user_email |
string |
User Email |
☐ |
Email address of the user. |
user_fullName |
string |
User Full Name |
☐ |
First and last name of the user. |
user_id |
string |
User ID |
☐ |
ID of the user. |
18-12-2024 20:09 Version 24.1.33-BETA+5180