Navigation: » No topics above this level «

BlogPosts: HubSpot Blog Posts

Get all Blog PostsGet the list of blog posts. Supports paging and filtering. This method would be useful for an integration that examined these models and used an external service to suggest edits.

Catalog: CMSBlogPosts

Schema: BlogPosts

Label: Blog Posts

This is a read-only table function. The HubSpot API may not support changing the data or the Invantive SQL 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 BlogPosts. 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	Documentation
after	string	☐	The cursor token value to get the next set of results. You can get this from the `paging.next.after` JSON property of a paged response containing more results.
archived	boolean	☐	Specifies whether to return deleted Blog Posts. Defaults to `false`.
createdAfter	datetime	☐	Only return Blog Posts created after the specified time.
createdAt	datetime	☐	Only return Blog Posts created at exactly the specified time.
createdBefore	datetime	☐	Only return Blog Posts created before the specified time.
updatedAfter	datetime	☐	Only return Blog Posts last updated after the specified time.
updatedAt	datetime	☐	Only return Blog Posts last updated at exactly the specified time.
updatedBefore	datetime	☐	Only return Blog Posts last updated before the specified time.

Columns of Table Function

The columns of the table function BlogPosts are shown below. Each column has an SQL data type.

Name	Data Type	Label	Required	Documentation
abStatus	string	A/B Status	☐
abTestId	string	A/B Test ID	☐
archived	boolean	Archived	☐
archivedInDashboard	boolean	Archived in Dashboard	☐	If True, the post will not show up in your dashboard, although the post could still be live.
authorName	string	Author Name	☐	The name of the user that updated this Blog Post.
blogAuthorId	string	Blog Author ID	☐	The ID of the Blog Author associated with this Blog Post.
campaign	string	Campaign	☐	The GUID of the marketing campaign this Blog Post is a part of.
categoryId	int32	Category ID	☐	ID of the type of object this is. Should always .
contentGroupId	string	Content Group ID	☐	The ID of the parent Blog this Blog Post is associated with.
contentTypeCategory	string	Content Type Category	☐	An ENUM descibing the type of this object. Should always be BLOG_POST.
created	datetime	Created at	☐
createdById	string	Created by ID	☐	The ID of the user that created this Blog Post.
currentlyPublished	boolean	Currently Published	☐
currentState	string	Current State	☐	A generated ENUM descibing the current state of this Blog Post. Should always match state.
deletedAt	datetime	Deleted at	☐	The timestamp (ISO8601 format) when this Blog Post was deleted.
domain	string	Domain	☐	The domain this Blog Post will resolve to. If null, the Blog Post will default to the domain of the ParentBlog.
dynamicPageDataSourceId	string	Dynamic Page Data Source ID	☐
dynamicPageDataSourceType	int32	Dynamic Page Data Source Type	☐
enableDomainStylesheets	boolean	Enable Domain Stylesheets	☐	Boolean to determine whether or not the styles from the template should be applied.
enableGoogleAmpOutputOverride	boolean	Enable Google AMP Output Override	☐	Boolean to allow overriding the AMP settings for the blog.
enableLayoutStylesheets	boolean	Enable Layout Stylesheets	☐	Boolean to determine whether or not the styles from the template should be applied.
featuredImage	string	Featured Image	☐	The featuredImage of this Blog Post.
featuredImageAltText	string	Featured Image Alternate Text	☐	Alt Text of the featuredImage.
folderId	string	Folder ID	☐
footerHtml	string	Footer (HTML)	☐	Custom HTML for embed codes, javascript that should be placed before the </body> tag of the page.
headHtml	string	Head (HTML)	☐	Custom HTML for embed codes, javascript, etc. that goes in the <head> tag of the page.
htmlTitle	string	Title (HTML)	☐	The html title of this Blog Post.
id	string	ID	☐	The unique ID of the Blog Post.
includeDefaultCustomCss	boolean	Include Default Custom CSS	☐	Boolean to determine whether or not the Primary CSS Files should be applied.
language	string	Language	☐	The explicitly defined ISO 639 language code of the Blog Post. If null, the Blog Post will default to the language of the ParentBlog.
layoutSections	string	Layout Sections	☐
linkRelCanonicalUrl	string	Link Rel Canonical (URL)	☐	Optional override to set the URL to be used in the rel=canonical link tag on the page.
mabExperimentId	string	MAB Experiment ID	☐
metaDescription	string	Meta Description	☐	A description that goes in <meta> tag on the page.
name	string	Name	☐	The internal name of the Blog Post.
pageExpiryDate	int64	Page Expiry Date	☐
pageExpiryEnabled	boolean	Page Expiry Enabled	☐
pageExpiryRedirectId	int64	Page Expiry Redirect ID	☐
pageExpiryRedirectUrl	string	Page Expiry Redirect (URL)	☐
password	string	Password	☐	Set this to create a password protected page. Entering the password will be required to view the page.
postBody	string	Post Body	☐	The HTML of the main post body.
postSummary	string	Post Summary	☐	The summary of the blog post that will appear on the main listing page.
publicAccessRulesEnabled	boolean	Public Access Rules Enabled	☐	Boolean to determine whether or not to respect publicAccessRules.
publishDate	datetime	Publish Date	☐	The date (ISO8601 format) the blog post is to be published at.
publishImmediately	boolean	Publish Immediately	☐	Set this to true if you want to be published immediately when the schedule publish endpoint is called, and to ignore the publish_date setting.
rssBody	string	RSS Body	☐	The contents of the RSS body for this Blog Post.
rssSummary	string	RSS Summary	☐	The contents of the RSS summary for this Blog Post.
slug	string	Slug	☐	The path of the this blog post. This field is appended to the domain to construct the url of this post.
state	string(25)	State	☐	An ENUM descibing the current state of this Blog Post.
tagIds	string	Tag IDs	☐	List of IDs for the tags associated with this Blog Post.
themeSettingsValues	string	Theme Setting Values	☐
translatedFromId	string	Translated from ID	☐	ID of the primary blog post this object was translated from.
translations	string	Translations	☐
updated	datetime	Updated at	☐
updatedById	string	Updated by ID	☐	The ID of the user that updated this Blog Post.
url	string	URL	☐	A generated field representing the URL of this blog post.
useFeaturedImage	boolean	Use Featured Image	☐	Boolean to determine if this post should use a featuredImage.
widgetContainers	string	Widget Containers	☐	A data structure containing the data for all the modules inside the containers for this post. This will only be populated if the page has widget containers.
widgets	string	Widgets	☐	A data structure containing the data for all the modules for this page.

