Domains: HubSpot Domains |
Get current domainsReturns all existing domains that have been created. Results can be limited and filtered by creation or updated date.
Catalog: Domains3
Schema: Domains
Label: Domains
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 Domains. 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 |
---|---|---|---|---|
after |
string |
☐ |
|
The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results. |
archived |
boolean |
☐ |
|
Whether to return only results that have been archived. |
createdAfter |
datetime |
☐ |
|
Only return domains created after this date. |
createdAt |
datetime |
☐ |
|
Only return domains created at this date. |
createdBefore |
datetime |
☐ |
|
Only return domains created before this date. |
updatedAfter |
datetime |
☐ |
|
Only return domains updated after this date. |
updatedAt |
datetime |
☐ |
|
Only return domains updated at this date. |
updatedBefore |
datetime |
☐ |
|
Only return domains updated before this date. |
Columns of Table Function
The columns of the table function Domains are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
---|---|---|---|---|
correctCname |
string |
Correct CNAME |
☐ |
|
created |
datetime |
Created at |
☐ |
|
domain |
string |
Domain |
☐ |
The actual domain or sub-domain. e.g. www.hubspot.com |
id |
string |
ID |
☐ |
The unique ID of this domain. |
isResolving |
boolean |
Is Resolving |
☐ |
Whether the DNS for this domain is optimally configured for use with HubSpot. |
isSslEnabled |
boolean |
Is SSL Enabled |
☐ |
|
isSslOnly |
boolean |
Is SSL Only |
☐ |
|
isUsedForBlogPost |
boolean |
Is Used for Blog Post |
☐ |
Whether the domain is used for CMS blog posts. |
isUsedForEmail |
boolean |
Is Used for Email |
☐ |
Whether the domain is used for CMS email web pages. |
isUsedForKnowledge |
boolean |
Is Used for Knowledge |
☐ |
Whether the domain is used for CMS knowledge pages. |
isUsedForLandingPage |
boolean |
Is User for Landing Page |
☐ |
Whether the domain is used for CMS landing pages. |
isUsedForSitePage |
boolean |
Is Used for Site Page |
☐ |
Whether the domain is used for CMS site pages. |
manuallyMarkedAsResolving |
boolean |
Manually Marked as Resolving |
☐ |
|
primaryBlogPost |
boolean |
Primary Blog Post |
☐ |
|
primaryEmail |
boolean |
Primary Email |
☐ |
|
primaryKnowledge |
boolean |
Primary Knowledge |
☐ |
|
primaryLandingPage |
boolean |
Primary Landing Page |
☐ |
|
primarySitePage |
boolean |
Primary Site Page |
☐ |
|
secondaryToDomain |
string |
Secondary to Domain |
☐ |
|
updated |
datetime |
Updated at |
☐ |
|
18-12-2024 20:09 Version 24.1.33-BETA+5180