17-08-2023 07:25 Version 22.1.262-BETA+4120

Important Safety and Usage Information

Intended Use and Limitations: This software, developed by Invantive, is designed to support a variety of business and information technology data processing functions, such as accounting, financial reporting an sales reporting. It is important to note that this software is not designed, tested, or approved for use in environments where malfunction or failure could lead to life-threatening situations or severe physical or environmental damage. This includes, but is not limited to:

Nuclear facilities: The software should not be used for operations or functions related to the control, maintenance, or operation of nuclear facilities.
Defense and Military Applications: This software is not suitable for use in defense-related applications, including but not limited to weaponry control, military strategy planning, or any other aspects of national defense.
Aviation: The software is not intended for use in the operation, navigation, or communication systems of any aircraft or air traffic control environments.
Healthcare and Medicine Production: This software should not be utilized for medical device operation, patient data analysis for critical health decisions, pharmaceutical production, or medical research where its failure or malfunction could impact patient health.
Chemical and Hazardous Material Handling: This software is not intended for the management, control, or operational aspects of chemical plants or hazardous material handling facilities. Any malfunction in software used in these settings could result in dangerous chemical spills, explosions, or environmental disasters.
Transportation and Traffic Control Systems: The software should not be used for the control, operation, or management of transportation systems, including railway signal controls, subway systems, or traffic light management. Malfunctions in such critical systems could lead to severe accidents and endanger public safety.
Energy Grid and Utility Control Systems: This software is not designed for the control or operation of energy grid systems, including electrical substations, renewable energy control systems, or water utility control systems. The failure of software in these areas could lead to significant power outages, water supply disruptions, or other public utility failures, potentially endangering communities and causing extensive damage.
Other High-Risk Environments: Any other critical infrastructure and environments where a failure of the software could result in significant harm to individuals or the environment.

User Responsibility: Users must ensure that they understand the intended use of the software and refrain from deploying it in any setting that falls outside of its designed purpose. It is the responsibility of the user to assess the suitability of the software for their intended application, especially in any scenarios that might pose a risk to life, health, or the environment.

Disclaimer of Liability: Invantive disclaims any responsibility for damage, injury, or legal consequences resulting from the use or misuse of this software in prohibited or unintended applications.

Please enable JavaScript to view this site.

HubSpot API Data Model

BlogPosts: HubSpot Blog Posts

Parameters of Table Function

Columns of Table Function

Important Safety and Usage Information