Cloud

Build 25.0.9434
  • WordPress
    • Getting Started
      • Establishing a Connection
      • Advanced Settings
      • SSL Configuration
      • Firewall and Proxy
    • Data Model
      • WordPress Data Model
        • Tables
          • Categories
          • Comments
          • Media
          • Members
          • Pages
          • Plugins
          • Posts
          • Tags
          • Users
        • Views
          • Taxonomies
          • TaxonomyTerms
          • Types
        • Stored Procedures
          • CreateMedia
          • UpdateSettings
      • WordPressOnline Data Model
        • Tables
          • Categories
          • Comments
          • KeyRingConnection
          • Media
          • NavigationMenus
          • Posts
          • PublicizeConnection
          • SiteWidgets
          • SiteWordAdsSettings
          • SiteWordAdsTos
          • Tags
          • TaxonomyTerms
          • Users
        • Views
          • AuditHistoryforComments
          • BlogRecommendations
          • ClickEmails
          • CommentCounts
          • CommentLikes
          • CommentLikeStatus
          • DropDownPages
          • EmailSettings
          • Feed
          • Follows
          • Insights
          • MatchingFeeds
          • OpenEmails
          • PostReblogStatus
          • PostsTags
          • PostTypes
          • ReaderMenuDefault
          • ReaderMenuRecommended
          • ReaderMenuSubscribed
          • RecentComments
          • SharingButtons
          • SiteCountryViews
          • SiteEmailSummary
          • SiteFileDownloads
          • SiteFollowers
          • SiteOutboundClicks
          • SitePosts
          • SitePostViews
          • SitePublicizeConnection
          • SitePublicizeFollowerComment
          • SitePublicizeFollowerCounts
          • Sites
          • SiteSearchTerms
          • SiteShortCodesRender
          • SitesPageTemplates
          • SiteStats
          • SiteStatsReferrers
          • SiteStatsSummary
          • SiteStatsTags
          • SiteStatsVideo
          • SiteTopAuthors
          • SiteTopComments
          • SiteTopPostsStats
          • SiteTotalViewsforPost
          • SiteVideoPlays
          • SiteWordAdsEarnings
          • SiteWordAdsStats
          • StatHighlights
          • SubscriberPosts
          • SubscriptionCount
          • TaxonomyPostType
          • TopTags
          • TrendingTags
          • UserBillingHistory
          • UserFollowedPosts
          • UserFollowingFeeds
          • UserLikedPosts
          • UserLikes
          • UserPreferences
          • UserSitesPosts
          • UserSubscribedTags
          • VideoPoster
          • VideopressChapter
          • Videos
        • Stored Procedures
          • ActivateWidgets
          • CreateMedia
          • DeleteTracks
          • FollowSpecifiedBlog
          • LikeAComment
          • LikeAPost
          • MarkNotificationAsRead
          • PostCounts
          • ReblogPost
          • RecentNotificationSeenTimestamp
          • RemoveLikeFromComment
          • ReplytoAnotherComment
          • ReportReferrerAsSpam
          • RestorePosts
          • RestorePoststoPreviousStatus
          • SendTwoStepCode
          • SiteEmbeds
          • SiteRenderedEmbeds
          • SiteShortCodes
          • SubscribeNewTag
          • UnFollowSpecifiedBlog
          • UnLikeAPost
          • UnReportReferrerAsSpam
          • UnsubscribeTag
          • WordAdsApproved
      • System Tables
        • sys_catalogs
        • sys_schemas
        • sys_tables
        • sys_tablecolumns
        • sys_procedures
        • sys_procedureparameters
        • sys_keycolumns
        • sys_foreignkeys
        • sys_primarykeys
        • sys_indexes
        • sys_connection_props
        • sys_sqlinfo
        • sys_identity
        • sys_information
    • Connection String Options
      • Authentication
        • AuthScheme
        • URL
        • Schema
        • User
        • Password
      • SSO
        • SSOLoginURL
        • SSOProperties
        • SSOExchangeURL
      • OAuth
        • OAuthClientId
        • OAuthClientSecret
        • Scope
      • SSL
        • SSLServerCert
      • Logging
        • Verbosity
      • Schema
        • BrowsableSchemas
      • Miscellaneous
        • MaxRows
        • PseudoColumns
        • Timeout
    • Third Party Copyrights

WordPress - CData Cloud

Overview

CData Cloud offers access to WordPress across several standard services and protocols, in a cloud-hosted solution. Any application that can connect to a SQL Server database can connect to WordPress through CData Cloud.

CData Cloud allows you to standardize and configure connections to WordPress as though it were any other OData endpoint or standard SQL Server.

Key Features

  • Full SQL Support: WordPress appears as standard relational databases, allowing you to perform operations - Filter, Group, Join, etc. - using standard SQL, regardless of whether these operations are supported by the underlying API.
  • CRUD Support: Both read and write operations are supported, restricted only by security settings that you can configure in Cloud or downstream in the source itself.
  • Secure Access: The administrator can create users and define their access to specific databases and read-only operations or grant full read & write privileges.
  • Comprehensive Data Model & Dynamic Discovery: CData Cloud provides comprehensive access to all of the data exposed in the underlying data source, including full access to dynamic data and easily searchable metadata.

CData Cloud

Getting Started

This page provides a guide to Establishing a Connection to WordPress in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.

Connecting to WordPress

Establishing a Connection shows how to authenticate to WordPress and configure any necessary connection properties to create a database in CData Cloud

Accessing Data from CData Cloud Services

Accessing data from WordPress through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.

CData Cloud

Establishing a Connection

Connect to WordPress by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.

Connecting to WordPress

CData Cloud supports connecting to self-hosted WordPress instances and WordPress Online instances.

  • If you are connecting to self-hosted WordPress, you must provide the URL of your WordPress site and then authenticate.
  • If you are connecting to WordPress Online, you can choose between OAuth 2.0 and OAuth Password authentication.

Connecting to Self-Hosted WordPress

For self-hosted WordPress instances, to connect to data, provide the full URL for your WordPress site, and then authenticate as described below. For example, if your site is hosted at http://localhost/wp/wordpress, you should enter it as http://localhost/wp/wordpress, not just http://localhost. Failing to provide the complete URL will lead to a 'site not found' error.

Self-hosted WordPress instances support two types of authentication:

  • Basic authentication: This method is recommended for use in testing environments. It provides a way to access your WordPress instance.
  • OAuth 2.0 authentication: This method supports secure, browser-based access from various platforms, including desktop applications, web applications, and headless machines.
Note: Choose the method that fits your needs based on the environment and level of security required.

Basic Authentication

Before you configure WordPress to use Basic Authentication, follow these guidelines:

  • Ensure that your WordPress login has administrative privileges.
  • Be aware of the version of WordPress running on the local host. Note: Versions 4.7 and later support the WordPress REST API natively, while earlier versions require a Basic Authentication plug-in to secure REST API access.

To configure Basic Authentication:

  1. Log into your WordPress host.
  2. If you are running an earlier WordPress version than 4.7, install the REST API plugin.
  3. Install the Basic Authentication plugin.
  4. To create custom taxonomies, install the Simple Taxonomy Refreshed plugin.
    If you prefer installing the plugins manually, extract the compressed folders to the wp-content\plugins folder and then enable the plugins via the WordPress admin interface.
  5. Next, set the following connection properties:

    • AuthScheme: Set this to Basic.
    • URL: Your WordPress URL.
    • User: Your username.
    • Password: Your password.

You are now ready to connect.

OAuth 2.0 Authentication

For all non-testing environments, WordPress supports OAuth authentication only. To enable this authentication from all OAuth flows, you must set AuthScheme to OAuth, and you must create a custom OAuth application.

The following subsections describe how to authenticate to WordPress from three common authentication flows. For information about how to create a custom OAuth application, see Creating a Custom OAuth Application. For a complete list of connection string properties available in WordPress, see Connection.

Automatic refresh of the OAuth access token:

To have the Cloud automatically refresh the OAuth access token, do the following:

  1. Before connecting to data for the first time, set the following connection parameters:
    • InitiateOAuth: Set this to REFRESH.
    • OAuthClientId: The client Id in your application settings.
    • OAuthClientSecret: The client secret in your application settings.
    • OAuthAccessToken: The access token returned by GetOAuthAccessToken.
    • OAuthSettingsLocation: The path where you want the Cloud to save the OAuth values, which persist across connections.
  2. On subsequent data connections, set the following:
    • InitiateOAuth
    • OAuthSettingsLocation

OAuthClient Authentication
The client credentials grant type allows authentication from desktop applications or the web. To enable this authscheme, set AuthScheme to OAuthClient. This method requires a custom OAuth application, as described in Creating a Custom OAuth Application.

To connect, set these properties:

  • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the access token in the connection string.
  • AuthScheme: Set the AuthScheme to OAuthClient to perform authentication with the client credentials grant type.
  • OAuthClientId: The client Id specified in your custom OAuth application.
  • OAuthClientSecret: The client secret specified in your custom OAuth application.

Okta

To connect to Okta, set these properties:

  • AuthScheme: Okta.
  • User: The authentiating Okta user.
  • Password: The password of the authenticating Okta user.
  • SSOLoginURL: The SSO provider's login URL.
  • SSOExchangeURL: The url used for the exchange of the SAML token for WordPress credentials. This is optional and if it is NULL WordPress will construct it.

If you are either using a trusted application or proxy that overrides the Okta client request OR configuring MFA, you must use combinations of SSOProperties to authenticate using Okta. Set any of the following, as applicable:

  • APIToken: When authenticating a user via a trusted application or proxy that overrides the Okta client request context, set this to the API Token the customer created from the Okta organization.
  • MFAType: If you have configured the MFA flow, set this to one of the following supported types: OktaVerify, Email, or SMS.
  • MFAPassCode: If you have configured the MFA flow, set this to a valid passcode.
    If you set this to empty or an invalid value, the Cloud issues a one-time password challenge to your device or email. After the passcode is received, reopen the connection where the retrieved one-time password value is set to the MFAPassCode connection property.
  • MFARememberDevice: True by default. Okta supports remembering devices when MFA is required. If remembering devices is allowed according to the configured authentication policies, the Cloud sends a device token to extend MFA authentication lifetime. If you do not want MFA to be remembered, set this variable to False.

Example connection string:

AuthScheme=Okta;SSOLoginURL='https://example.okta.com/home/appType/0bg4ivz6cJRZgCz5d6/46';User=oktaUserName;Password=oktaPassword;URL=YourWordpressSiteURL;

Azure AD

This configuration requires two separate Azure AD applications:

  • The "WordPress" application used for single sign-on, and
  • A custom OAuth application with user_impersonation permission on the Azure Active Directory.

To connect to Azure AD, set the AuthScheme to AzureAD, and set these properties:

  • SSOExchangeURL: The url used for the exchange of the SAML token for WordPress credentials. This is optional and if it is NULL WordPress will construct it.
  • OAuthClientId: The application Id of the connector application, listed in the Overview section of the app registration.
  • OAuthClientSecret: The client secret value of the connector application. Azure AD displays this when you create a new client secret.
  • CallbackURL: The redirect URI of the connector application. For example: https://localhost:33333.

To authenticate to Azure AD, set these required properties in SSOProperties:

  • Resource: The application Id URI of the WordPress application, listed in the app registration's Overview section. In most cases this is the URL of your custom WordPress domain.
  • AzureTenant: The Id of the Azure AD tenant where the applications are registered.

Example connection string:

AuthScheme=AzureAD;URL=YourWordpressSiteURL;OAuthClientId=3ea1c786-d527-4399-8c3b-2e3696ae4b48;OauthClientSecret=xxx;CallbackUrl=https://localhost:33333;SSOProperties='Resource=https://YourWordpressSite/wp-content/plugins/miniorange-saml-20-single-sign-on;AzureTenant=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx';
You are now ready to connect.

PingFederate

To connect to PingFederate, set the AuthScheme to PingFederate.

Before connecting, ensure that your WordPress site is configured with a PingFederate SSO plugin and that the authenticating user is provisioned in the PingFederate Data Store.

Set the following connection properties:

  • User: The PingFederate user. You must also add this user to PingFederate Data Stores. When connecting with a browser, you are redirected to the PingFederate login page to complete authentication.
  • Password: The PingFederate user's password.
  • SSOLoginURL: The PingFederate SSO login URL.
  • SSOExchangeURL (optional): The URL used for exchanging the SAML token for WordPress credentials. If not provided, the Cloud attempts to construct it automatically.

Example connection string:

AuthScheme=PingFederate;URL=https://yourwordpresssite.com;User=myuser@mydomain;Password=mypassword;SSOLoginURL=https://idp.example.com/idp/startSSO.ping;

Connecting to WordPress Online

WordPress Online supports two types of authentication methods:

  1. OAuth 2.0 authentication
  2. OAuth Password authentication

OAuth 2.0 Authentication

OAuth 2.0 is a protocol that allows applications to interact with blogs on WordPress, Your Way, and self-hosted WordPress sites running Jetpack.

The two authentication endpoints are the authorization endpoint and the token request endpoint.

  • https://public-api.wordpress.com/oauth2/authorize
  • https://public-api.wordpress.com/oauth2/token

Before you begin, you must create and register a custom OAuth application with WordPress.com, as described in Creating a Custom OAuth Application. This application provides the client Id, client secret, and redirect URI required to authenticate your application and verify API calls. You can create or manage your applications in the WordPress Applications Manager.

Use these values with the authorization endpoints, which require the following parameters:

When you are ready to connect, set the following connection properties:

  • Schema: WordPressOnline.
  • AuthScheme: OAuth.
  • URL: Your WordPress.com site URL.
  • InitiateOAuth: Set this to GETANDREFRESH.
  • OAuthClientId: The client Id from your WordPress.com application.
  • OAuthClientSecret: The client secret from your WordPress.com application.

There is an optional parameter available that can be used:

  • Scope: Defines the level of access that the authentication token grants to your application. Depending on the value set (or omitted), different access is allowed. Supported values include:
    • Auth: Grants access to /me endpoints for WordPress.com Connect.
    • Global: Grants full access to all the blogs associated with the user's account, including any Jetpack-connected sites. If omitted, access is limited to a single blog.

OAuth Password Authentication

Set the following connection properties:

  • Schema: WordPressOnline.
  • AuthScheme: OAuthPassword.
  • URL: Your WordPress Online URL.
  • OAuthClientId: The client Id assigned when you registered your custom OAuth application.
  • OAuthClientSecret: The client secret assigned when you registered your custom OAuth application.
  • User: Your username.
  • Password: Your password.

Example connection strings:

AuthScheme=OAuthPassword;Schema=WordPressOnline;URL=https://example.wordpress.com;OAuthClientId=yourClientId;OAuthClientSecret=yourClientSecret;User=yourUser;Password=yourPassword;

AuthScheme=OAuth;Schema=WordPressOnline;URL=https://example.wordpress.com;InitiateOAuth=GETANDREFRESH;OAuthClientId=yourClientId;OAuthClientSecret=yourClientSecret;

CData Cloud

Advanced Settings

Customizing the SSL Configuration

By default, the Cloud attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store. To specify another certificate, see the SSLServerCert property for the available formats to do so.

Connecting Through a Firewall or Proxy

HTTP Proxies

To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.

In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.

Other Proxies

Set the following properties:

  • To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
  • To tunnel the connection, set FirewallType to TUNNEL.
  • To authenticate, specify FirewallUser and FirewallPassword.
  • To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

CData Cloud

SSL Configuration

Customizing the SSL Configuration

To enable TLS, set the following:

  • URL: Prefix the connection string with https://

With this configuration, the Cloud attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.

To specify another certificate, see the SSLServerCert connection property.

CData Cloud

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

  • ProxyServer: the hostname or IP address of the proxy server that you want to route HTTP traffic through.
  • ProxyPort: the TCP port that the proxy server is running on.
  • ProxyAuthScheme: the authentication method the Cloud uses when authenticating to the proxy server.
  • ProxyUser: the username of a user account registered with the proxy server.
  • ProxyPassword: the password associated with the ProxyUser.

Other Proxies

Set the following properties:

  • To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
  • To tunnel the connection, set FirewallType to TUNNEL.
  • To authenticate, specify FirewallUser and FirewallPassword.
  • To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

CData Cloud

Data Model

The CData Cloud models WordPress data as an easy-to-use SQL database with tables, views, and stored procedures.

The Cloud exposes two schemas:

  • See WordPress Data Model for the available entities in the WordPress API.
  • See WordPressOnline Data Model for the available entities in the WordPress Online API.

Stored Procedures

These are actions that are invoked via SQL queries. They perform tasks beyond standard CRUD operations, including creating and uploading media and managing OAuth tokens.

Using Query Processing

The Cloud offloads as much of the SELECT statement processing as possible to the WordPress APIs and then processes the rest of the query within the Cloud. For details about specific API limitations and requirements, see the WordPress Data Model and WordPressOnline Data Model sections.

CData Cloud

WordPress Data Model

The CData Cloud models WordPress data as an easy-to-use SQL database. There are three parts to the data model: tables, views, and stored procedures.

Tables

The Tables section, which details standard SQL tables, and the Views section, which lists read-only SQL tables are available through the self-hosted WordPress API. Data availability depends on the authenticated user's role and site configuration.

Commonly used tables include:

Table Description
Categories Create, update, delete, and query Categories to use for categorizing your posts.
Comments Create, update, delete, and query Comments associated with a post.
Media Create, update, delete, and query Media to attach in your posts.
Members Create, update, delete, and list the Members of the website.
Pages Create, update, delete, and query Wordpress Pages.
Plugins Create, update, delete, and query Plugins.
Posts Create, update, delete, and query Wordpress Posts.
Tags Create, update, delete, and query Tags to associate with your posts.
Users Create, update, delete, and list the Users of the website.
Taxonomies List all the taxonomies.
TaxonomyTerms List all terms of the taxonomies.
Types List Types associated with the Posts.

Stored Procedures

Stored Procedures are actions that are invoked via SQL queries. They perform tasks beyond standard CRUD operations, including creating and uploading media and managing OAuth tokens.

CData Cloud

Tables

The Cloud models the data in WordPress as a list of tables in a relational database that can be queried using standard SQL statements.

CData Cloud - WordPress Tables

Name Description
Categories Returns information about WordPress categories, including their names, descriptions, and post counts.
Comments Returns comments from WordPress posts, including author details, content, and status information.
Media Create, update, delete, and query Media to attach in your posts.
Members Create, update, delete, and list the Members of the website.
Pages Create, update, delete, and query Wordpress Pages.
Plugins Create, update, delete, and query Plugins.
Posts Create, update, delete, and query Wordpress Posts.
Tags Create, update, delete, and query Tags to associate with your posts.
Users Create, update, delete, and list the Users of the website.

CData Cloud

Categories

Returns information about WordPress categories, including their names, descriptions, and post counts.

Table Specific Information

SELECT

The Cloud uses the WordPress API to process some of the filters. The Cloud processes other filters client-side within the Cloud. For example, the following queries are processed server side.

SELECT * FROM Categories WHERE Parent = 0
SELECT * FROM Categories ORDER BY Id
SELECT * FROM Categories WHERE Id IN ('130', '129')
Also, ordering by Count, Description and Name, is handled by the WordPress API.

Insert

To insert a category the following column is required: Name.

INSERT INTO Categories (Description, Name, Parent) VALUES ('This is an example Category', 'myCategory', '138')

Update

To update a category you must specify the following column: Id.

UPDATE Categories SET Name = 'updatedName', Description = 'Updated description.', Parent = 137 WHERE Id = '139'

Delete

To delete a category you must specify the following column: Id.

DELETE FROM Categories WHERE Id = '139'

Columns

Name Type ReadOnly References Description
Id [KEY] Integer True

A unique integer that identifies the category in WordPress and links posts, tags, and other taxonomy data associated with that category.

Count Integer True

The total number of posts currently assigned to the category, as returned by the WordPress API.

Description String False

The descriptive text defined in WordPress for the category, typically used to explain its purpose or the type of posts it contains.

Link String True

The full URL returned by WordPress that links to the public category page associated with this record.

Name String False

The category name defined in WordPress, representing the label shown on the site and used to organize related posts.

Taxonomy String True

The taxonomy type that classifies the category in WordPress.

Parent Integer False

The identifier of the parent category that this category belongs to. A value of 0 indicates that the category has no parent.

CData Cloud

Comments

Returns comments from WordPress posts, including author details, content, and status information.

Table Specific Information

Select

The Cloud uses the WordPress API to process supported filters. The Cloud processes other filters client-side within the Cloud. To retrieve and filter the values for the AuthorEmail column, use Context='edit' in the WHERE clause.

For example, the following queries are processed server side.

SELECT * FROM Comments WHERE Id = 61
SELECT * FROM Comments WHERE Id IN (61, 45)
SELECT * FROM Comments WHERE AuthorEmail = '[email protected]' AND Status = 'approve' AND Type = 'comment' AND PostId = '1' AND Context='edit'
SELECT * FROM Comments WHERE Author IN ('1', '2')
SELECT * FROM Comments WHERE Date > '2018-02-02T02:02:23'
SELECT * FROM Comments WHERE Date < '2018-02-02T02:02:23'
SELECT * FROM Comments ORDER BY Date DESC
Also, ordering by Id, DateGMT, Type, Parent, is handled by the WordPress API.

Insert

To insert comments you must specify the following columns: PostId, Content.

INSERT INTO Comments (PostId, Content) VALUES ('1', 'This is a comment in the post with id 1.')

Update

To update a comment you must specify the following column: Id
UPDATE Comments SET Content = 'Updated content' WHERE Id = '1234'
Other fields that you can use on INSERT / UPDATE queries are: Author, AuthorEmail, AuthorIp, AuthorName, AuthorUrl, Content, Date, DateGMT, Parent, PostId, Status.

Delete

To delete a Comment you must specify the following column: Id.

DELETE FROM Comments WHERE Id = '1234'

Columns

Name Type ReadOnly References Description
Id [KEY] Integer True

The unique identifier for the comment object in WordPress.

Author Integer False

Specifies the name of the author who submitted the comment on the WordPress post.

AuthorEmail String False

The author's email address for the object. To filter values for this column.

AuthorIp String False

The IP address associated with the comment's author, identifying the source location from which the comment was submitted to WordPress.

AuthorName String False

The display name of the user who authored the comment in WordPress.

AuthorUrl String False

Specifies the website URL submitted by the author when posting the comment.

Date Datetime False

The date and time when the comment was posted in WordPress.

DateGMT Datetime False

The date the object was published as Greenwich Mean Time (GMT).

Status String False

The approval status of the comment, such as approved, pending, or spam.

The allowed values are hold, approved, spam, trash.

Type String True

Specifies the type of comment, such as a standard comment, trackback, or pingback.

Parent Integer False

Specifies the identifier of the parent comment when this comment is a reply. A value of 0 indicates no parent.

Content String False

The text content of the comment submitted by the author.

PostId Integer False

The unique identifier of the post or page associated with the comment.

Link String True

The URL linking directly to the comment on the associated WordPress post.

Pseudo-Columns

Pseudo-column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the data returned by the operation.

Name Type Description
Context String

The context or area of WordPress where the comment was posted.

The allowed values are view, edit, embed.

CData Cloud

Media

Create, update, delete, and query Media to attach in your posts.

Table Specific Information

Select

The Cloud uses the WordPress API to process supported filters. The Cloud processes other filters client-side within the Cloud. Note: The Status column only accepts the following values for select operation: inherit and private. For example, the following queries are processed server side.

SELECT * FROM Media WHERE Id IN ('1176', '1175')
SELECT * FROM Media WHERE Id = '1176'
SELECT * FROM Media WHERE AuthorId IN (1, 2)
SELECT * FROM Media WHERE MimeType = 'image/jpeg'
SELECT * FROM Media WHERE Status = 'Inherit'
SELECT * FROM Media WHERE Date < '2018-02-02T02:02:23'
SELECT * FROM Media WHERE Date > '2018-02-02T02:02:23'
SELECT * FROM Media ORDER BY Id
Also, ordering by Date, Modified, and AuthorId is handled by the WordPress API.

Update

To update a media you must specify the following column: Id.
UPDATE Media SET Title = 'Updated Title' WHERE Id = '4'
Other fields that you can use on INSERT and UPDATE queries are: Date, DateGMT, Status, Title, AuthorId, CommentStatus, PingStatus, Caption, Description, PostId.

Delete

To delete a media you must specify the following column: Id.

DELETE FROM Media WHERE Id = '1234'

Columns

Name Type ReadOnly References Description
Id [KEY] Integer True

The unique identifier of the media item in WordPress.

Title String False

The title assigned to the media item, such as the file name or a descriptive label.

Date Datetime False

The date and time when the media item was uploaded, recorded in the site's local timezone.

DateGMT Datetime False

The upload date and time of the media item recorded in Greenwich Mean Time (GMT).

Modified Datetime True

The date and time when the media item was last modified in the site's local timezone.

ModifiedGMT Datetime True

The date and time when the media item was last modified in Greenwich Mean Time (GMT).

Status String False

The publication status of the media item, such as inherit or private.

Type String True

Specifies the type of WordPress post associated with the media item, typically 'attachment'.

AuthorId Integer False

The unique identifier of the user who uploaded or owns the media item.

CommentStatus String False

Indicates whether comments are allowed on the media item.

PingStatus String False

Indicates whether the media item can receive pingbacks or trackbacks.

Caption String False

A short explanatory caption or description displayed with the media item.

Description String False

The full description or additional details provided for the media item.

MediaType String True

Specifies the general type of the media item, such as image, video, or audio.

MimeType String True

The Multipurpose Internet Mail Extensions (MIME) type of the media file, such as image/jpeg or video/mp4.

PostId Integer False

The ID of the post or page the media item is attached to, if applicable.

SourceUrl String True

The direct URL to the original media file stored in WordPress.

Link String True

The permalink URL for viewing the media item in WordPress.

Pseudo-Columns

Pseudo-column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the data returned by the operation.

Name Type Description
FileLocation String

Specifies the local file path or source location of the media file to upload.

CData Cloud

Members

Create, update, delete, and list the Members of the website.

Table Specific Information

SELECT

The Cloud uses the WordPress API to process some of the filters. The Cloud processes other filters client-side within the Cloud. For example, the following queries are processed server side.

SELECT * FROM Members WHERE Id = 10

Update

To update a member you must specify the following column: Id.

UPDATE Members SET Title = 'updatedName' WHERE Id = '139'

Delete

To delete a member you must specify the following column: Id.

DELETE FROM Members WHERE Id = '139'

Columns

Name Type ReadOnly References Description
Id [KEY] Integer True

The unique identifier of the member record in WordPress.

Date Datetime False

The date and time when the member record was created, recorded in the site's local timezone.

DateGMT Datetime False

The date and time when the member record was created, recorded in Greenwich Mean Time (GMT).

Slug String False

The URL-friendly version of the member name, used to create clean and readable links.

Status String False

Indicates the current status of the member record, such as active or inactive.

Title Object False

The display name or title assigned to the member.

Link String False

The direct URL linking to the member's public profile or related content.

CData Cloud

Pages

Create, update, delete, and query Wordpress Pages.

Table Specific Information

Select

The Cloud uses the WordPress API to process supported filters. The Cloud processes other filters client-side within the Cloud. For example, the following queries are processed server side.

SELECT * FROM Pages WHERE Id IN (1, 2)
SELECT * FROM Pages WHERE Author IN ('1', '23')
SELECT * FROM Pages WHERE Parent IN (0, 2)
SELECT * FROM Pages WHERE Status = 'Publish'
SELECT * FROM Pages WHERE MenuOrder = 1
SELECT * FROM Pages WHERE Date > '2018-02-02T02:02:23'
SELECT * FROM Pages WHERE Date < '2018-02-02T02:02:23'
SELECT * FROM Pages ORDER BY Id
Also, ordering by Author, Title, Date, Modified, Parent, MenuOrder, is handled by the WordPress API.

Insert and Update

To insert a page, it's enough to specify one of the fields below:

INSERT INTO Pages (Title, Content, Status) VALUES ('A title', 'Some content here', 'publish')

To update a page you must specify the following column: Id.

UPDATE Pages SET Status = 'draft', Content = 'Updated content', Title = 'Updated title' WHERE Id = '12345'
Other fields that you can use on INSERT and UPDATE queries are: Date, DateGMT, Status, Parent, Title, Content, Author, MediaId, CommentStatus, PingStatus, and MenuOrder.

Delete

To delete a page you must specify the following column: Id.

DELETE FROM Pages WHERE Id = '12345'

Columns

Name Type ReadOnly References Description
Id [KEY] Integer True

The unique identifier of the page in WordPress.

Author Integer False

The unique identifier of the user who created or owns the page.

Title String False

The title of the WordPress page, as displayed in listings or navigation menus.

Date Datetime False

The date and time when the page was published, recorded in the site's local timezone.

DateGMT Datetime False

The date and time when the page was published, recorded in Greenwich Mean Time (GMT).

Link String True

The permalink URL for viewing the published page on the WordPress site.

Modified Datetime True

The date and time when the page was last updated, recorded in the site's local timezone.

ModifiedGMT Datetime True

The date and time when the page was last updated, recorded in GMT.

Status String False

Indicates the current publication status of the page, such as publish, future, draft, pending, or private.

The allowed values are publish, future, draft, pending, private.

Type String True

Specifies the content type of the object, which for pages is typically 'page'.

Parent Integer False

The unique identifier of the parent page, if this page is part of a hierarchy.

Content String False

The main body content of the WordPress page.

FeaturedMediaId Integer False

The unique identifier of the media item, such as an image, is set as the featured image for the page.

CommentStatus String False

Indicates whether visitors can post comments on the page.

PingStatus String False

Specifies whether the page can receive pingbacks or trackbacks from other sites.

MenuOrder Integer False

Defines the display order of the page relative to other pages with the same parent.

CData Cloud

Plugins

Create, update, delete, and query Plugins.

Table Specific Information

Select

The Cloud uses the WordPress API to process supported filters. The Cloud processes other filters client-side within the Cloud.

  • Plugin supports the '=' operator.
  • Status supports the '=' operator.
  • Context supports the '=' operator.
The following queries are processed server side.
SELECT * FROM Plugins WHERE Plugin = 'hello-dolly/hello'
SELECT * FROM Plugins WHERE Status = 'inactive'
SELECT * FROM Plugins WHERE Context = 'edit'

Insert

To insert into Plugins, you must specify the Slug column.

INSERT INTO Plugins (Slug, Status) VALUES ('hello-dolly', 'active')

Update

To update the Plugin, you must specify the Plugin column.

UPDATE Plugins SET Status = 'inactive' WHERE Plugin = 'hello-dolly/hello'

Delete

To delete a Plugin, you must specify the Plugin column.

DELETE FROM Plugins WHERE Plugin = 'hello-dolly/hello'

Columns

Name Type ReadOnly References Description
Plugin [KEY] String True

The main plugin file name, including its relative path within the WordPress plugins directory.

Name String True

The display name of the plugin as shown in the WordPress admin interface.

Author String True

The name of the developer or organization that created the plugin.

DescriptionRaw String True

The unformatted text version of the plugin description as stored in its metadata.

DescriptionRendered String True

The formatted version of the plugin description, as rendered for display in the WordPress admin interface.

NetworkOnly Boolean True

Indicates whether the plugin can only be activated for the entire WordPress network in multisite installations.

RequiresPhp String True

Specifies the minimum required version of PHP (Hypertext Preprocessor) for the plugin to run correctly.

RequiresWp String True

Specifies the minimum WordPress version required for the plugin to be compatible.

Status String False

The current activation state of the plugin, such as active, inactive, or must-use.

The allowed values are inactive, active.

TextDomain String True

The text domain used for internationalization and localization of the plugin's strings.

Version String True

The version number of the plugin as defined in its header information.

AuthorUri String True

The website URL of the plugin's author or development organization.

PluginUri String True

The website URL providing more information or documentation about the plugin.

Pseudo-Columns

Pseudo-column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the data returned by the operation.

Name Type Description
Slug String

The unique plugin directory slug from WordPress.org is required for insert operations, but it is not included in select responses.

Context String

Specifies the request context, which determines the fields and level of detail returned in the response.

The allowed values are view, edit, embed.

CData Cloud

Posts

Create, update, delete, and query Wordpress Posts.

Table Specific Information

SELECT

The Cloud uses the WordPress API to process some of the filters. The Cloud processes other filters client-side within the Cloud. For example, the following queries are processed server side.

SELECT * FROM Posts WHERE Id = 1
SELECT * FROM Posts WHERE Status = 'publish' AND Sticky = 'true'
SELECT * FROM Posts WHERE Id IN (1, 21)
SELECT * FROM Posts WHERE Author IN (1, 2)
SELECT * FROM Posts WHERE Date < '2018-02-02T02:02:23'
SELECT * FROM Posts WHERE Date > '2018-02-02T02:02:23'
SELECT * FROM Posts ORDER BY Title
Also, ordering by Id, Author, Date, Modified, is handled by the WordPress API.

Insert and Update

To insert a post you must specify one of the following columns: Title, Content, and Excerpt.

INSERT INTO Posts (Title, status) VALUES ('New post', 'publish')

To create a post with custom taxonomy, you must specify the TaxonomyTerms(name:terms) in the below format.

INSERT INTO Posts (Title, Content, Status, TaxonomyTerms) VALUES ('The story of Dr Strange', 'This is the content', 'publish', 'books:2,5')"

To update a post you must specify the following column: Id.

UPDATE Posts SET Content = 'Updated content' WHERE Id = '12345'

To update the post with custom taxonomy, you must specify the TaxonomyTerms(name:terms) in the below format.

UPDATE Posts SET taxonomyterms = 'books:2,5' WHERE Id = '10'"
Other fields that you can use on INSERT and UPDATE queries are the following: Date, DateGMT, Status, Excerpt, Title, Content, Author, MediaId, CommentStatus, PingStatus, Sticky, Categories, Tags and TaxonomyTerms.

Delete

To delete a post you must specify the following column: Id.

DELETE FROM Posts WHERE Id = '12345'

Columns

Name Type ReadOnly References Description
Id [KEY] Integer True

The unique identifier of the post in WordPress.

Title String False

The title of the WordPress post, displayed in listings, navigation, and page headers.

CommentStatus String False

Indicates whether comments are enabled for the post, allowing visitors to leave feedback.

Categories String False

The list of categories assigned to the post, provided as a comma-separated string.

Tags String False

The list of tags assigned to the post, provided as a comma-separated string for organizing content.

Author Integer False

The unique identifier of the user who authored or published the post.

Date Datetime False

The date and time when the post was published, recorded in the site's local timezone.

DateGMT Datetime False

The date and time when the post was published, recorded in Greenwich Mean Time (GMT).

Modified Datetime True

The date and time when the post was last updated, recorded in the site's local timezone.

ModifiedGMT Datetime True

The date and time when the post was last updated, recorded in GMT.

Status String False

Indicates the current publication state of the post, such as publish, future, draft, pending, or private.

The allowed values are publish, future, draft, pending, private.

Type String True

Specifies the type of post, such as post, page, or a registered custom post type.

Content String False

The main body content of the WordPress post, including formatted text, media, or HTML.

Excerpt String False

A short summary or preview of the post content, often displayed in feeds or post listings.

PingStatus String False

Specifies whether pingbacks and trackbacks are enabled for the post.

Format String False

Defines the visual format of the post, such as standard, aside, gallery, or link.

Sticky Boolean False

Indicates whether the post is marked as sticky, keeping it pinned to the top of the site's front page.

Link String True

The permalink URL for viewing the post on the WordPress site.

FeaturedMediaId Integer False

The unique identifier of the media item, such as an image, set as the featured image for the post.

Pseudo-Columns

Pseudo-column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the data returned by the operation.

Name Type Description
TaxonomyTerms String

Specifies the taxonomy terms, such as categories or tags, to be assigned to the post.

Context String

Defines the request scope, which determines which fields are included in the response, such as view or edit.

The allowed values are view, edit, embed.

CData Cloud

Tags

Create, update, delete, and query Tags to associate with your posts.

Table Specific Information

Select

The Cloud uses the WordPress API to process supported filters. The Cloud processes other filters client-side within the Cloud. For example, the following queries are processed server side.

SELECT * FROM Tags WHERE Id NOT IN ('8', '9')
SELECT * FROM Tags WHERE Id = 5
SELECT * FROM Tags ORDER BY Id
Also, ordering by Count, Description, and Name is handled by the WordPress API.

Insert

To insert a tag you must specify the following column: Name.

INSERT INTO Tags (Name, Description) VALUES ('MyTag', 'A tag')

Update

To update a tag you must specify the following column: Id.

UPDATE Tags SET Name = 'Updated name', Description = 'Updated description' WHERE Id = '12345'

Delete

To delete a tag you must specify the following column: Id.

DELETE FROM Tags WHERE Id = '12345'

Columns

Name Type ReadOnly References Description
Id [KEY] Integer True

The unique identifier of the tag in WordPress.

Count Integer True

The total number of published posts associated with this tag.

Description String False

The descriptive text or explanation for the tag, often displayed on tag archive pages.

Link String True

The permalink URL for viewing all posts associated with this tag on the WordPress site.

Name String False

The display name of the tag as shown in the WordPress admin area or on the site.

Taxonomy String True

Specifies the taxonomy type for the term, which for tags is typically 'post_tag'.

CData Cloud

Users

Create, update, delete, and list the Users of the website.

Table Specific Information

Select

The Cloud uses the WordPress API to process supported filters. The Cloud processes other filters client-side within the Cloud. To retrieve and filter the values for the Roles column, use Context='edit' in the WHERE clause. For example, the following queries are processed server side. Only users that have published posts will be returned.

SELECT * FROM Users WHERE Id IN ('1', '23')
SELECT * FROM Users WHERE Roles IN ('editor, administrator') AND Context='edit'
SELECT * FROM Users ORDER BY Email
Also, ordering by Id, Name, RegisteredDate, and Url is handled by the WordPress API.

Insert and Update

To insert a user you must specify the following columns: Username, Email, and Password.

INSERT INTO Users (Username, Email, Password) VALUES ('DemoUser', '[email protected]', 'aPassword')

Update

To update a user you must specify the following column: Id.

UPDATE Users SET Name = 'First Last' WHERE Id = '12345'
Other fields that you can use on INSERT and UPDATE queries are the following: Username, Name, FirstName, LastName, Email, Url, Description, Locale, Nickname, Roles.

Delete

To delete a user you must specify the following column: Id.

DELETE FROM Users WHERE Id = '12345'

Columns

Name Type ReadOnly References Description
Id [KEY] Integer True

The unique identifier of the user account in WordPress.

Username String False

The username used by the user to log in to WordPress.

Name String False

The display name of the user, shown publicly on posts and comments.

FirstName String False

The first name of the user as stored in their WordPress profile.

LastName String False

The last name of the user as stored in their WordPress profile.

Email String False

The email address associated with the user's account, used for notifications and password resets.

Roles String False

The roles assigned to the user, defining their permissions and capabilities. Use with the IN operator and context=edit to filter by role.

Description String False

A short biography or description provided in the user's profile.

Locale String False

Specifies the user's language and regional setting, based on WordPress locale codes.

Nickname String False

An alternate name the user chooses to display instead of their username.

RegisteredDate Datetime True

The date and time when the user registered on the WordPress site.

Link String True

The author archive URL associated with the user, listing their published posts.

Url String False

The website URL provided in the user's profile.

Administrator Boolean True

Indicates whether the user has the Administrator role with full site access.

EditPosts Boolean True

Indicates whether the user has permission to edit their own posts.

PublishPosts Boolean True

Indicates whether the user can publish new posts.

DeletePosts Boolean True

Indicates whether the user can delete their own posts.

EditPages Boolean True

Indicates whether the user can edit pages on the WordPress site.

PublishPages Boolean True

Indicates whether the user can publish new pages.

DeletePages Boolean True

Indicates whether the user can delete pages from the site.

EditUsers Boolean True

Indicates whether the user can edit other user accounts.

CreateUsers Boolean True

Indicates whether the user can create new user accounts.

PromoteUsers Boolean True

Indicates whether the user can promote users to higher roles.

DeleteUsers Boolean True

Indicates whether the user can delete other user accounts.

EditThemes Boolean True

Indicates whether the user can modify theme files or settings.

UpdateThemes Boolean True

Indicates whether the user can update installed themes.

InstallThemes Boolean True

Indicates whether the user can install new themes.

DeleteThemes Boolean True

Indicates whether the user can delete installed themes.

SwitchThemes Boolean True

Indicates whether the user can switch the active theme for the site.

ActivatePlugins Boolean True

Indicates whether the user can activate installed plugins.

UpdatePlugins Boolean True

Indicates whether the user can update existing plugins.

EditPlugins Boolean True

Indicates whether the user can edit plugin code or settings.

DeletePlugins Boolean True

Indicates whether the user can delete installed plugins.

EditFiles Boolean True

Indicates whether the user can edit files directly through the WordPress interface.

UploadFiles Boolean True

Indicates whether the user can upload media or other files to the site.

ManageOptions Boolean True

Indicates whether the user can manage general site options and settings.

ManageCategories Boolean True

Indicates whether the user can manage and organize post categories.

EditDashboard Boolean True

Indicates whether the user can customize or edit the WordPress dashboard.

Pseudo-Columns

Pseudo-column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the data returned by the operation.

Name Type Description
Password String

The user's password value, used only during account creation; not returned in responses.

Context String

Defines the request scope, which determines which fields are included in the response, such as view or edit.

The allowed values are view, edit, embed.

CData Cloud

Views

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

CData Cloud - WordPress Views

Name Description
Taxonomies List all the taxonomies.
TaxonomyTerms List all terms of the taxonomies.
Types List Types associated with the Posts.

CData Cloud

Taxonomies

List all the taxonomies.

Table Specific Information

SELECT

The Cloud uses the WordPress API to process some of the filters. The Cloud processes other filters client-side within the Cloud. For example, the following queries are processed server side.

SELECT * FROM Taxonomies WHERE Slug = 'books'

Columns

Name Type References Description
Hierarchical Boolean Indicates whether the taxonomy supports hierarchical relationships, allowing parent and child terms, such as categories.
Name String The display name of the taxonomy as registered in WordPress.
Slug [KEY] String A URL-friendly identifier for the taxonomy, typically used in permalinks and API requests.
RestBase String The base route used in the WordPress REST API for accessing terms within this taxonomy.
Description String A text description that explains the purpose or usage of the taxonomy.

Pseudo-Columns

Pseudo-column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the data returned by the operation.

Name Type Description
Context String Defines the request scope, which determines which fields are included in the response, such as view or edit.

The allowed values are view, edit, embed.

CData Cloud

TaxonomyTerms

List all terms of the taxonomies.

Table Specific Information

SELECT

The Cloud uses the WordPress API to process some of the filters. The Cloud processes other filters client-side within the Cloud. Note: Taxonomy is required to fetch TaxonomyTerms. Use the slug values from the taxonomies view to retrieve the taxonomy column value.

For example, the following queries are processed server side.

SELECT * FROM TaxonomyTerms WHERE Taxonomy = 'books';
SELECT * FROM WordPress.TaxonomyTerms WHERE taxonomy IN ('post_tag','Category');

Columns

Name Type References Description
id Integer The unique identifier of the taxonomy term within the specified taxonomy.
Count Integer The number of posts or items associated with this taxonomy term.
Link String The URL link associated with the taxonomy term, used for navigating to the term's archive or details page.
Name String The display name of the taxonomy term, shown in the WordPress admin and on the front-end site.
Slug String The URL-friendly identifier for the taxonomy term, used in permalinks and in API requests.
Taxonomy String The taxonomy to which this term belongs, such as category, post_tag, or a custom taxonomy.
Parent Integer The unique identifier of a parent term in a hierarchy is given, where a value of 0 indicates that there is no parent.
Description String A textual description of the taxonomy term, explaining its purpose or providing additional context.

CData Cloud

Types

List Types associated with the Posts.

Table Specific Information

Select

The Cloud uses the WordPress API to process supported filters. The Cloud processes other filters client-side within the Cloud. For example, the following queries are processed server side.

SELECT * FROM Types WHERE Slug = 'product'

Columns

Name Type References Description
Slug [KEY] String The unique slug that identifies the post type in WordPress, used in permalinks and API routes.
Name String The display name of the post type, shown in the WordPress admin interface.
Description String A short explanation describing the purpose or usage of the post type.
HasArchive String Indicates whether the post type supports an archive page that lists all its posts.
IsHierarchical Boolean Specifies whether the post type supports parent and child relationships, similar to pages.
IsTemplateLock Boolean Indicates whether the post type restricts or locks the editing template in the WordPress block editor.
Icon String The icon representing the post type in the WordPress admin menu.
RestBase String The base route used for the post type in the WordPress REST API.
RestNamespace String The namespace used for the post type within the WordPress REST API.
Taxonomies String A list of taxonomies associated with the post type, such as category or post_tag.

CData Cloud

Stored Procedures

Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT/INSERT/UPDATE/DELETE operations with WordPress.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from WordPress, along with an indication of whether the procedure succeeded or failed.

CData Cloud - WordPress Stored Procedures

Name Description
CreateMedia Uploads a new media file, such as an image or video, to the WordPress site's media library and attaches it to a specified post or page.
UpdateSettings Updates the settings of the website.

CData Cloud

CreateMedia

Uploads a new media file, such as an image or video, to the WordPress site's media library and attaches it to a specified post or page.

Stored Procedure Specific Information

Call this procedure to create media. Note: The Status column only accepts the following values: publish, future, draft, pending, and private. To create a media you must specify the following column: FileLocation. For example:

EXEC CreateMedia Title='MediaTitle', FileLocation='C:/myImages/image.png', Caption='This is an uploaded media.';

Input

Name Type Description
Title String The title assigned to the media item in WordPress.
Date Datetime The date and time to assign to the uploaded media item, based on the site's configured timezone.
DateGMT Datetime The date and time to assign to the uploaded media item, expressed in Greenwich Mean Time (GMT).
Status String Specifies the publication status of the uploaded media item, such as inherit, publish, or private.
AuthorId Integer Specifies the ID of the WordPress user who created or uploaded the media item.
CommentStatus String Specifies whether the uploaded media item can receive comments. Supported values include open and closed.
PingStatus String Specifies whether the media item accepts pings or trackbacks from external sites.
Caption String The caption text to display with the media item in WordPress.
Description String The description text for the media item in WordPress.
PostId Integer The unique identifier of the post or page that the uploaded media item is associated with or attached to in WordPress.
FileLocation String The file path or publicly accessible URL of the media file that uploaded to WordPress.

Result Set Columns

Name Type Description
Success String Indicates whether the media upload completed successfully.
Id String The unique identifier assigned to the media item after it is successfully uploaded to WordPress.

CData Cloud

UpdateSettings

Updates the settings of the website.

Stored Procedure Specific Information

EXECUTE

Call this procedure to update settings. For example:

EXECUTE UpdateSettings Title = 'New Title!'

Input

Name Type Description
Title String Specifies the title of the WordPress site, displayed in browser titles and across site pages.
Description String Defines the site's tagline or short description, often displayed below the title.
Url String Specifies the main URL of the WordPress site, used as the base address for all links.
Email String The email address of the administrator for notifications and confirmations. Changes must be verified via email before they take effect.
Timezone String Specifies the timezone setting for the site by selecting a city in the same region.
DateFormat String Defines the default format used for displaying dates across the site.
TimeFormat String Defines the default format used for displaying time values across the site.
Language String Specifies the site's language using a WordPress locale code, such as en_US.
UseSmilies Boolean Determines whether text-based emoticons, such as :-) or :-P, are automatically converted into graphic emojis.
DefaultCategory Integer Sets the default category assigned to posts when no category is selected.
DefaultPostFormat String Specifies the default post format for new posts, such as standard, aside, or gallery.
PostsPerPage Integer Defines the maximum number of posts displayed per blog page or archive page.
DefaultPingStatus String Specifies whether pingbacks and trackbacks are allowed for new posts.
DefaultCommentStatus String Specifies whether comments are enabled by default for new posts.

CData Cloud

WordPressOnline Data Model

The CData Cloud models WordPress data as an easy-to-use SQL database. There are three parts to the data model: tables, views, and stored procedures.

Tables

The Tables section, which details standard SQL tables, and the Views section, which lists read-only SQL tables, describe the schema exposed through the WordPress.com API. The available data depends on your account credentials and access level.

Commonly used tables include:

Table Description
Categories Create, update, list, and delete the Categories for the WordPressOnline website.
Comments Query the comments data.
Media Get a list of items in the media library.
NavigationMenus List, update, create, and delete NavigationMenus of the WordPressOnline website.
Posts Create, update, list, and delete the Posts for the WordPressOnline website.
PublicizeConnection List all publicizeconnections that the current user has set up and update and delete specified publicize connection.
Tags Create, update, list, and delete the Tags for the WordPressOnline website.
TaxonomyTerms Create, update, list, and delete the Taxonomy Terms for the WordPressOnline website.
Users List the Users of the WordPressOnline website.
CommentLikes Get the likes information for a comment.
CommentLikeStatus Get the like status for a comment of the WordPressOnline website.
Follows List a site's followers in reverse chronological order.
Insights Query the list of stats/metrics/insights that the current user has access to.
PostTypes List the PostTypes for the WordPressOnline website.
RecentComments Get a list of recent comments on a post.
SharingButtons List and update all the sharing buttons for a site.
SitePostViews Query the SitePostViews in Wordpress.
SitePublicizeConnection Query a list of publicize connections that are associated with the specified site.
SiteStats Query the SiteStats in Wordpress.
SiteStatsSummary Query the SiteStatsSummary in Wordpress.

Stored Procedures

Stored Procedures are actions that are invoked via SQL queries. They perform tasks beyond standard CRUD operations, including creating and uploading media and managing OAuth tokens.

CData Cloud

Tables

The Cloud models the data in WordPress as a list of tables in a relational database that can be queried using standard SQL statements.

CData Cloud - WordPress Tables

Name Description
Categories Returns information about WordPress categories, including their names, descriptions, and post counts.
Comments Returns comments from WordPress posts, including author details, content, and status information.
KeyRingConnection Returns information about external service connections and authentication tokens managed through the WordPress Keyring framework.
Media Get a list of items in the media library.
NavigationMenus List, Update, Create and Delete NavigationMenus of the WordPressOnline website.
Posts Create,Update,List and Delete the Posts for the WordPressOnline website.
PublicizeConnection list all publicizeconnections that the current user has set up and update and delete specified publicize connection.
SiteWidgets Query and update the active and inactive widgets for a site.
SiteWordAdsSettings Query and Update detailed WordAds settings information about a site.
SiteWordAdsTos Get and Update WordAds TOS information about a site.
Tags Create,Update,List and Delete the Tags for the WordPressOnline website.
TaxonomyTerms Create,Update,List and Delete the Taxonomy Terms for the WordPressOnline website.
Users List the Users of the WordPressOnline website.

CData Cloud

Categories

Returns information about WordPress categories, including their names, descriptions, and post counts.

Table Specific Information

SELECT

The Cloud uses the WordPress API to process some of the filters.

  • Slug supports the '=' comparison.

The Cloud processes other filters client-side within the Cloud.

For example, the following queries are processed server side.

SELECT * FROM Categories WHERE Slug = 'test'

Insert

To insert a category the following column is required: Name.

INSERT INTO Categories (Description, Name, Parent) VALUES ('This is an example Category', 'myCategory', '138')

Update

To update a category you must specify the following column: Id.

UPDATE Categories SET Name = 'updatedName', Description = 'Updated description.', Parent = 137 WHERE Id = '139'

Delete

To delete a category you must specify the following column: Id.

DELETE FROM Categories WHERE Id = '139'

Columns

Name Type ReadOnly References Description
Slug String True

The slug assigned to the category in WordPress. This is a URL-friendly string derived from the category name and used in site URLs and API endpoints.

ID [KEY] String True

A unique integer that identifies the category in WordPress and links posts, tags, and other taxonomy data associated with that category.

Name String False

The category name defined in WordPress, representing the label shown on the site and used to organize related posts.

Description String False

The descriptive text defined in WordPress for the category, typically used to explain its purpose or the type of posts it contains.

FeedURL String True

The URL of the RSS feed for posts in this category.

MetaAggregate String False

Contains aggregated metadata for the category, combining key details returned by WordPress.

Parent Integer True

The identifier of the parent category that this category belongs to. A value of 0 indicates that the category has no parent.

PostCount Integer True

Indicates how many posts are associated with this category in WordPress.

CData Cloud

Comments

Returns comments from WordPress posts, including author details, content, and status information.

Table Specific Information

SELECT

The Cloud uses the WordPress API to process some of the filters. Note: Status with unapproved or trash as value will not populate using simple SELECT, respective CommentId will be required to populate the values for those Status.

  • Id supports the '=' comparison.
  • Status supports the '=' comparison.
  • Type supports the '=' comparison.

The Cloud processes other filters client-side within the Cloud.

For example, the following queries are processed server side.

SELECT * FROM Comments
SELECT * FROM Comments WHERE ID=21
SELECT * FROM Comments WHERE status='approved'

Insert

To insert a comment the following column is required: PostID.

INSERT INTO Comments (Content, Status, PostID) VALUES ('This is an example', 'approved', 21)

Update

To update a comment you must specify the following column: Id.

UPDATE Comments SET  Content= 'Test Comment', Status = 'approved', AuthorEmail = '[email protected]' WHERE ID = 21

Delete

To delete a comment you must specify the following column: ID.

DELETE FROM Comments WHERE ID = 21

Columns

Name Type ReadOnly References Description
ID [KEY] Int True

The unique identifier for the comment object in WordPress

Content String False

The text content of the comment submitted by the author.

Status String False

The approval status of the comment, such as approved, pending, or spam.

The allowed values are approved, spam, unapproved, trash.

Type String True

Specifies the type of comment, such as a standard comment, trackback, or pingback.

URL String True

The website URL associated with the comment or its author.

Date Datetime False

The date and time when the comment was posted in WordPress.

ParentID Int True

The unique identifier of the parent comment, set to 0 for top-level comments.

ParentLink String True

The URL linking directly to the parent comment in WordPress.

ParentType String True

he type of object that the parent comment is associated with, such as another comment or a post.

PostID Int False

The list of post identifiers associated with the comment in WordPress.

PostLink String True

The URL linking to the post or page where the comment was made in WordPress.

PostTitle String True

The title of the post or page associated with the comment.

PostType String True

The type of post associated with the comment, such as a post, page, or custom post type.

ShortURL String True

The shortened URL that links directly to the comment in WordPress.

AuthorAvatarURL String True

Specifies the URL of the avatar image representing the comment's author in WordPress.

AuthorEmail String False

The email address of the user who authored the comment.

AuthorFirstName String True

Specifies the first name of the WordPress user who submitted the comment.

AuthorID Int True

Specifies the unique identifier assigned to the WordPress user who created the comment.

AuthorIpAddress String True

Records the IP address used by the author when posting the comment to WordPress.

AuthorLastName String True

Specifies the last name of the WordPress user who submitted the commen.

AuthorLogin String True

Specifies the WordPress username used by the author who submitted the comment.

AuthorName String False

The display name of the user who authored the comment in WordPress.

AuthorNiceName String True

The URL-friendly version of the author's display name, used in WordPress links or slugs.

AuthorProfileURL String True

Provides the link to the comment author's public WordPress profile or user page.

AuthorSiteVisible Bool True

Indicates whether the author's site or profile is publicly visible in WordPress.

AuthorURL String False

Specifies the website URL submitted by the author when posting the comment.

RawContent String True

Contains the raw text of the comment before any HTML rendering, formatting, or sanitization is applied.

CanModerate Bool True

Specifies whether the logged-in user can perform moderation actions on the comment, such as approve, edit, or delete.

ILike Bool True

Indicates whether the current user has liked the comment.

IReplied Bool True

Indicates whether the current user has replied to the comment.

LikeCount Int True

Displays the total count of likes or positive reactions associated with the comment in WordPress.

MetaAggregate String True

Aggregated metadata for the comment returned by the WordPress API.

CData Cloud

KeyRingConnection

Returns information about external service connections and authentication tokens managed through the WordPress Keyring framework.

Columns

Name Type ReadOnly References Description
ID [KEY] Int False

The unique identifier of the Keyring connection record.

AdditionalExternalUsers String False

The list of additional external users linked to the Keyring connection.

IsExpires Bool False

Indicates whether the Keyring connection or its authentication token has an expiration date.

ExternalDisplay String False

The display name of the connected external account.

ExternalId String False

The unique identifier of the connected external account or service.

ExternalName String False

The name of the external account connected through Keyring.

ExternalProfilePicture String False

The URL of the profile picture for the connected external account.

Issued Datetime False

The date and time when the Keyring connection or token was issued.

Label String False

A custom label used to identify the Keyring connection in WordPress.

RefreshURL String False

The URL used to refresh or renew the authentication token for the Keyring connection.

Service String False

The service associated with the Keyring connection.

Sites String False

The list of sites associated with the Keyring connection.

Status String False

The current status of the Keyring connection, such as active or expired.

Type String False

The type of authentication or connection used for the Keyring integration..

UserId Int False

The unique identifier of the WordPress user associated with the Keyring connection.

CData Cloud

Media

Get a list of items in the media library.

Table Specific Information

SELECT

The Cloud uses the WordPress API to process some of the filters.

  • Id supports the '=' comparison.
  • PostId supports the '=' comparison.
  • Date supports the '=' comparison.
  • MimeType supports the '=' comparison.

The Cloud processes other filters client-side within the Cloud.

For example, the following queries are processed server side.

SELECT * FROM Media
SELECT * FROM Media WHERE Id=21

Update

To update a media you must specify the following column: Id.

UPDATE Media SET  Caption= 'Test Caption', Description = 'Sample media' WHERE ID = 183

Delete

To delete a media you must specify the following column: ID.

DELETE FROM Media WHERE ID = 21

Columns

Name Type ReadOnly References Description
ID [KEY] Integer True

The unique identifier assigned to the media item within the WordPress site.

Title String False

The title of the media file as displayed in the Media Library or attached post.

PostID Integer True

The unique identifier of the post or page the media item is attached to. Returns 0 if the media is unattached.

Allowdownload String False

Indicates whether the video file is available for download by viewers.

Alt String False

The alternative text for the media item, used for accessibility and Search Engine Optimization (SEO) purposes.

AuthorID Integer True

The unique identifier of the user who uploaded the media item.

Caption String False

A short caption or description displayed with the media item.

Date Datetime True

The upload date and time of the media item, recorded in ISO 8601 format.

Description String False

A longer description or additional information about the media item.

DisplayEmbed String False

Indicates whether the video can be embedded on external sites.

Extension String True

The file extension of the media item, such as jpg, mp4, or pdf.

File String True

The name of the uploaded media file as stored in WordPress.

GUID String True

The globally unique identifier for the media item, often corresponding to the original file URL.

Icon String True

A representative icon indicating the file type of the media item.

Length Integer True

The duration of the video file, measured in seconds.

MetaAggregate String True

Returns aggregated metadata about the media item, including file details and custom fields.

MimeType String True

Specifies the file's Multipurpose Internet Mail Extensions (MIME) type, such as image/jpeg or video/mp4.

Rating String False

Indicates the content rating of the video, such as suitable for all audiences or restricted.

Size String True

The total file size, displayed in a human-readable format such as KB or MB.

URL String True

The direct URL for accessing or downloading the uploaded media file.

VideopressGuid String True

The unique identifier assigned to the video by VideoPress.

IsVideopressProcessingDone Boolean True

Indicates whether VideoPress has finished processing and encoding the uploaded video.

Width Integer True

The width of the video or image in pixels.

Height Integer True

The height of the video or image in pixels.

ThumbnailsAggregate String True

Contains metadata about automatically generated image thumbnails created from the original upload.

ExifAggregate String True

Provides EXIF data and camera details captured when the image was taken, if available

CData Cloud

NavigationMenus

List, Update, Create and Delete NavigationMenus of the WordPressOnline website.

Table Specific Information

SELECT

The Cloud uses the WordPress API to process some of the filters.

  • Id supports the '=' comparison.

The Cloud processes other filters client-side within the Cloud.

For Example:

SELECT * FROM NavigationMenus where id='780374349';

Insert

To insert new navigation menu, the following column is required: Name.

INSERT INTO NavigationMenus(Name) VALUES('testing');

Update

To update a navigation menu, you must specify the following column: Id.

UPDATE NavigationMenus SET name='updated testing' where id='780374351';

Delete

To delete a navigation menu, you must specify the following column: Id.

DELETE FROM NavigationMenus where id='780374351';

Columns

Name Type ReadOnly References Description
Id [KEY] Int True

The unique identifier of the navigation menu within the WordPress site.

Name String False

The display name of the navigation menu as it appears in the WordPress admin or site theme.

Description String False

A short summary or purpose of the navigation menu, typically defined by the site administrator.

Items String False

Includes details about each menu item, such as its ID, type, content reference, and any applicable nested child items.

Locations String False

Specifies the theme locations where the menu can be assigned, such as header, footer, or sidebar.

CData Cloud

Posts

Create,Update,List and Delete the Posts for the WordPressOnline website.

Table Specific Information

SELECT

The Cloud uses the WordPress API to process some of the filters.

  • Id supports the '=' comparison.
  • AuthorId supports the '=' comparison.
  • Date supports the '<', '>' comparisons.
  • Modified supports the '<', '>' comparisons.
  • Slug supports the '=' comparison.
  • Status supports the '=' comparison.
  • Sticky supports the '=' comparison.
  • Type supports the '=' comparison.

The Cloud processes other filters client-side within the Cloud.

For example, the following queries are processed server side.

SELECT * FROM Posts
SELECT * FROM Posts WHERE ID=21

Insert

To insert a post :

INSERT INTO Posts (Title, Content, Excerpt) VALUES ('Post title', 'Post content', 'Post Excerpt')

Update

To update a post you must specify the following column: ID.

UPDATE Posts SET  Title= 'Modified post title', Content = 'Modified content', Excerpt = 'Modified excerpt' WHERE ID = 21

Delete

To delete a post you must specify the following column: ID.

DELETE FROM Posts WHERE ID = 21

Columns

Name Type ReadOnly References Description
ID [KEY] Int False

The unique identifier of the post.

SiteID Int False

The unique identifier of the WordPress site that the post belongs to.

AuthorAvatarURL String False

The URL of the author's profile avatar image.

IsAuthorEmailAvailable Boolean False

Indicates whether the author's email address is available.

AuthorFirstName String False

The first name of the post's author.

AuthorID Int False

The unique identifier of the author who created the post.

AuthorLastName String False

The last name of the post's author.

AuthorLogin String False

The author's WordPress username used to log in.

AuthorName String False

The display name of the post's author.

AuthorNiceName String False

The URL-friendly version of the author's username.

AuthorProfileURL String False

The URL of the author's public WordPress profile page.

AuthorSiteID Int False

The site ID associated with the author.

AuthorURL String False

The personal website URL provided by the author, if any.

Date Datetime False

The date and time when the post was created in the site's local timezone.

Modified Datetime False

The date and time when the post was last updated.

Title String False

The title of the post as displayed on the site.

ItemURL String False

The full permalink URL of the post.

ShortURL String False

The wp.me shortlink that provides a shortened version of the post URL.

Content String False

The full HTML content of the post.

Excerpt String False

A short excerpt or summary of the post content.

Slug String False

The URL-friendly slug used to identify the post.

Guid String False

The globally unique identifier (GUID) for the post, often representing its original permalink.

Status String False

The publication status of the post, such as publish, draft, pending, private, future, trash, or auto-draft.

The allowed values are publish, private, draft, pending, future, trash, any.

IsSticky Boolean False

Indicates whether the post is marked as sticky and displayed at the top of the blog.

Password String False

The plaintext password used to protect the post, or an empty string if the post is not password-protected.

HasParent Boolean False

Indicates whether the post has a parent post (for example, a child page).

Type String False

The post type for this entry, such as post, page, or a custom post type allowed by the REST API.

DiscussionCommentCount Int False

The total number of comments associated with the post.

DiscussionCommentStatus String False

Indicates the current comment status for the post, such as open or closed.

HasDiscussionCommentsOpen Boolean False

Indicates whether new comments can be added to the post.

DiscussionPingStatus String False

Shows whether pingbacks and trackbacks are enabled for the post.

HasDiscussionPingsOpen Boolean False

Indicates whether the post accepts pingbacks.

HasLikesEnabled Boolean False

Indicates whether likes are enabled for the post.

HasSharingEnabled Boolean False

Indicates whether sharing buttons are enabled for the post.

LikeCount Int False

The total number of likes that the post has received.

ILike Boolean False

Indicates whether the authenticated user has liked the post.

IsFollowing Boolean False

Indicates whether the authenticated user is following the site where the post appears.

IsReblogged Boolean False

Indicates whether the authenticated user has reblogged this post.

GlobalID String False

A globally unique identifier representing the post across the entire WordPress.com network.

FeaturedImage String False

The URL of the post's featured image, if one is set.

PostThumbnail String False

The attachment object representing the featured image, if available.

Format String False

The display format of the post, such as standard, aside, gallery, image, quote, status, video, or audio.

HasGeo Boolean False

Indicates whether the post includes geolocation data.

MenuOrder Int False

Defines the order of pages or hierarchical posts in navigation menus.

PageTemplate String False

The page template assigned to this post or page.

PublicizeURLsAggreagtes String False

A list of URLs where the post was automatically shared via Publicize connections, such as Facebook or Twitter.

CategoriesAggregates String False

A set of categories, organized by name, that are assigned to the post.

TermsCategoryAggregates String False

A collection of taxonomy terms grouped by category name and keyed by term name.

TermsPostTagAggregates String False

A collection of taxonomy terms grouped by post tags and keyed by tag name.

TermsPostFormatAggregates String False

A collection of taxonomy terms grouped by post format and keyed by format name.

TermsMentionsAggregates String False

A collection of taxonomy terms related to user or site mentions in the post.

TagsAggregates String False

A set of tags, organized by tag name, that are applied to the post.

Attachments String False

A collection of post attachments organized by attachment ID. It returns up to 20 of the most recent attachments.

AttachmentCount Int False

The total number of attachments associated with the post.

MetadataAggregates String False

An array of key-value pairs representing the post's custom metadata fields.

HasCapabilitiesDeletePost Boolean False

Indicates whether the authenticated user has permission to delete the post.

HasCapabilitiesEditPost Boolean False

Indicates whether the authenticated user has permission to edit the post.

HasCapabilitiesPublishPost Boolean False

Indicates whether the authenticated user has permission to publish the post.

CData Cloud

PublicizeConnection

list all publicizeconnections that the current user has set up and update and delete specified publicize connection.

Table Specific Information

SELECT

The Cloud uses the WordPress API to process some of the filters.

  • Name supports the '=' comparison.

The Cloud processes other filters client-side within the Cloud.

For example, the following queries are processed server side.

SELECT * FROM PublicizeConnection

Update

To update a publicized connection you must specify the following column: ID.

UPDATE PublicizeConnection SET  ExternalName= 'New external name', Status='Active' WHERE ID = 21

Delete

To delete a publicized connection you must specify the following column: ID.

DELETE FROM PublicizeConnection WHERE ID = 21

Columns

Name Type ReadOnly References Description
ID [KEY] Int False

The unique identifier of the Publicize connection record.

SiteID Int False

The unique identifier of the WordPress site associated with this Publicize connection.

UserID Int False

The unique identifier of the WordPress.com user who owns or manages this connection.

IsExpires Bool False

Indicates whether the Publicize connection is temporary and automatically expires after a set period.

ExternalDisplay String False

The display name shown for the connected external account, as retrieved from the linked service.

ExternalFollowerCount Int False

The number of followers or subscribers retrieved from the connected external service.

ExternalID String False

The unique identifier assigned to the connected account on the external platform.

ExternalName String False

The account name or handle used on the connected external service.

ExternalProfilePicture String False

The URL of the profile image associated with the connected external account.

ExternalProfileURL String False

The URL of the profile page for the connected external account.

Issued Datetime False

The date and time when the Publicize connection was created or authorized.

KeyringConnectionID Int False

The unique identifier of the related Keyring connection record used for authentication.

KeyringConnectionUserID Int False

The unique identifier of the user associated with the linked Keyring connection.

Label String False

A custom label assigned by the user to help identify this Publicize connection.

RefreshURL String False

The URL endpoint used to refresh or renew the connection if it becomes invalid or expires.

Service String False

The name of the external service connected through Publicize, such as Twitter or Facebook.

HasSharedAccess Bool False

Indicates whether the connection can be shared across multiple users or is restricted to a single user.

Status String False

The current operational status of the connection, such as active or inactive.

CData Cloud

SiteWidgets

Query and update the active and inactive widgets for a site.

Table Specific Information

SELECT

The Cloud uses the WordPress API to process some of the filters.

  • Id supports the '=' comparison.

The Cloud processes other filters client-side within the Cloud.

For example, the following queries are processed server side.

SELECT * FROM SiteWidgets WHERE Id = 'block-1'

Update

To update a SiteWidgets you must specify the following column: Id.

UPDATE SiteWidgets SET Position = 5 WHERE Id = 'block-1'

Delete

To delete a SiteWidgets you must specify the following column: Id.

DELETE FROM SiteWidgets WHERE Id = '139'

Columns

Name Type ReadOnly References Description
Id [KEY] String True

The unique identifier assigned to the widget instance.

IdBase String True

The base identifier shared by all instances of this widget type.

Position Integer False

The widget's display order within its assigned sidebar.

Sidebar String False

The identifier of the sidebar where the widget is currently active.

SettingsAggregate String False

A collection of configuration settings that define the widget's behavior and appearance.

CData Cloud

SiteWordAdsSettings

Query and Update detailed WordAds settings information about a site.

Table Specific Information

SELECT

The Cloud processes all the filters client-side within the Cloud.

SELECT * FROM SiteWordAdSettings

Update

To update a site word ad settings you must specify the following Site ID column: ID, PayPalAddress. Incase the Terms of Service have not been signed, it will be required for Update. The API will always return a single record for the site, depending on the URL specified in the connection string.

UPDATE SiteWordAdSettings SET  PayPalAddress= '[email protected]', TermsOfService='signed' WHERE ID = 241575003

Columns

Name Type ReadOnly References Description
ID [KEY] Integer True

The unique identifier of the site associated with the WordAds settings.

Name String True

The display name or title of the WordPress site.

ItemURL String True

The full URL of the site whose WordAds settings are being managed.

IsSettingsOptimizedAds Boolean True

Indicates whether ad placement is optimized automatically by WordAds for better performance.

IsSettingsDisplayOptionsDisplayArchive Boolean False

Determines whether ads are displayed on archive pages such as category or tag listings.

IsSettingsDisplayOptionsDisplayFrontPage Boolean True

Determines whether ads appear on the site's front page or homepage.

IsSettingsDisplayOptionsDisplayPage Boolean True

Determines whether ads are displayed on static pages.

IsSettingsDisplayOptionsDisplayPost Boolean True

Determines whether ads are shown on individual post pages.

IsSettingsDisplayOptionsEnableHeaderAd Boolean True

Specifies whether a header ad is enabled at the top of the site.

IsSettingsDisplayOptionsInlineEnabled Boolean True

Specifies whether inline ads (within content) are enabled.

IsSettingsDisplayOptionsSidebar Boolean True

Specifies whether sidebar ads are enabled.

IsSettingsDisplayOptionsSecondBelowpost Boolean True

Specifies whether an additional ad unit appears below post content.

PayPalAddress String False

The PayPal email address associated with WordAds payouts.

TermsOfService String False

Indicates whether the WordAds Terms of Service have been accepted. Required for enabling or updating ad settings if not yet signed.

ShowToLoggedIn String False

Specifies whether ads should be shown to logged-in users.

IsCCPAEnabled Boolean False

Enables or disables targeted advertising for visitors in California, in compliance with the California Consumer Privacy Act (CCPA).

CCPAPrivacyPolicyURL String False

The URL displayed at the bottom of the CCPA notice pop-up, linking to the site's privacy policy. A pop-up window opens in a new browser tab, while a pop-up dialog box appears as an overlay on the same page.

Pseudo-Columns

Pseudo-column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the data returned by the operation.

Name Type Description
DisplayOptionsAggregate String

A collection of ad display settings that define where ads appear, including enable_header_ad, second_belowpost, sidebar, and display options for front_page, post, page, and archive.

CData Cloud

SiteWordAdsTos

Get and Update WordAds TOS information about a site.

Table Specific Information

SELECT

The Cloud processes all the filters client-side within the Cloud.

SELECT * FROM SiteWordAdsTos

Update

To update a site word ad terms of service you must specify the following Site ID column: ID and TermsOfService

UPDATE SiteWordAdsTos SET TermsOfService='true' WHERE ID = 241575003

Columns

Name Type ReadOnly References Description
ID [KEY] Int True

The unique identifier of the site associated with the WordAds Terms of Service.

name String True

The display name or title of the WordPress site.

ItemURL String True

The full URL of the site linked to the WordAds Terms of Service agreement.

TOS String False

The WordAds Terms of Service text or agreement status for the site.

SettingsAggregate String False

A collection of WordAds Terms of Service settings and related compliance details, viewable only by users with post-editing permissions on the site.

CData Cloud

Tags

Create,Update,List and Delete the Tags for the WordPressOnline website.

Table Specific Information

SELECT

The Cloud uses the WordPress API to process some of the filters.

  • Slug supports the '=' comparison.

The Cloud processes other filters client-side within the Cloud.

For example, the following queries are processed server side.

SELECT * FROM Tags
SELECT * FROM Tags WHERE Slug='tagTest'

Insert

To insert a tag, following columns are required : Name

INSERT INTO Tags (Slug, Name, Description) VALUES ('tagtest', 'Tag name', 'Tag Description')

Update

To update a tag you must specify the following column: Slug.

UPDATE Tags SET  Name= 'Modified tag name', Description = 'Modified tag description' WHERE Slug='tagTest'

Delete

To delete a tag you must specify the following column: Slug.

DELETE FROM Tags WHERE Slug='tagTest'

Columns

Name Type ReadOnly References Description
Slug [KEY] String True

The URL-friendly identifier (slug) for the tag.

ID Int True

The unique numeric identifier assigned to the tag.

Name String False

The display name of the tag as shown in WordPress.

Description String False

A brief explanation or summary of what the tag represents.

FeedUrl String False

The RSS feed URL associated with this tag.

PostCount Int False

The total number of posts currently assigned to this tag.

CData Cloud

TaxonomyTerms

Create,Update,List and Delete the Taxonomy Terms for the WordPressOnline website.

Table Specific Information

SELECT

The Cloud uses the WordPress API to process some of the filters.

  • Taxonomy supports the '=' comparison.
  • Slug supports the '=' comparison.

The Cloud processes other filters client-side within the Cloud. For example, the following queries are processed server side:

SELECT * FROM TaxonomyTerms WHERE Taxonomy='post_tag'
SELECT * FROM TaxonomyTerms WHERE Slug='tagTest'
SELECT * FROM TaxonomyTerms WHERE Taxonomy='post_tag';
SELECT * FROM TaxonomyTerms WHERE Taxonomy='post_tag' and Slug='tagTest';

INSERT

To insert a taxonomy term, the following column is required: Taxonomy.

INSERT INTO TaxonomyTerms (Slug, Name, Taxonomy) VALUES ('tagtest', 'Taxonomy term name', 'post_tag')

UPDATE

To update a taxonomy term you must specify the following columns: Taxonomy and Slug.

UPDATE TaxonomyTerms SET  Name= 'Modified taxonomy term name', Description = 'Modified taxonomy term description' WHERE Taxonomy='post_tag' AND Slug='tagTest'

DELETE

To delete a taxonomy term you must specify the following columns: Taxonomy and Slug.

DELETE FROM TaxonomyTerms WHERE Taxonomy='post_tag' AND Slug='tagTest'

Columns

Name Type ReadOnly References Description
Slug [KEY] String True

The URL-friendly identifier (slug) for the taxonomy term.

Taxonomy String False

TaxonomyPostType.Name

The taxonomy this term belongs to, such as category, post_tag, or a custom taxonomy.

Description String False

A brief explanation or summary describing the purpose or meaning of the term.

FeedUrl String False

The RSS feed URL associated with this taxonomy term.

ID Int True

The unique numeric identifier assigned to the taxonomy term.

Name String False

The display name of the taxonomy term as it appears in WordPress.

Parent Int False

The ID of the parent term if this term is part of a hierarchical taxonomy.

PostCount Int False

The total number of posts currently assigned to this taxonomy term.

CData Cloud

Users

List the Users of the WordPressOnline website.

Table Specific Information

Select

The Cloud uses the WordPress API to process supported filters.

  • Id supports the '=' comparison.
  • SiteId supports the '=' comparison.

The Cloud processes other filters client-side within the Cloud.

For example, the following queries are processed server side.

SELECT * FROM Users WHERE Id = 1
SELECT * FROM Users WHERE SiteId = 1255
Also, ordering by Id, and SiteId is handled by the WordPress API.

Update

To update a user you must specify the following column: Id.

UPDATE Users SET name = 'First Last' WHERE Id = '12345'

Delete

To delete a user you must specify the following column: Id.

DELETE FROM Users WHERE Id = '12345'

Columns

Name Type ReadOnly References Description
Id [KEY] Integer True

The unique identifier of the user.

SiteID Integer True

The unique identifier of the WordPress site the user belongs to.

FirstName String False

The user's first name as displayed in their WordPress profile.

LastName String False

The user's last name as displayed in their WordPress profile.

Email String False

The email address associated with the user's WordPress account.

AvatarURL String True

The URL of the user's avatar image.

Name String False

The display name of the user, typically shown on posts and comments.

NiceName String False

A sanitized, URL-friendly version of the user's display name.

ProfileURL String True

The full URL to the user's public WordPress profile page.

Roles String False

A list of roles assigned to the user, such as administrator, editor, author, or subscriber.

IPAddress String True

The IP address associated with the user's activity.

IsSuperAdmin Boolean True

Indicates whether the user has network-level administrative privileges (Super Admin) in a multisite environment.

Login String False

The username used by the user to log in to WordPress.

IsSiteVisible Boolean True

Indicates whether the user's site is visible to the public.

ItemURL String False

The full URL of the user's primary WordPress site.

CData Cloud

Views

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

CData Cloud - WordPress Views

Name Description
AuditHistoryforComments Returns a history of changes and status updates for comments in WordPress.
BlogRecommendations Returns a list of recommended WordPress blogs based on user interests or activity.
ClickEmails Returns data about links clicked in WordPress emails, including the email ID, URL, and time of each click.
CommentCounts Returns the total number of comments for WordPress posts, including counts by status such as approved, pending, and spam.
CommentLikes Returns information about likes on WordPress comments, including the number of likes each comment has received.
CommentLikeStatus Returns the like status of WordPress comments for the current user, including whether each comment has been liked.
DropDownPages Returns a list of WordPress pages, including their IDs and titles, for use in dropdown selections.
EmailSettings Returns the email configuration settings for the WordPress site, including sender details and notification preferences.
Feed Returns metadata and subscription information for a specific feed in the WordPress Reader.
Follows Returns a list of WordPress blogs or sites followed by the current user, including their Ids, names, and URLs.
Insights Returns analytical data and performance insights for the WordPress site, including views, visitors, likes, and comments.
MatchingFeeds Get the MatchingFeeds for a blog.
OpenEmails Query the OpenEmails in Wordpress.
PostReblogStatus Get reblog status for a post.
PostsTags List the UserLikedPosts for the WordPressOnline website.
PostTypes List the PostTypes for the WordPressOnline website.
ReaderMenuDefault Default menu items from the WordPress Reader Menu.
ReaderMenuRecommended Recommended topics from the WordPress Reader Menu.
ReaderMenuSubscribed Subscribed topics from the WordPress Reader Menu.
RecentComments Get a list of recent comments on a post.
SharingButtons list and update all the sharing buttons for a site.
SiteCountryViews Query the SiteCountryViews in Wordpress.
SiteEmailSummary Query the SiteEmailsSummary in Wordpress.
SiteFileDownloads Query the SiteFileDownloads in Wordpress.
SiteFollowers Query the SiteFollowers in Wordpress.
SiteOutboundClicks Query the SiteOutboundClicks in Wordpress.
SitePosts List the UserSitesPosts for the WordPressOnline website.
SitePostViews Query the SitePostViews in Wordpress.
SitePublicizeConnection Query a list of publicize connections that are associated with the specified site.
SitePublicizeFollowerComment List the SitePublicizeFollowerComment for the WordPressOnline website.
SitePublicizeFollowerCounts List the SitePublicizeFollowerCounts for the WordPressOnline website.
Sites Query information about a site.
SiteSearchTerms Query the SiteSearchTerms in Wordpress.
SiteShortCodesRender Get a rendered shortcode for a site
SitesPageTemplates Get a list of page templates supported by a site.
SiteStats Query the SiteStats in Wordpress.
SiteStatsReferrers Query the SiteStatsReferrers in Worpress.
SiteStatsSummary Query the SiteStatsSummary in Wordpress.
SiteStatsTags Get the SiteStatsTags for a blog.
SiteStatsVideo Query the SiteStatsVideo in Wordpress.
SiteTopAuthors Query the SiteTopAuthors in Wordpress.
SiteTopComments Query the SiteTopComments in Wordpress.
SiteTopPostsStats Query the SiteTopPostsStats in Wordpress.
SiteTotalViewsforPost Query the SiteTotalViewsforPost in Wordpress.
SiteVideoPlays Query the SiteVideoPlays in Wordpress.
SiteWordAdsEarnings List the SiteWordAdsEarnings for the WordPressOnline website.
SiteWordAdsStats List the SiteWordAdsStats for the WordPressOnline website.
StatHighlights Query the StatHighlights for a site in Wordpress.
SubscriberPosts List the SubscriberPosts for the WordPressOnline website.
SubscriptionCount Get the SubscriptionCount for a blog.
TaxonomyPostType Get a list of taxonomies associated with a post type.
TopTags Get a filtered list of top tags, grouped by letter.
TrendingTags Get a list of trending tags.
UserBillingHistory Query the Billing History in Wordpress.
UserFollowedPosts List the UserFollowedPosts for the WordPressOnline website.
UserFollowingFeeds Query the info about the user following feeds.
UserLikedPosts List the UserLikedPosts for the WordPressOnline website.
UserLikes Query the info about the posts liked by the user.
UserPreferences Update and List the UserPreferences for the WordPressOnline website.
UserSitesPosts List the UserSitesPosts for the WordPressOnline website.
UserSubscribedTags Get a list of tags subscribed to by the user
VideoPoster Get the poster for a specified VideoPress video.
VideopressChapter Get the chapters for a specified VideoPress video of the WordPressOnline website.
Videos Get the metadata for a specified VideoPress video.

CData Cloud

AuditHistoryforComments

Returns a history of changes and status updates for comments in WordPress.

Table Specific Information

SELECT

The Cloud uses the WordPress API to process some of the filters. Note: Events with status-trash or status-unapproved will not populate using simple SELECT, respective CommentId will be required to populate the values for those Events.

  • CommentId supports the '=' comparison.

The Cloud processes other filters client-side within the Cloud.

For example, the following queries are processed server side.

SELECT * FROM AuditHistoryforComments WHERE CommentId = 10

Columns

Name Type References Description
CommentId Int

Comments.Id

Specifies the identifier of the comment whose changes are recorded in the audit history.
Event String The type of action recorded for the comment, such as create, update, or delete.

The allowed values are check-ham, status-approved, status-trash, status-unapproved.

Time Timestamp The timestamp when the event related to the comment occurred.
User String The user who performed the action recorded in the audit log.

CData Cloud

BlogRecommendations

Returns a list of recommended WordPress blogs based on user interests or activity.

Table Specific Information

SELECT

The Cloud processes all the filters client-side within the Cloud.

SELECT * FROM BlogRecommendations

Columns

Name Type References Description
BlogId [KEY] Int The unique identifier for the recommended blog returned by WordPress.
BlogDomain String The domain associated with the recommended WordPress blog, typically representing the blog's public web address (for example, example.wordpress.com).
EmailFollowUrl String The URL used to follow the recommended blog via email.
FeedId String The unique identifier for the feed associated with the recommended blog.
FollowRecoId String The unique identifier for the blog recommendation record returned by WordPress.
FollowSource String The source that generated the blog recommendation, such as user activity or followed topics.
Image String The URL of the image representing the recommended blog.
MetaAggregate String Aggregated metadata for the recommended blog returned by WordPress.
Nonce String A security token used by WordPress to validate the blog recommendation request.
Reason String The reason this blog was recommended, such as shared topics or related content.
Score Double The relevance score assigned to the recommended blog based on WordPress's recommendation algorithm.
Title String Specifies the title or display name of the recommended blog as returned by WordPress.
TitleShort String The short version of the blog's title returned by WordPress, typically used in compact views or recommendation summaries.
ItemURL String Specifies the full URL of the recommended blog's homepage as returned by WordPress.

Pseudo-Columns

Pseudo-column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the data returned by the operation.

Name Type Description
NoOfBlogRecommendations Int The number indicating the blog's position in the list of recommendations returned by WordPress.

CData Cloud

ClickEmails

Returns data about links clicked in WordPress emails, including the email ID, URL, and time of each click.

Table Specific Information

SELECT

View chart stats related to email clicks by period. Note: To view chart stats related to email clicks by period, you must specify the following column in the where clause: PostId.

  • PostId supports the '=' comparison.
  • ClickEmailSummaryDate supports the '=' comparison.
  • ClickEmailSummaryPeriod supports the '=' comparison.

The Cloud processes other filters client-side within the Cloud.

For example,

SELECT * FROM ClickEmails where POSTID=116;

Columns

Name Type References Description
PostID [KEY] Int The unique identifier of the post associated with the clicked email link.
TimelineDataAggregate String Contains aggregated data showing when and how the email link was clicked over time.
TimelineFieldsAggregate String The array of timeline fields that describe details of the email click event.
TimelineUnit String The unit of measurement used to organize the email click event timeline.

CData Cloud

CommentCounts

Returns the total number of comments for WordPress posts, including counts by status such as approved, pending, and spam.

Table Specific Information

SELECT

The Cloud uses the WordPress API to process some of the filters.

  • PostId supports the '=' comparison.

The Cloud processes other filters client-side within the Cloud.

For example, the following queries are processed server side.

SELECT * FROM CommentCounts WHERE PostId = 21

Columns

Name Type References Description
All Int Represents the total count of all comments on the post, regardless of status such as, approved, pending, spam, or trash.
Approved Int The number of approved comments for the post.
Pending Int The number of comments on the post that are awaiting moderation.
Trash Int The number of comments for the post that have been moved to the trash.
Spam Int The number of comments on the post that are marked as spam.
PostTrashed Int Indicates whether the associated post has been moved to the trash in WordPress.
TotalComments Int The total number of comments associated with the post across all statuses.

Pseudo-Columns

Pseudo-column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the data returned by the operation.

Name Type Description
PostId Int The unique identifier of the post for which the comment counts are summarized.

CData Cloud

CommentLikes

Returns information about likes on WordPress comments, including the number of likes each comment has received.

Table Specific Information

SELECT

The Cloud uses the WordPress API to process some of the filters.

  • CommentId supports the '=' comparison.

The Cloud processes other filters client-side within the Cloud.

For example, the following queries are processed server side.

SELECT * FROM CommentLikes WHERE CommentId = 10

Columns

Name Type References Description
CommentId [KEY] Int

Comments.Id

The unique identifier of the comment that received the like.
ID [KEY] Int The unique identifier of the user who liked the comment.
Name String The display name of the user who liked the comment.
Login String The WordPress username of the user who liked the comment.
Email String The email address of the user who liked the comment.
IPAddress String The IP address from which the comment was liked.
FirstName String The first name of the user who liked the comment.
LastName String The last name of the user who liked the comment.
NiceName String The URL-friendly version of the user's display name used in WordPress profile links.
SiteID Int The unique identifier of the site associated with the user who liked the comment.
IsSiteVisible Bool Indicates whether the site associated with the user is publicly visible in WordPress.
ProfileURL String The URL linking to the WordPress profile of the user who liked the comment.
DefaultAvatar Bool Indicates whether the user is using the default WordPress avatar image.
AvatarURL String The URL of the avatar image for the user who liked the comment.
ItemURL String The URL linking directly to the comment that was liked.
MetaAggregate String Aggregated metadata for the comment like record returned by the WordPress API.

CData Cloud

CommentLikeStatus

Returns the like status of WordPress comments for the current user, including whether each comment has been liked.

Table Specific Information

SELECT

The Cloud uses the WordPress API to process some of the filters.

  • CommentId supports the '=' comparison.

The Cloud processes other filters client-side within the Cloud.

For example, the following queries are processed server side.

SELECT * FROM CommentLikeStatus WHERE CommentID = 0

Columns

Name Type References Description
ILike Bool Indicates whether the current user has liked the comment.
LikeCount Int The total number of likes the comment has received in WordPress.
MetaAggregate String Aggregated metadata describing the like status for a comment, as provided by the WordPress API.
CommentID Int

Comments.Id

The unique identifier of the comment associated with the like status.

CData Cloud

DropDownPages

Returns a list of WordPress pages, including their IDs and titles, for use in dropdown selections.

Table Specific Information

SELECT

The Cloud processes all the filters client-side within the Cloud.

SELECT * FROM DropDownPages

Columns

Name Type References Description
ID [KEY] Int Specifies the unique ID assigned to the WordPress page, used for selection in dropdown lists or references.
Title String Specifies the title of the WordPress page displayed in dropdown selections.

CData Cloud

EmailSettings

Returns the email configuration settings for the WordPress site, including sender details and notification preferences.

Table Specific Information

SELECT

The Cloud processes all the filters client-side within the Cloud. For example,

SELECT * FROM EmailSettings;

Columns

Name Type References Description
MailOption String The selected email delivery option or method configured for WordPress notifications.
DeliveryDay Int The day of the week scheduled for WordPress email delivery.
DeliveryHour Int The hour of the day scheduled for WordPress email delivery.
IsEmailBlocked Bool Indicates whether WordPress email delivery is blocked or disabled.
Frequency String The frequency at which WordPress email notifications are sent.

CData Cloud

Feed

Returns metadata and subscription information for a specific feed in the WordPress Reader.

Table Specific Information

SELECT

The Cloud uses the WordPress API to process some of the filters.

  • FeedId supports the '=' comparison.
  • FeedURL supports the '=' comparison.

The Cloud processes other filters client-side within the Cloud.

For example, the following queries are processed server side.

SELECT * FROM Feed where FeedID='12'
SELECT * FROM Feed where FeedURL='url_string'

Columns

Name Type References Description
FeedID [KEY] String Specifies the unique identifier assigned to the feed in WordPress, used to identify and retrieve feed entries.
FeedURL String Specifies the web address of the RSS or Atom feed associated with the WordPress site.
BlogID String Specifies the WordPress blog ID from which the feed originates.
Description String Provides a summary or description of the feed's content, as defined in WordPress.
Image String Specifies the image or logo representing the WordPress feed, typically displayed with feed entries.
IsFollowing Bool Indicates whether the current user is following the WordPress feed.
LastChecked Datetime Records the most recent timestamp when WordPress checked the feed for new content.
LastUpdate Datetime Indicates the most recent timestamp when the feed's content was updated or new entries were published.
Name String Specifies the name or display title of the feed, typically corresponding to the WordPress site or blog title.
NextRefreshTime Datetime Specifies the next scheduled time when WordPress refreshes the feed to check for new content.
OrganizationID Int Specifies the WordPress organization or site network ID linked to the feed, if applicable.
ResolvedFeedURL String Specifies the fully resolved URL of the WordPress feed after processing any redirects or canonical references.
SubscribersCount Int Indicates how many WordPress users are currently subscribed to the feed.
SubscriptionID String Specifies the WordPress subscription ID associated with the user's connection to the feed.
UnseenCount Int Indicates how many feed entries have not yet been viewed by the user in WordPress.
URL String Specifies the web address of the WordPress site or source from which the feed content originates.
IsMarkedForRefresh Bool Indicates whether the feed is marked for manual or immediate refresh in WordPress.
MetaAggregate String Aggregated metadata for the WordPress feed, including additional details returned by the API.

CData Cloud

Follows

Returns a list of WordPress blogs or sites followed by the current user, including their Ids, names, and URLs.

Table Specific Information

SELECT

The Cloud processes all the filters client-side within the Cloud. For example,

SELECT * FROM Follows;

Columns

Name Type References Description
ID [KEY] String The unique identifier of the blog or user being followed in WordPress.
Login String Specifies the WordPress username of the account that the current user is following.
Name String The display name of the blog or user being followed.
NiceName String The URL-friendly version of the blog or user's name used in WordPress profile URLs.
ItemURL String The URL of the WordPress blog or user profile being followed.
AvatarURL String The URL of the avatar image for the blog or user being followed.
ProfileURL String The URL linking to the public profile of the blog or user being followed.
IsIpAddressAvailable Boolean Indicates whether the IP address of the followed user or site is available in WordPress.
SiteID Int The unique identifier of the WordPress site being followed.
IsSiteVisible Boolean Indicates whether the site being followed is publicly visible.

Pseudo-Columns

Pseudo-column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the data returned by the operation.

Name Type Description
NoOfFollowers Int The total number of followers subscribed to the WordPress site or user.

CData Cloud

Insights

Returns analytical data and performance insights for the WordPress site, including views, visitors, likes, and comments.

Table Specific Information

SELECT

The Cloud processes all the filters client-side within the Cloud.

SELECT * FROM Insights

Columns

Name Type References Description
ID [KEY] Int The unique identifier of the WordPress site associated with the insights data.
Name String The name or title of the WordPress site associated with the insights.
HasCustom Bool Indicates whether the site has custom insights or analytics settings configured.
TodayApiInsightsCommentsNumber Int The number of comments recorded on the site today according to API insights.
TodayApiInsightsCommentsPercent String The percentage change in comment activity today compared to the previous period.
TodayApiInsightsConnectionsNumber Int The total number of new site connections recorded today.
TodayApiInsightsConnectionsPercent String The percentage change in new site connections today compared to the previous period.
TodayApiInsightsLikesNumber Int The total number of likes recorded on the site today.
TodayApiInsightsLikesPercent String The percentage change in likes today compared to the previous period.
TodayApiInsightsPostsNumber Int The total number of posts published on the site today.
TodayApiInsightsPostsPercent String The percentage change in post publishing activity today compared to the previous period.
TodayRestApiCallsNumber Int The total number of REST API calls made to the WordPress site today.
TodayRestApiCallsPercent String The percentage change in REST API call activity today compared to the previous period.
TodayRestApiErrorsNumber Int The total number of REST API errors that occurred on the site today.
TodayRestApiErrorsPercent String The percentage change in REST API errors today compared to the previous period.
TodayRestApiReadsNumber Int The total number of REST API read (GET) requests made to the site today.
TodayRestApiReadsPercent String The percentage change in REST API read (GET) requests today compared to the previous period.
TodayRestApiWritesNumber Int The total number of REST API write (POST, PUT, DELETE) requests made to the site today.
TodayRestApiWritesPercent String The percentage change in REST API write requests today compared to the previous period.

CData Cloud

MatchingFeeds

Get the MatchingFeeds for a blog.

Table Specific Information

SELECT

The Cloud uses the WordPress API to process some of the filters.

Note: To query the MatchingFeeds, you must specify the either of the following columns in the WHERE clause: QueryText, ItemUrl.

  • FeedId supports the '=' comparison.
  • QueryText supports the '=' comparison.
  • ItemUrl supports the '=' comparison.

The Cloud processes other filters client-side within the Cloud.

For example:

SELECT * FROM MatchingFeeds WHERE QueryText='test';
SELECT * FROM MatchingFeeds WHERE ItemUrl='http://www.thebereantest.com'
SELECT * FROM MatchingFeeds WHERE QueryText='test' 
SELECT * FROM MatchingFeeds WHERE ItemUrl='http://www.thebereantest.com'

Columns

Name Type References Description
FeedID [KEY] String The unique identifier of the feed associated with a WordPress site or blog.
SubscribeURL String The URL used to subscribe to the feed or follow updates from the site.
MetaAggregate String Returns aggregated metadata about the feed, such as title, description, and site details.
RailCarAggregate String Provides structured feed data returned from the Reader service for the specified site.
ItemURL String Specifies the domain or site URL used to retrieve the corresponding feed ID. This value must be URL-encoded.

Pseudo-Columns

Pseudo-column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the data returned by the operation.

Name Type Description
QueryText String Specifies the search text or keywords used to query and match relevant feeds.

CData Cloud

OpenEmails

Query the OpenEmails in Wordpress.

Table Specific Information

SELECT

The Cloud uses the WordPress API to process some of the filters.

  • PostId supports the '=' comparison.

The Cloud processes other filters client-side within the Cloud.

For example,

SELECT * FROM OpenEmails where PostId='157';

Columns

Name Type References Description
PostID [KEY] Int The unique identifier of the WordPress post associated with the email campaign.
ClientsAggregate String Returns aggregated information about the email clients used to open the campaign messages.
ClientsDataAggregate String Contains detailed data for each email client, including open counts and usage distribution.
ClientsFieldsAggregate String Provides field-level information describing the structure of the client data returned.
CountriesAggregate String Returns aggregated statistics grouped by country, showing where emails were opened.
CountriesDataAggregate String Contains detailed country-level data for email opens, such as open counts and percentages.
CountriesFieldsAggregate String Provides field definitions and labels for the country-based email analytics data.
CountriesInfoAggregate String Lists all countries included in the email analytics report.
DevicesAggregate String Returns aggregated data showing which devices were used to open the emails, such as mobile, desktop, or tablet.
DevicesDataAggregate String Contains detailed device-level data for email opens and engagement activity.
DevicesFieldsAggregate String Provides field definitions and labels for the device-related data returned.
OpensRate Int The average rate at which emails were opened during the reporting period.
TotalOpens Int The total number of email opens recorded during the reporting period.
TotalSends Int The total number of emails sent during the reporting period.
UniqueOpens Int The number of distinct recipients who opened the email at least once.
OpensRateOpensRate Int Represents the calculated open rate for the campaign or reporting period.
OpensRateTotalOpens Int Represents the total number of email opens used to calculate the open rate.
OpensRateTotalSends Int Represents the total number of sent emails used to calculate the open rate.
OpensRateUniqueOpens Int Represents the number of unique opens used to calculate the open rate.
TimelineDataAggregate String Contains time-based email performance data, including open and send counts across defined periods.
TimelineFieldsAggregate String Provides metadata and field descriptions for the timeline-based data returned.
TimelineUnit String Specifies the time unit used in the timeline, such as hour, day, week, month, or year.
NumberofPeriods Int Specifies how many time periods to include in the timeline report.
Period String Determines the time range used for the report, such as past hours, days, weeks, months, or years.
Date Date Specifies the most recent date to include in the email analytics report.
StatsFields String A comma-separated list of specific statistical fields to return in the response, such as TotalOpens or UniqueOpens.

CData Cloud

PostReblogStatus

Get reblog status for a post.

Table Specific Information

SELECT

The Cloud uses the WordPress API to process some of the filters.

  • PostId supports the '=' comparison.

The Cloud processes other filters client-side within the Cloud.

For example, the following queries are processed server side.

SELECT * FROM PostReblogStatus where PostId=21

Columns

Name Type References Description
PostId [KEY] Int

Posts.Id

The unique identifier of the WordPress post for which the reblog status is being checked.
CanReblog Bool Indicates whether the post is eligible to be reblogged by any WordPress user.
CanUserReblog Bool Indicates whether the authenticated user has permission to reblog the specified post.
IsReblogged Bool Shows whether the authenticated user has already reblogged this post.
MetaAggregate String Contains additional metadata returned from the WordPress API related to the PostReblogStatus endpoint.

CData Cloud

PostsTags

List the UserLikedPosts for the WordPressOnline website.

Table Specific Information

SELECT

The Cloud uses the WordPress API to process some of the filters.

  • Date supports the '<', '>' comparisons.
  • Modified supports the '<', '>' comparisons.
  • Status supports the '=' comparison.
  • Type supports the '=' comparison.

The Cloud processes other filters client-side within the Cloud.

For example, the following queries are processed server side.

SELECT * FROM PostsTags
SELECT * FROM PostsTags where Status='publish'
SELECT * FROM PostsTags where Type='post'

Columns

Name Type References Description
ID [KEY] Integer

Posts.Id

The unique identifier of the post.
SiteID Integer The unique identifier of the WordPress site that the post belongs to.
AuthorID Int The unique identifier of the author who created the post.
DateRangeBefore String Filters results to posts created before the specified date.
DateRangeAfter String Filters results to posts created after the specified date.
AuthorLogin String The username of the post's author.
IsAuthorEmailAvailable Boolean Indicates whether the author's email address is available.
AuthorName String The display name of the post's author.
AuthorAvatarURL String The URL of the author's avatar image.
AuthorFirstName String The first name of the post's author.
AuthorLastName String The last name of the post's author.
AuthorNiceName String The URL-friendly version of the author's username.
AuthorProfileURL String The URL of the author's public WordPress profile page.
AuthorSiteID Int The ID of the site associated with the author.
AuthorURL String The personal website URL provided by the author, if available.
IsAuthorIpAddressAvailable Boolean Indicates whether the author's IP address is available.
IsAuthorSiteVisible Boolean Indicates whether the author's site is publicly visible.
Date Datetime The date and time when the post was created in the site's local timezone.
Modified Datetime The date and time when the post was last updated.
Title String The title of the post.
ItemURL String The full permalink URL for the post.
ShortURL String The WordPress shortlink (`wp.me`) version of the post URL.
Content String The full HTML content of the post.
Excerpt String A short excerpt or summary of the post content.
Slug String The URL-friendly slug used to identify the post.
Guid String The globally unique identifier (GUID) for the post, often representing its original permalink.
Status String A comma-separated list of post statuses to query, such as publish, private, draft, pending, future, or trash. Defaults to publish.
IsSticky Boolean Indicates whether the post is marked as sticky and displayed at the top of the blog.
Password String The plaintext password used to protect the post, or an empty string if the post is not password-protected.
HasParent Boolean Indicates whether the post has a parent post (for example, a child page).
Type String The post type, such as post, page, or another registered custom post type.
HasCommentsOpen Boolean Indicates whether comments are currently open for the post.
IsPingsOpen Boolean Indicates whether pingbacks and trackbacks are enabled for the post.
HasLikesEnabled Boolean Indicates whether the post allows likes.
HasSharingEnabled Boolean Indicates whether sharing buttons are enabled for the post.
CommentCount Int The total number of comments associated with the post.
FeaturedImage String The URL of the post's featured image, if one is set.
PostThumbnail String The attachment object representing the featured image, if available.
Format String The display format of the post, such as standard, aside, gallery, image, quote, status, video, or audio.
HasGeo Boolean Indicates whether the post includes geolocation data.
MenuOrder Int The order in which pages or hierarchical posts appear in navigation menus.
PublicizeURLsAggregates String A list of URLs where the post was automatically shared via Publicize connections (for example, Facebook or Twitter).
CategoriesAggregates String A collection of categories (keyed by category name) applied to the post.
TagsAggregates String A collection of tags (keyed by tag name) applied to the post.
Attachments String A collection of attachments associated with the post (keyed by attachment ID). Returns up to 20 of the most recent attachments.
MetadataAggregates String A list of metadata key-value pairs associated with the post.
MetaAggregates String Additional metadata key-value pairs describing the post's extended properties.
HasCapabilitiesDeletePost Boolean Indicates whether the authenticated user has permission to delete the post.
HasCapabilitiesEditPost Boolean Indicates whether the authenticated user has permission to edit the post.
HasCapabilitiesPublishPost Boolean Indicates whether the authenticated user has permission to publish the post.
HasCurrentUserCanDeletePost Boolean Indicates whether the current user can delete the post.
HasCurrentUserCanEditPost Boolean Indicates whether the current user can edit the post.
HasCurrentUserCanPublishPost Boolean Indicates whether the current user can publish the post.
PseudoID String A unique pseudo identifier for the feed item, used when the post originates from a feed or external source.
IsExternal Boolean Indicates whether the post originates from an external source.
SiteName String The name of the site where the post was published.
SiteURL String The URL of the site where the post was published.
IsSitePrivate Boolean Indicates whether the site is private or restricted from public access.
FeaturedMedia String The media file featured or attached to the post.
Tags String The list of tags applied to the post.

CData Cloud

PostTypes

List the PostTypes for the WordPressOnline website.

Table Specific Information

SELECT

The Cloud processes all the filters client-side within the Cloud. For example,

SELECT * FROM PostTypes;

Columns

Name Type References Description
Name [KEY] String The slug identifier for the post type, used internally and in REST API endpoints.
Label String The human-readable name for the post type as displayed in the WordPress admin menu.
IsApiQueryable Bool Indicates whether this post type can be queried and accessed through the REST API.
Description String A short description of what the post type represents or is used for.
IsHierarchical Bool Indicates whether the post type supports parent and child relationships, like pages.
CapabilitiesCreatePosts String Defines the capability required to create new posts of this type.
CapabilitiesDeleteOthersPosts String Defines the capability required to delete posts created by other users.
CapabilitiesDeletePost String Defines the capability required to delete a single post.
CapabilitiesDeletePosts String Defines the capability required to delete multiple posts.
CapabilitiesDeletePrivatePosts String Defines the capability required to delete private posts.
CapabilitiesDeletePublishedPosts String Defines the capability required to delete published posts.
CapabilitiesEditOthersPosts String Defines the capability required to edit posts created by other users.
CapabilitiesEditPost String Defines the capability required to edit a single post.
CapabilitiesEditPosts String Defines the capability required to edit multiple posts.
CapabilitiesEditPrivatePosts String Defines the capability required to edit private posts.
CapabilitiesEditPublishedPosts String Defines the capability required to edit published posts.
CapabilitiesPublishPosts String Defines the capability required to publish posts.
CapabilitiesRead String Defines the general capability required to read posts of this type.
CapabilitiesReadPost String Defines the capability required to read a single post.
CapabilitiesReadPrivatePosts String Defines the capability required to read private posts.
LabelsAddNew String The text label for adding a new post of this type.
LabelsAddNewItem String The text label for adding a new item of this post type.
LabelsAllItems String The label used to display all items of this post type.
LabelsArchives String The label used to describe the post type archive page.
LabelsAttributes String The label for displaying post attributes, such as template or order.
LabelsEditItem String The text label for editing a single item of this post type.
LabelsFeaturedImage String The label used to describe the featured image section.
LabelsFilterByDate String The label for the date filter dropdown in the admin list view.
LabelsFilterItemsList String The label for filtering items in the admin list table.
LabelsInsertIntoItem String The label for the button that inserts media into this post type.
LabelsItemLink String The label describing a permalink to a single item.
LabelsItemLinkDescription String The label describing the permalink text or tooltip.
LabelsItemPublished String The label displayed when a post of this type is published.
LabelsItemPublishedPrivately String The label displayed when a post of this type is published privately.
LabelsItemRevertedToDraft String The label displayed when a post of this type is reverted to draft.
LabelsItemScheduled String The label displayed when a post of this type is scheduled for publication.
LabelsItemTrashed String The label displayed when a post of this type is moved to the trash.
LabelsItemUpdated String The label displayed when a post of this type is updated.
LabelsItemsList String The label for listing items of this post type in the admin area.
LabelsItemsListNavigation String The label for navigating the list of items in the admin view.
LabelsMenuName String The name used for this post type in the admin menu.
LabelsName String The plural name of the post type.
LabelsNameAdminBar String The name used for this post type in the WordPress admin bar.
LabelsNewItem String The label used for creating a new item of this post type.
LabelsNotFound String The message displayed when no posts of this type are found.
LabelsNotFoundInTrash String The message displayed when no posts of this type are found in the trash.
LabelsParentItemColon String The label used to indicate the parent item field.
LabelsRemoveFeaturedImage String The label for the option to remove a featured image.
LabelsSearchItems String The label for the search box when searching posts of this type.
LabelsSetFeaturedImage String The label for the option to set a featured image.
LabelsSingularName String The singular name of the post type.
LabelsTemplateName String The label for the template name field for this post type.
LabelsUploadedToThisItem String The label for media uploaded to this post type.
LabelsUseFeaturedImage String The label for using a featured image.
LabelsViewItem String The label for viewing a single item of this post type.
LabelsViewItems String The label for viewing multiple items of this post type.
HasMapMetaCap Bool Indicates whether meta capability mapping is enabled for this post type.
IsPublic Bool Indicates whether the post type is publicly visible.
IsPubliclyQueryable Bool Indicates whether queries can be performed on the front end for this post type.
HasShowUi Bool Indicates whether this post type should have a visible interface in the admin dashboard.
HasSupportsAuthorDropDownEnabled Bool Indicates whether the Author selection dropdown is enabled for this post type.
HasSupportsAutosave Bool Indicates whether autosave is enabled for this post type.
HasSupportsComments Bool Indicates whether comments are supported for this post type.
HasSupportsContent Bool Indicates whether the main content editor is supported for this post type.
HasSupportsCustomFields Bool Indicates whether custom fields are supported for this post type.
HasSupportsEditor Bool Indicates whether the block or classic editor is supported for this post type.
HasSupportsExcerpt Bool Indicates whether excerpts are supported for this post type.
HasSupportsGeoLocation Bool Indicates whether geolocation fields are supported for this post type.
HasSupportsJetpackPostLikes Bool Indicates whether Jetpack post likes are supported for this post type.
HasSupportsNewspackBlocks Bool Indicates whether Newspack blocks are supported for this post type.
HasSupportsPageAttributes Bool Indicates whether page attributes, such as order or parent, are supported.
HasSupportsPostFormats Bool Indicates whether post formats are supported, allowing authors to classify content by format.
HasSupportsPublicize Bool Indicates whether Jetpack Publicize integration is supported.
HasSupportsRevisions Bool Indicates whether revisions are supported for this post type.
HasSupportsSlug Bool Indicates whether a URL slug is supported for this post type.
HasSupportsTags Bool Indicates whether tags are supported for this post type.
HasSupportsThumbnail Bool Indicates whether featured images (thumbnails) are supported for this post type.
HasSupportsTitle Bool Indicates whether titles are supported for this post type.
HasSupportsTrackbacks Bool Indicates whether trackbacks are supported for this post type.
HasSupportsWpcomMarkdown Bool Indicates whether Markdown formatting is supported for this post type on WordPress.com.

CData Cloud

ReaderMenuDefault

Default menu items from the WordPress Reader Menu.

Table Specific Information

SELECT

The Cloud processes all the filters client-side within the Cloud.

SELECT * FROM ReaderMenuDefault

Columns

Name Type References Description
Title String The title of the default Reader menu item displayed in the WordPress Reader.
ItemURL String The URL that the default Reader menu item links to.

CData Cloud

ReaderMenuRecommended

Recommended topics from the WordPress Reader Menu.

Table Specific Information

SELECT

The Cloud processes all the filters client-side within the Cloud.

SELECT * FROM ReaderMenuRecommended

Columns

Name Type References Description
ID [KEY] String The unique identifier of the recommended topic displayed in the WordPress Reader.
Title String The title of the recommended topic shown in the Reader menu.
ItemURL String The URL that links to the recommended topic in the WordPress Reader.
Slug String The URL-friendly slug used to identify the recommended topic.
DisplayName String The display name of the topic as it appears in the Reader interface.
Type String The content type of the recommended item, such as tag or category.

CData Cloud

ReaderMenuSubscribed

Subscribed topics from the WordPress Reader Menu.

Table Specific Information

SELECT

The Cloud processes all the filters client-side within the Cloud.

SELECT * FROM ReaderMenuSubscribed

Columns

Name Type References Description
ID [KEY] String The unique identifier of the topic that the user is subscribed to in the WordPress Reader.
Title String The title of the subscribed topic displayed in the Reader menu.
ItemURL String The URL that links to the subscribed topic within the WordPress Reader.
Slug String The URL-friendly slug used to identify the subscribed topic.
DisplayName String The display name of the subscribed topic as it appears in the Reader interface.
Type String The content type of the subscribed item, such as tag or category.

CData Cloud

RecentComments

Get a list of recent comments on a post.

Table Specific Information

SELECT

The Cloud uses the WordPress API to process some of the filters.

  • PostId supports the '=' comparison.
  • Type supports the '=' comparison.
  • Status supports the '=' comparison.
  • Date supports the '<=', '>=' comparisons.

The Cloud processes other filters client-side within the Cloud.

For example, the following queries are processed server side.

SELECT * FROM RecentComments where PostID=21
SELECT * FROM RecentComments where Status='approved'

Columns

Name Type References Description
ID [KEY] Int

Comments.Id

The unique identifier of the comment.
Type String The type of comment, such as standard comment, trackback, or pingback.
Status String The current moderation status of the comment, such as approved, pending, or spam.
Date Datetime The date and time when the comment was posted, in the site's timezone.
Content String The rendered HTML content of the comment as displayed on the site.
RawContent String The raw comment text including any block-level or markup data before rendering.
PostID Int The unique identifier of the post or page that the comment belongs to.
PostLink String The API endpoint or URL used to retrieve details about the related post.
PostTitle String The title of the post that the comment was made on.
PostType String The content type of the associated post, such as post or page.
ParentCommentAggregate String A JSON object contains details of the parent comment if the comment is a reply. It returns false if the comment is a top-level comment.
LikeCount Int The total number of likes the comment has received.
IReplied Bool Indicates whether the authenticated user has replied to this comment.
ILike Bool Indicates whether the authenticated user has liked this comment.
CanModerate Bool Indicates whether the authenticated user has permission to moderate this comment.
AuthorAvatarURL String The URL to the comment author's avatar image.
AuthorEmail String The email address of the comment author.
AuthorFirstName String The first name of the comment author.
AuthorID Int The unique identifier of the comment author.
AuthorIPAddress String The IP address from which the comment was submitted.
AuthorLastName String The last name of the comment author.
AuthorLogin String The username of the comment author.
AuthorName String The public display name of the comment author.
AuthorNiceName String A URL-friendly version of the author's username.
AuthorProfileURL String The Gravatar or profile URL associated with the author.
AuthorAiteID Int The ID of the WordPress site where the author posted the comment.
HasAuthorSiteVisible Bool Indicates whether the author's site is publicly visible.
AuthorURL String The URL of the author's personal or linked website.
ShortURL String The WordPress shortlink (wp.me) that provides a shortened URL to the comment.
ItemURL String The full permalink URL to the comment on the WordPress site.

CData Cloud

SharingButtons

list and update all the sharing buttons for a site.

Table Specific Information

SELECT

The Cloud processes all the filters client-side within the Cloud.

SELECT * FROM SharingButtons

Columns

Name Type References Description
ID [KEY] String The unique identifier assigned to the sharing button.
HasCustomButton Bool Indicates whether the button is a custom sharing option created by the user rather than a default service-provided button.
HasSharingButtonEnabled Bool Indicates whether the sharing button is currently enabled and visible on the site.
Genericon String The Genericon icon name associated with the sharing button's visual style.
Name String The display name of the sharing service or button (for example, Twitter or Facebook).
Shortname String The short identifier or slug used internally to represent the sharing service (for example, twitter or facebook).
Visibility String Specifies where the sharing button appears on the site interface, such as visible or hidden.

CData Cloud

SiteCountryViews

Query the SiteCountryViews in Wordpress.

Table Specific Information

SELECT

The Cloud uses the WordPress API to process some of the filters.

  • Date supports the '=' comparison.

The Cloud processes other filters client-side within the Cloud.

For example, the following queries are processed server side.

SELECT * FROM SiteCountryViews WHERE Date='2025-05-08'

Columns

Name Type References Description
CountryInfoAggregate String An array containing detailed information about each country that generated views for the site, including country codes and view counts.
DaysAggregate String An array mapping each day to the number of country-specific views recorded on that date.
Date Date The most recent date included in the site's country view statistics.

Pseudo-Columns

Pseudo-column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the data returned by the operation.

Name Type Description
NumofPeriods Int Specifies how many time periods to include in the results, such as days, weeks, or months.

CData Cloud

SiteEmailSummary

Query the SiteEmailsSummary in Wordpress.

Table Specific Information

SELECT

The Cloud uses the WordPress API to process some of the filters.

  • SiteID supports the '=' comparison.

The Cloud processes other filters client-side within the Cloud.

For example, the following queries are processed server side.

SELECT * FROM SiteEmailSummary WHERE SiteID='241575003'

Columns

Name Type References Description
SiteID Int The unique identifier of the WordPress site associated with the email campaign.
PostId [KEY] Int The unique identifier of the post or content item linked to the email.
Clicks Int The total number of clicks recorded from the email over time.
ClicksRate Int The percentage rate at which recipients clicked links within the email.
Date Datetime The date and time when the email performance metrics were recorded.
Href String The target URL or hyperlink contained in the email message.
Opens Int The total number of times the email was opened by recipients.
OpensRate Int The percentage rate of email opens over the total sends.
Title String The subject line or title of the email message.
TotalSends Int The total number of email messages sent during the campaign.
Type String The category of content or campaign type associated with the email, such as post notification or newsletter.
UniqueClicks Int The number of distinct recipients who clicked at least one link in the email.
UniqueOpens Int The number of distinct recipients who opened the email at least once.

CData Cloud

SiteFileDownloads

Query the SiteFileDownloads in Wordpress.

Table Specific Information

SELECT

The Cloud uses the WordPress API to process some of the filters.

  • Date supports the '=' comparison.
  • Period supports the '=' comparison.

The Cloud processes other filters client-side within the Cloud.

For example, the following queries are processed server side.

SELECT * FROM SiteFileDownloads WHERE Date='2025-05-08'

Columns

Name Type References Description
Date Date The most recent date for which file download statistics are available.
DaysAggregate String An array that maps each day to the number of file downloads recorded on that date.
Period String Specifies the reporting interval for the statistics, such as day, week, month, or year.

Pseudo-Columns

Pseudo-column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the data returned by the operation.

Name Type Description
NumofPeriods Int Determines how many reporting periods to include in the returned results.

CData Cloud

SiteFollowers

Query the SiteFollowers in Wordpress.

Table Specific Information

SELECT

The Cloud processes all the filters client-side within the Cloud.

SELECT * FROM SiteFollowers

Columns

Name Type References Description
ID [KEY] Int The unique identifier of the follower associated with the site.
Label String A display label or name representing the follower or subscription source.
Login String The WordPress.com username of the follower, if available.
ItemURL String The URL associated with the follower's profile or linked account.
IsOwnerSubscribed Boolean Indicates whether the site owner is also subscribed to their own site.
Page Int The current page number in the paginated results set.
Pages Int The total number of pages available for the follower list.
Total Int The total number of followers for the site.
TotalEmail Int The total number of followers subscribed via email notifications only.
TotalWpcom Int The total number of followers subscribed using WordPress.com accounts.
Avatar String The URL of the follower's avatar image.
DateSubscribed Datetime The date and time when the follower subscribed to the site.
FollowDataAggregate String A JSON object containing detailed metadata about the follower, such as subscription type, source, or delivery method.

Pseudo-Columns

Pseudo-column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the data returned by the operation.

Name Type Description
Type String Specifies the subscription method: 'wpcom' for WordPress.com followers or 'email' for email-only subscribers. The default is 'wpcom'.

CData Cloud

SiteOutboundClicks

Query the SiteOutboundClicks in Wordpress.

Table Specific Information

SELECT

The Cloud uses the WordPress API to process some of the filters.

  • Date supports the '=' comparison.
  • Period supports the '=' comparison.
  • Summarize supports the '=' comparison.

The Cloud processes other filters client-side within the Cloud.

For example, the following queries are processed server side.

SELECT * FROM SiteOutboundClicks WHERE Date='2025-05-08'

Columns

Name Type References Description
Date Date The most recent date for which outbound click statistics are available.
DaysAggregate String An array listing each day and the number of outbound clicks recorded on that day. Omitted when summarize is set to true.
SummaryAggregate String A summarized dataset combining click statistics across all days in the selected period. Returned only when summarize is true.
Period String Specifies the reporting interval for the statistics, such as day, week, month, or year.

The allowed values are day, month, year.

Pseudo-Columns

Pseudo-column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the data returned by the operation.

Name Type Description
HasSummarize Boolean Indicates whether results are returned in summarized form instead of detailed daily records.
NumofPeriods Int Determines how many reporting periods to include in the results.

CData Cloud

SitePosts

List the UserSitesPosts for the WordPressOnline website.

Table Specific Information

SELECT

The Cloud uses the WordPress API to process some filters. Other filters are processed client-side within the Cloud.

For example, the following query is processed server side:

SELECT * FROM SitePosts WHERE ID=1 

Columns

Name Type References Description
ID [KEY] Int

Posts.Id

The unique identifier of the post.
SiteID Int

Sites.Id

The unique identifier of the site where the post is published.
AuthorID Int The unique identifier of the post author.
IsAuthorEmailAvailable Boolean Indicates whether the author's email address is available.
AuthorLogin String The author's WordPress.com login name.
AuthorName String The full display name of the post author.
AuthorAvatarURL String The URL of the author's avatar image.
AuthorFirstName String The first name of the post author.
AuthorLastName String The last name of the post author.
AuthorNiceName String A URL-friendly version of the author's username.
AuthorProfileURL String The URL of the author's WordPress.com profile page.
AuthorSiteID Int The ID of the author's WordPress.com site.
AuthorURL String The URL of the author's external or personal website.
HasAuthoravatar Boolean Indicates whether the author has an avatar image.
AuthorWpcomId Int The unique WordPress.com user ID of the author.
AuthorWpcomLogin String The author's WordPress.com username.
Date Datetime The date and time when the post was originally created.
Modified Datetime The date and time when the post was last updated.
Title String The title of the post.
ItemURL String The full permalink URL to the post.
ShortURL String The WordPress shortlink (wp.me) version of the post URL.
Content String The complete content body of the post.
Excerpt String A short excerpt or summary of the post content.
Slug String The slug used to identify the post in URLs.
Guid String The globally unique identifier for the post.
Status String The current status of the post. Possible values include publish, draft, pending, private, future, trash, and auto-draft.
IsSticky Boolean Indicates whether the post is pinned (sticky) on the site's front page.
Password String The password protecting the post, if applicable; otherwise an empty string.
ParentID String The ID of the parent post, if this post is part of a hierarchy.
ParentLink String The permalink URL of the parent post, if applicable.
ParentTitle String The title of the parent post, if applicable.
ParentType String The type of the parent post, if applicable.
Type String The post type. Common types include post, page, and revision. Custom post types must be whitelisted via the rest_api_allowed_post_types filter.
DiscussionCommentCount Int The total number of comments associated with the post.
DiscussionCommentStatus String Indicates the comment status for the post (open or closed).
HasDiscussionCommentsOpen Boolean Specifies whether new comments are currently allowed.
DiscussionPingStatus String Indicates the pingback or trackback status for the post.
HasDiscussionPingsOpen Boolean Specifies whether pingbacks or trackbacks are allowed.
HasLikesEnabled Boolean Indicates whether likes are enabled for the post.
HasSharingEnabled Boolean Indicates whether sharing buttons are displayed on the post.
LikeCount Int The total number of likes the post has received.
ILike Boolean Indicates whether the current user has liked this post.
IsFollowing Boolean Indicates whether the current user follows the site.
IsReblogged Boolean Indicates whether the current user has reblogged this post.
GlobalID String A globally unique WordPress.com-wide identifier for the post.
FeaturedImage String The URL of the post's featured image, if one is set.
PostThumbnail String The attachment object associated with the post's featured image.
Format String The display format of the post, such as standard, aside, chat, gallery, link, image, quote, status, video, or audio.
HasGeo Boolean Indicates whether geolocation data is attached to the post.
MenuOrder Int Specifies the display order of pages relative to others.
PageTemplate String The page template assigned to the post, if applicable.
PublicizeURLsAggregates String A list of social media URLs where the post was published via WordPress.com Publicize.
CategoriesAggregates String A collection of categories applied to the post, keyed by category name.
TermsCategoryAggregates String A mapping of taxonomy names to term data for assigned categories.
TagsAggregates String A collection of tags applied to the post, keyed by tag name.
Attachments String A list of media attachments related to the post, keyed by attachment ID. Returns up to 20 attachments.
AttachmentCount Int The total number of attachments associated with the post.
MetadataAggregate String A collection of post metadata as key-value pairs.
HasCapabilitiesDeletePost Boolean Indicates whether the current user has permission to delete the post.
HasCapabilitiesEditPost Boolean Indicates whether the current user has permission to edit the post.
HasCapabilitiesPublishPost Boolean Indicates whether the current user has permission to publish the post.
PseudoID String A unique pseudo identifier for the post within the feed context.
IsExternal Boolean Indicates whether the post originates from an external source.
SiteName String The display name of the site the post belongs to.
SiteURL String The base URL of the site the post belongs to.
IsSitePrivate Boolean Indicates whether the site is private or public.
FeaturedMedia String The media object featured in the post, if any.
FeedID Integer The unique identifier of the feed associated with the post.
FeedURL String The URL of the feed that contains the post.
OtherURLs String Additional URLs related to the post or feed, if any.
SiteIcon String The favicon or site icon representing the WordPress site.
IsSubscribedComments Boolean Indicates whether the current user is subscribed to comment updates on this post.
CanSubscribeComments Boolean Indicates whether the current user has permission to subscribe to comments on this post.
HasSubscribedCommentsNotifications Boolean Indicates whether the user receives email notifications for subscribed comments.
IsPublishDateChanged Boolean Indicates whether the post's publish date has been modified since its original creation.
HasUseExcerpt Boolean Indicates whether the post should display only its excerpt instead of the full content.

CData Cloud

SitePostViews

Query the SitePostViews in Wordpress.

Table Specific Information

SELECT

The Cloud uses the WordPress API to process some of the filters.

  • PostId supports the '=' comparison.

The Cloud processes other filters client-side within the Cloud.

For example, the following queries are processed server side.

SELECT * FROM SitePostViews WHERE PostID=21

Columns

Name Type References Description
PostID [KEY] Int The unique identifier of the post for which view statistics are returned.
Date Date The most recent date for which post view statistics are available.
PostAuthor String The unique identifier of the post author.
PostName String The URL-friendly slug used to identify the post in its permalink.
PostParent Int The ID of the parent post, if the post is part of a hierarchy (for example, a page with subpages).
PostPassword String The password protecting the post, if it is password-protected; otherwise empty.
PostStatus String The publication status of the post, such as publish, draft, pending, private, or trash.
PostTitle String The title of the post.
Views Int The total number of times the post has been viewed.
PostType String The post type, such as post, page, or a registered custom type.
HighestDayAverage Int The highest daily average number of views recorded for this post.
HighestMonth Int The month during which the post achieved the highest average views.
HighestWeekAverage Int The highest weekly average number of views recorded for this post.
YearsAggregate String A dataset showing the total views for the post, grouped by year and month.
AveragesAggregate String A dataset showing per-day average views, grouped by year and month.
WeeksAggregate String Daily view counts for recent weeks, useful for short-term performance trends.
FieldsAggregate String Defines the schema for each field in the aggregated view data.
DataAggregate String A flattened array of daily view data, containing counts and timestamps for each day.
PostCommentCount String The total number of comments associated with the post.
PostCommentStatus String Specifies whether comments are allowed (open) or closed for the post.
PostFilter String The content filter applied when retrieving post data (for example, raw or formatted).
PostGuid String The globally unique identifier (GUID) for the post, typically a permanent link reference.
PostMenuOrder Int The menu order value used for hierarchical post types to control display order.
PostPermalink String The full public permalink URL for the post.
PostPingStatus String Indicates whether pingbacks and trackbacks are enabled for the post.
PostPinged String A list of services that have already been pinged for the post.
PostContent String The full HTML or text content body of the post.
PostContentFiltered String An internal field used to store filtered versions of the post content.
PostDate Datetime The local date and time when the post was first published.
PostDateGmt Datetime The UTC date and time when the post was first published.
PostExcerpt String An optional short summary or excerpt of the post content.
PostMimeType String The MIME type of the post, if the post represents a media file attachment.
PostModified Datetime The local date and time when the post was last modified.
PostModifiedGmt Datetime The UTC date and time when the post was last modified.
PostToPing String A legacy field listing URLs to notify (ping) when the post is published.

CData Cloud

SitePublicizeConnection

Query a list of publicize connections that are associated with the specified site.

Table Specific Information

SELECT

The Cloud uses the WordPress API to process some of the filters.

  • Id supports the '=' comparison.
  • Service supports the '=' comparison.
  • KeyringConnectionID supports the '=' comparison.

The Cloud processes other filters client-side within the Cloud.

For example, the following queries are processed server side.

SELECT * FROM SitePublicizeConnection where ID=21
SELECT * FROM SitePublicizeConnection where Service='Facebook'

Columns

Name Type References Description
ID [KEY] Int The unique identifier of the Publicize connection record.
SiteID Int The unique identifier of the WordPress site associated with the Publicize connection.
UserID Int The WordPress.com user ID of the person who authorized the Publicize connection.
Service String The name of the connected external service, such as Facebook, Twitter, or LinkedIn.
Label String A user-defined label or nickname assigned to the connection.
ExternalID String The unique identifier of the connected account on the external service.
HasShared Bool Indicates whether the Publicize connection is shared across multiple users on the site.
Status String The current connection status, such as active, broken, or expired.
KeyringConnectionID Int The internal WordPress.com keyring record ID that manages the OAuth credentials for this connection.
KeyringConnectionUserID Int The WordPress.com user ID associated with the keyring connection.
ExternalDisplay String The display name shown for the connected account on the external service.
IsExpires Bool Indicates whether the access token used for this connection has an expiration time.
ExternalFollowerCount String The number of followers or connections on the linked social media account, if provided by the external service.
ExternalName String The full display name or username of the connected account owner on the external platform.
ExternalProfilePicture String The URL to the profile image of the connected account on the external service.
ExternalprofileURL String The URL to the external profile page for the connected account.
Issued Datetime The date and time when the connection was first created or authorized.
RefreshURL String The endpoint URL used to manually refresh or reauthorize the Publicize connection when needed.

CData Cloud

SitePublicizeFollowerComment

List the SitePublicizeFollowerComment for the WordPressOnline website.

Table Specific Information

SELECT

The Cloud processes all the filters client-side within the Cloud.

SELECT * FROM SitePublicizeFollowerComment

Columns

Name Type References Description
Page Int The current page number in the paginated set of Publicize follower comment results.
Pages Int The total number of result pages available for the current query.
Total Int The total count of follower comments returned across all pages.
Posts String An array containing post objects associated with the follower comments, including metadata such as post ID, title, and comment details.

CData Cloud

SitePublicizeFollowerCounts

List the SitePublicizeFollowerCounts for the WordPressOnline website.

Table Specific Information

SELECT

The Cloud processes all the filters client-side within the Cloud.

SELECT * FROM SitePublicizeFollowerCounts

Columns

Name Type References Description
Followers Int The total number of followers associated with the connected Publicize account.
Service String The name of the connected Publicize service, such as Facebook, Twitter, or LinkedIn.

CData Cloud

Sites

Query information about a site.

Table Specific Information

SELECT

The Cloud processes all the filters client-side within the Cloud.

SELECT * FROM Sites

Columns

Name Type References Description
ID [KEY] Int The unique numeric identifier for the site.
Name String The site's public title as shown in WordPress.
Description String The site's tagline or short description.
ItemURL String The full public URL of the site.
CanUserManage Bool Indicates whether the current user has management permissions for this site.
Capabilities String A list of capabilities granted to the current user on this site.
IsJetpackSite Bool True if the site is connected through Jetpack.
IsJetpackConnection Bool True if the site is connected to WordPress.com via a Jetpack connection.
IsMultisite Bool True if the site belongs to a Multisite network (always true for WordPress.com sites).
SiteOwner Int The user ID of the site owner.
PostCount Int The total number of published posts on the site.
SubscribersCount Int The number of followers/subscribers for the site.
Language String The site's primary language code (for example, en, fr).
IconAggregate String A collection of icon variants, such as sizes and formats, for the site.
LogoId Int The media ID of the site's logo.
LogoSizesAggregate String Available sizes for the site's logo.
LogoUrl String Direct URL to the site's logo image.
IsVisible Bool Indicates Indicates whether this site appears in the user's site list.
IsPrivate Bool Indicates Indicates whether the site is private (requires authentication).
IsComingSoon Bool True if the site is marked as Coming Soon and not yet public.
IsSingleUserSite Bool True if the site has a single user (WordPress.com and Jetpack 3.4+ only).
IsVIP Bool True if the site runs on the WordPress VIP platform.
IsFollowing Bool True if the current user follows this site in Reader.
OrganizationId Int Identifier for the associated P2 organization.
OptionsAdminUrl String Admin settings URL, visible only to users with editing rights.
OptionsAdvancedSEOFrontPageDescription String Search Engine Optimization (SEO) description used on the front page (editors only).
OptionsAdvancedSEOTitleFormatsAggregate String SEO title format rules for the website (editors only).
OptionsAKVPBundleEnabled String Indicates whether the AKVP bundle is enabled (editors only).
OptionsAllowedFileTypesAggregate String List of allowed upload file types (editors only).
IsOptionsAnchorPodcast Bool Indicates whether Anchor podcast integration is enabled (editors only).
IsOptionsBackgroundColor Bool Indicates whether a custom background color is set (editors only).
OptionsBlogPublic Int Public visibility setting: 1 public, 0 discourage search, -1 private (editors only).
IsOptionsBloggingPromptsSettingsPotentialBloggingSite Bool Marks the site as a candidate for blogging prompts (editors only).
IsOptionsBloggingPromptsSettingsPromptsCardOptedIn Bool Indicates whether prompts cards are enabled (editors only).
IsOptionsBloggingPromptsSettingsPromptsRemindersOptedIn Bool Indicates whether prompts reminders are enabled (editors only).
OptionsBloggingPromptsSettingsRemindersDaysAggregate String Days configured for prompts reminders (editors only).
OptionsBloggingPromptsSettingsRemindersTime String Time of day for prompts reminders (editors only).
CanOptionsBlaze Bool Indicates whether Blaze promotion features are available (editors only).
OptionsCreatedAt Datetime Timestamp when site options were created (editors only).
OptionsDefaultCategory Int Default category ID for new posts (editors only).
HasOptionsDefaultCommentStatus Bool Default comment status for new posts (editors only).
HasOptionsDefaultLikesEnabled Bool Default likes setting for new posts (editors only).
HasOptionsDefaultPingStatus Bool Default pingback/trackback status for new posts (editors only).
OptionsDefaultPostFormat String Default post format for new content (editors only).
HasOptionsDefaultSharingStatus Bool Default sharing buttons visibility on new posts (editors only).
OptionsDesignType String Current design type or theme style (editors only).
IsOptionsEditingToolkitActive Bool Indicates whether the Editing Toolkit is active (editors only).
HasOptionsFeaturedImagesEnabled Bool Indicates whether featured images are enabled site-wide (editors only).
OptionsFrameNonce String Security nonce used for framed embeds (editors only).
OptionsGmtOffset Int Configured GMT offset for the site (editors only).
HasOptionsHeaderImage Bool Indicates whether a custom header image is set (editors only).
HasOptionsHeadstart Bool Indicates whether Headstart onboarding is enabled (editors only).
HasOptionsHeadstartFresh Bool Indicates whether Headstart is in a fresh state (editors only).
OptionsImageDefaultLinkType String Default link behavior for inserted images (editors only).
OptionsImageLargeHeight Int Height for the Large image size, in pixels (editors only).
OptionsImageLargeWidth Int Width for the Large image size, in pixels (editors only).
OptionsImageMediumHeight Int Height for the Medium image size, in pixels (editors only).
OptionsImageMediumWidth Int Width for the Medium image size, in pixels (editors only).
OptionsImageThumbnailCrop Int Hard crop setting for thumbnails: 1 hard crop, 0 proportional (editors only).
OptionsImageThumbnailHeight Int Thumbnail height in pixels (editors only).
OptionsImageThumbnailWidth Int Thumbnail width in pixels (editors only).
OptionsImportEngine String Selected import engine or source (editors only).
IsOptionsAutomatedTransfer Bool Indicates whether an automated transfer/migration is active (editors only).
IsOptionsCloudEligible Bool Indicates whether the site is eligible for cloud features (editors only).
IsOptionsCommercial Bool Indicates whether the site is flagged as commercial (editors only).
IsOptionsCommercialReasonsAggregate Bool Indicates whether specific reasons mark the site as commercial (editors only).
IsOptionsIsDifmLiteInProgress Bool Indicates whether a Do-It-For-Me Lite setup is in progress (editors only).
IsOptionsDomainOnly Bool Indicates whether the site uses a domain-only configuration (editors only).
IsOptionsMappedDomain Bool Indicates whether a custom domain is mapped (editors only).
IsOptionsPendingPlan Bool Indicates whether a plan change is pending (editors only).
IsOptionsRedirect Bool Indicates whether the site redirects to another URL (editors only).
IsOptionsWPComAtomic Bool Indicates whether the site runs on WP.com Atomic hosting (editors only).
IsOptionsWPComStore Bool Indicates whether the WP.com Store is enabled (editors only).
IsOptionsWPForTeamsSite Bool Indicates whether the site is a WP for Teams site (editors only).
OptionsJetpackFrameNonce String Security nonce used for Jetpack frames (editors only).
OptionsLaunchpadChecklistTasksStatusesAggregate String Statuses for Launchpad checklist tasks (editors only).
OptionsLaunchpadScreen String Current Launchpad screen state (editors only).
OptionsLoginUrl String Direct login URL for the site (editors only).
OptionsMigrationSourceSiteDomain String Source site domain used during migration (editors only).
OptionsOnboardingSegment String Onboarding segment classification (editors only).
OptionsP2HubBlogID String Blog ID of the P2 hub site (editors only).
OptionsPermalinkStructure String Permalink structure pattern (editors only).
OptionsPodcastingArchive String Podcasting archive settings (editors only).
OptionsPostFormatsAggregate String Post formats supported/configured (editors only).
IsOptionsPublicizePermanentlyDisabled Bool Indicates whether Publicize is permanently disabled (editors only).
OptionsShowOnFront String Front page display setting: posts or a static page (editors only).
OptionsSiteCreationFlow String Site creation flow identifier (editors only).
OptionsSiteGoalsAggregate String Configured site goals and progress (editors only).
OptionsSiteIntent String Stated purpose or intent for the site (editors only).
OptionsSitePartnerBundle String Partner bundle applied to the site (editors only).
OptionsSiteSegment String Site segment classification used by onboarding or analytics (editors only).
OptionsSiteVerticalID String Vertical or industry identifier (editors only).
OptionsSoftwareVersion String Current software version markers (editors only).
OptionsThemeErrorsAggregate String Detected theme errors or diagnostics (editors only).
OptionsThemeSlug String Slug of the active theme (editors only).
OptionsTimezone String Timezone string (for example, America/New_York) (editors only).
OptionsUnmappedUrl String Original URL before domain mapping (editors only).
OptionsUpdatedAt Datetime Timestamp of the last options update (editors only).
IsOptionsUpgradedFiletypesEnabled Bool Indicates whether upgraded upload file types are enabled (editors only).
OptionsVerificationServicesCodes String Site verification codes for search/analytics services (editors only).
IsOptionsVideopressEnabled Bool Indicates whether VideoPress is enabled (editors only).
OptionsVideopressStorageUsed Int Amount of VideoPress storage used, in MB (editors only).
IsOptionsCreatedWithBlankCanvasDesign Bool True if the site was created with the Blank Canvas design.
IsOptionsWoocommerceActive Bool True if WooCommerce is active on the site.
IsOptionsWordAds Bool True if WordAds is enabled (editors only).
OptionsWPComAdminInterface String The WordPress.com admin interface mode in use.
IsOptionsWPComClassicEarlyRelease Bool True if the Classic interface early release is enabled.
OptionsWPComProductionBlogID Int The WordPress.com production blog ID.
IsOptionsWPComSiteSetup Bool True if the WP.com site setup is active.
OptionsWPComStagingBlogIDsAggregate String List of staging blog IDs associated with the site.
P2ThumbnailElementsAggregate String Data used to render a site thumbnail (P2020 themes only).
PlanBillingPeriod String The billing period for the current plan (for example, monthly, yearly).
IsPlanExpired Bool True if the site's paid plan has expired.
PlanFeaturesActiveAggregate String A list of plan features currently active on the site.
PlanFeaturesAvailableadCredit String Indicates whether advertising credit is available in the plan.
PlanFeaturesAvailableadvancedSEO String Indicates whether advanced SEO tools are available in the plan.
PlanFeaturesAvailableAIAssistant String Indicates whether the AI Assistant feature is available in the plan.
PlanFeaturesAvailableAISEOEnhancer String Indicates whether AI SEO Enhancer is available in the plan.
PlanFeaturesAvailableAntispam String Indicates whether anti-spam protection is available in the plan.
PlanFeaturesAvailableArchiveContent String Indicates whether content archiving is available in the plan.
PlanFeaturesAvailableArtificia50GBStorageLimit String Indicates whether a 50 GB storage cap applies to the plan.
PlanFeaturesAvailableAtomic String Indicates whether Atomic hosting features are available.
PlanFeaturesAvailableBackups String Indicates whether site backups are included in the plan.
PlanFeaturesAvailableBigSky String Indicates whether Big Sky features are available in the plan.
PlanFeaturesAvailableBlogDomainOnly String Indicates whether a blog-domain-only configuration is available.
PlanFeaturesAvailableCalendly String Indicates whether Calendly integration is available.
PlanFeaturesAvailableCDN String Indicates whether CDN acceleration is available.
PlanFeaturesAvailableCloudflareAnalytics String Indicates whether Cloudflare Analytics is available.
PlanFeaturesAvailableCloudflareCDN String Indicates whether Cloudflare CDN is available.
PlanFeaturesAvailableConcierge String Indicates whether Concierge support is included.
PlanFeaturesAvailableConciergeBusiness String Indicates whether Concierge Business support is included.
PlanFeaturesAvailableCopySite String Indicates whether Copy Site tooling is available.
PlanFeaturesAvailableCoreAudioAggregate String Indicates whether core/audio blocks are supported.
PlanFeaturesAvailableCoreCover String Indicates whether core/cover blocks are supported.
PlanFeaturesAvailableCoreVideo String Indicates whether core/video blocks are supported.
PlanFeaturesAvailableCreditVouchers String Indicates whether credit vouchers are available.
PlanFeaturesAvailableCustomDesign String Indicates whether advanced design customization is available.
PlanFeaturesAvailableCustomDomain String Indicates whether attaching a custom domain is supported.
PlanFeaturesAvailableDomainMapping String Indicates whether mapping an external domain is supported.
PlanFeaturesAvailableEcommerceManagedPlugins String Indicates whether managed eCommerce plugins are available.
PlanFeaturesAvailableEcommerceManagedPluginsMedium String Indicates whether mid-tier managed eCommerce plugins are available.
PlanFeaturesAvailableEcommerceManagedPluginsSmall String Indicates whether the plan includes the small package of managed eCommerce plugins for lightweight online stores.
PlanFeaturesAvailableEcommerceManagedPluginsTrial String Indicates whether a trial version of managed eCommerce plugins is available under the plan.
PlanFeaturesAvailableEditPlugins String Allows users to edit plugin source code and configuration directly in the WordPress dashboard.
PlanFeaturesAvailableEditThemes String Allows users to modify theme files and settings directly from the dashboard.
PlanFeaturesAvailableEmailForwardsExtendedLimit String Provides an extended limit for creating and managing email forwarding aliases.
PlanFeaturesAvailableFullActivityLog String Enables full tracking of all site activity, including post edits, logins, and plugin changes.
PlanFeaturesAvailableGlobalStyles String Provides access to Global Styles for customizing typography, colors, and layout across the site.
PlanFeaturesAvailableGoogleAnalytics String Allows integration with Google Analytics to track visitor traffic and engagement.
PlanFeaturesAvailableGoogleMyBusiness String Enables synchronization and management of Google Business Profile listings directly from WordPress.
PlanFeaturesAvailableInstallPlugins String Allows installation of new plugins from the WordPress plugin directory or ZIP uploads.
PlanFeaturesAvailableInstallPurchasedPlugins String Allows installation of previously purchased plugins linked to the user's account.
PlanFeaturesAvailableinstallThemes String Allows installation of new themes from the WordPress theme library or via ZIP upload.
PlanFeaturesAvailableInstallWooOnboardingPlugins String Includes WooCommerce onboarding plugins to simplify initial store setup.
PlanFeaturesAvailableJetpackDashboard String Provides access to the Jetpack dashboard for managing performance, security, and marketing features.
PlanFeaturesAvailableLegacyContact String Includes legacy contact features such as old-form integrations or widgets.
PlanFeaturesAvailableListInstalledPlugins String Allows viewing and listing all plugins currently installed on the site.
PlanFeaturesAvailableLiveSupport String Provides access to real-time chat or phone support from WordPress.com staff.
PlanFeaturesAvailableLockedMode String Enables Locked Mode to restrict editing or publishing activity during maintenance or review.
PlanFeaturesAvailableMailPoetBusiness String Includes MailPoet Business plan features for advanced email marketing automation.
PlanFeaturesAvailableManagePlugins String Allows activating, deactivating, and managing plugin updates or configurations.
PlanFeaturesAvailableNoAdverts String Removes all WordPress.com advertisements from the site's pages.
PlanFeaturesAvailablENOWPComBranding String Removes default WordPress.com branding elements from the site's footer and login screens.
PlanFeaturesAvailableOpentable String Adds OpenTable integration or blocks for online reservations.
PlanFeaturesAvailableOptionsPermalink String Allows configuration of advanced permalink structures for URLs.
PlanFeaturesAvailablePayments String Enables Payments features for collecting one-time or recurring payments directly on posts or pages.
PlanFeaturesAvailablePersonalThemes String Provides access to the Personal tier's exclusive theme collection.
PlanFeaturesAvailablePremiumContentContainer String Enables the Premium Content block to restrict access to posts or sections for subscribers only.
PlanFeaturesAvailablePremiumThemes String Provides access to premium WordPress.com themes included with the plan.
PlanFeaturesAvailablePrioritySupport String Provides priority handling for support requests and faster response times.
PlanFeaturesAvailablePrivateWhois String Enables private registration to hide domain ownership details from public records.
PlanFeaturesAvailableRealTimeBackups String Provides continuous, real-time backups that capture every site change instantly.
PlanFeaturesAvailableReducedEmailPriority String Indicates that email support requests receive lower priority under this plan tier.
PlanFeaturesAvailableRepublicize String Enables advanced Publicize features for sharing posts across connected social media accounts.
PlanFeaturesAvailableRestore String Allows restoring the site from previous backups or restore points.
PlanFeaturesAvailableScan String Provides automated security scans to detect malware, threats, or vulnerabilities.
PlanFeaturesAvailableScanManaged String Includes managed scanning services that automatically detect and repair site issues.
PlanFeaturesAvailableScheduledUpdates String Allows scheduling automatic plugin and theme updates to run at defined times.
PlanFeaturesAvailableSearch String Enables advanced on-site search functionality for faster, more accurate results.
PlanFeaturesAvailableSecuritySettings String Unlocks additional security configuration options to protect site data and user access.
PlanFeaturesAvailableSendAMessage String Provides access to tools that let users send direct messages or newsletters to followers.
PlanFeaturesAvailableSEOPreviewTools String Displays live previews of how posts appear in search results and on social media platforms.
PlanFeaturesAvailableSetPrimaryCustomDomain String Allows setting a specific custom domain as the site's primary URL.
PlanFeaturesAvailableSFTP String Enables secure file transfer (SFTP) access for uploading, editing, and managing site files.
PlanFeaturesAvailableSimplePayments String Enables Simple Payments buttons for accepting direct payments or donations through posts and pages.
PlanFeaturesAvailableSitePreviewLinks String Allows creating shareable preview links for draft posts and pages before publishing.
PlanFeaturesAvailableSocialEnhancedPublishing String Improves social sharing options with advanced scheduling and post formatting tools.
PlanFeaturesAvailableSocialImageGenerator String Automatically generates optimized social media images when sharing posts.
PlanFeaturesAvailableSocialPreviews String Shows real-time previews of how posts appear on social media feeds before publishing.
PlanFeaturesAvailableSpaceUpgradedStorage String Provides increased media storage capacity beyond the default plan limit.
PlanFeaturesAvailableSSH String Grants SSH access for secure command-line management of the site's hosting environment.
PlanFeaturesAvailableStagingSites String Allows creating and managing staging environments to test changes safely before going live.
PlanFeaturesAvailableStatsCommercial String Provides enhanced analytics and commercial-grade reporting on site performance and engagement.
PlanFeaturesAvailableStatsPaid String Includes advanced statistics and reporting features available to paid plans.
PlanFeaturesAvailableStudioSync String Supports synchronization between local WordPress Studio environments and the live site.
PlanFeaturesAvailableSubscriberUnlimitedImports String Allows importing an unlimited number of subscribers for newsletters or memberships.
PlanFeaturesAvailableSubscriptioNGifting String Enables gifting of site subscriptions or memberships to other users.
PlanFeaturesAvailableUpgradedUploadFiletypes String Expands allowed upload types beyond default WordPress file extensions.
PlanFeaturesAvailableUploadAudioFiles String Allows uploading, storing, and embedding audio files directly into site content.
PlanFeaturesAvailableUploadPlugins String Permits uploading and installing custom plugin ZIP files.
PlanFeaturesAvailableUploadThemes String Permits uploading and activating custom theme ZIP files.
PlanFeaturesAvailableUploadVideoFiles String Allows uploading, storing, and embedding video files within posts and pages.
PlanFeaturesAvailableVideoHosting String Provides dedicated video hosting services for faster playback and higher quality streaming.
PlanFeaturesAvailableVideopress String Enables VideoPress integration for optimized video delivery and privacy control.
PlanFeaturesAvailableVideopressVideo String Includes the VideoPress block and features for embedding videos from the VideoPress library.
PlanFeaturesAvailableWhatsappButton String Adds a WhatsApp contact or share button for posts and pages.
PlanFeaturesAvailableWoop String Includes WooCommerce Payments features for processing online transactions.
PlanFeaturesAvailableWordAds String Enables WordAds, allowing the site to display and monetize ads.
PlanFeaturesAvailableWordAdsJetpack String Extends WordAds monetization to Jetpack-connected self-hosted sites.
IsPlanFree Bool Indicates whether the current plan is the free version.
PlanLicenseKey String The license key associated with the site's active plan or product.
PlanProductID Int Unique identifier for the active product or plan.
PlanProductName String Full name of the plan or product assigned to the site.
PlanProductNameShort String Short display name of the current plan.
PlanProductSlug String Slug identifier for the plan used in API calls and URLs.
IsPlanUserOwner Bool Indicates whether the current user is the owner of the site's plan.
ProductsAggregate String Lists all products, add-ons, or services currently active for this site.
Isa4aClient Bool True if the site is an Automattic for Agencies (A4A) client deployment managed under the A4A program.
Isa4aDevSite Bool True if the site is an A4A development instance used for testing or staging.
IsCoreSiteEditorEnabled Bool Indicates whether the WordPress core Site Editor (block editor) is enabled.
IsDeleted Bool True if the site has been flagged as deleted or removed from active use.
IsFSEActive Bool True if Full Site Editing features are currently active.
IsFSEEligible Bool True if the site supports Full Site Editing based on theme compatibility and environment.
IsWPcomAtomic Bool True if the site is hosted on WordPress.com's Atomic infrastructure.
IsWPcomStagingSite Bool True if the site is a staging instance hosted on WordPress.com.
JetpackModulesAggregate String A list of active Jetpack modules enabled on this site.
LaunchStatus String Describes the site's launch state, such as launched, prelaunch, or coming soon.
QuotaPercentUsed Double Percentage of total storage space currently used by the site.
QuotaSpaceAllowed Long Total amount of storage space allocated to the site, in bytes.
QuotaSpaceAvailable Long Amount of unused storage space remaining, in bytes.
QuotaSpaceUsed Int Total amount of storage currently in use, in bytes.
SiteMigration String Information about migration history or transfer data for this site.
UpdatesAggregate String Details of available updates for WordPress core, themes, plugins, or languages.
UserInteractionsAggregate String Aggregated metrics of user activity or engagement on the site.
WasEcommerceTrial Bool True if the site previously used an eCommerce trial plan.
WasHostingTrial Bool True if the site previously used a hosting trial plan.
WasMigrationTrial Bool True if the site previously used a migration trial plan.
WasUpgradedFromTrial Bool True if the site was upgraded from a trial plan to a paid subscription.
WPComSiteSetup String Unique identifier for the site's WordPress.com setup flow or environment.
ZendeskSiteMetaAddonAggregate String Metadata describing Zendesk add-ons linked to the site.
ZendeskSiteMetaPlan String Metadata describing the Zendesk plan associated with the site.

CData Cloud

SiteSearchTerms

Query the SiteSearchTerms in Wordpress.

Table Specific Information

SELECT

The Cloud uses the WordPress API to process some of the filters.

  • Period supports the '=' comparison.
  • Date supports the '=' comparison.
  • Summarize supports the '=' comparison.

The Cloud processes other filters client-side within the Cloud.

For example, the following queries are processed server side.

SELECT * FROM SiteSearchTerms WHERE Period='day'

Columns

Name Type References Description
Period String The reporting period covered by the returned search statistics (for example, day, week, or month).
SummaryEncryptedSearchTerms Int The total count of encrypted or anonymized search terms, representing searches where the original keywords are not available.
SummarySearchTerms String A list of the top search terms entered by site visitors during the reporting period.
SummaryOtherSearchTerms Int The number of less-frequent search terms grouped under 'Other' in the summary results.
SummaryTotalSearchTerms Int The total number of unique search terms recorded for the period, including summarized and encrypted terms.
DaysAggregate String An array showing daily search activity and corresponding search terms for each date (omitted when summarize=true).
Date Date The most recent date for which search term statistics are available.

Pseudo-Columns

Pseudo-column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the data returned by the operation.

Name Type Description
HasSummarize Boolean Indicates whether the results are summarized instead of showing detailed daily data.
NumofPeriods Int Specifies how many reporting periods are included in the returned results.

CData Cloud

SiteShortCodesRender

Get a rendered shortcode for a site

Table Specific Information

SELECT

The Cloud uses the WordPress API to process some of the filters.

  • Shortcode supports the '=' comparison.

The Cloud processes other filters client-side within the Cloud. For example, the following queries are processed server side:

SELECT * FROM SiteShortCodesRender WHERE Shortcode = 'short_code_string'
SELECT * FROM SiteShortCodesRender WHERE Shortcode = '[gallery]'

Columns

Name Type References Description
Shortcode String The shortcode string submitted for rendering, typically including attributes or parameters as used in post content.
Result String The rendered HTML output generated from the provided shortcode.
ScriptsAggregate String A list of JavaScript dependencies required to properly render and display the shortcode output.
StylesAggregate String A list of CSS stylesheets needed to apply the correct formatting and styling to the rendered shortcode content.

CData Cloud

SitesPageTemplates

Get a list of page templates supported by a site.

Table Specific Information

SELECT

The Cloud processes all the filters client-side within the Cloud.

SELECT * FROM SitesPageTemplates

Columns

Name Type References Description
Label String The display name of the page template as shown in the WordPress editor template selection menu.
File String The file name or path of the page template file on the site (for example, page-contact.php or templates/about.php).

CData Cloud

SiteStats

Query the SiteStats in Wordpress.

Table Specific Information

SELECT

The Cloud processes all the filters client-side within the Cloud.

SELECT * FROM SiteStats

Columns

Name Type References Description
Date Date The date the statistics snapshot was taken.
StatsCategories Int The total number of distinct categories created in the site.
StatsComments Int The total number of comments posted across all site content.
StatsCommentsMostActiveRecentDay String The most recent day when the site received the highest number of comments.
StatsCommentsMostActiveTime String The time of day when the site typically receives the most comments.
StatsCommentsPerMonth Int The average number of comments received each month.
StatsCommentsSpam Int The total number of comments flagged as spam.
StatsFollowersBlog Int The number of followers subscribed to the blog.
StatsFollowersComments Int The number of comments made by followers.
StatsPosts Int The total number of posts published on the site.
StatsShares Int The total number of content shares across all supported platforms.
StatsSharesFacebook Int The number of times content was shared on Facebook.
StatsSharesPressThis Int The number of times content was shared using the WordPress Press This bookmarklet.
StatsSharesTwitter Int The number of times content was shared on Twitter.
StatsTags Int The total number of unique tags applied to posts.
StatsViews Int The cumulative number of views across all posts and pages on the site.
StatsViewsBestDay String The date when the site received the highest number of views in a single day.
StatsViewsBestDayTotal Int The total number of views recorded on the site's best-performing day.
StatsViewsToday Int The total number of views recorded so far today.
StatsViewsYesterday Int The total number of views recorded on the previous day.
StatsVisitors Int The cumulative number of unique visitors who have accessed the site.
StatsVisitorsToday Int The number of unique visitors who have accessed the site today.
StatsVisitorsYesterday Int The number of unique visitors who accessed the site on the previous day.
VisitsDataAggregate String A collection of daily visitor and view counts, used to analyze traffic trends over time.
VisitsDate Date The specific date for which the visit data is reported.
VisitsFieldsAggregate String The set of metrics tracked for each recorded visit, such as views and visitors.
VisitsUnit String The time unit used for reporting visit data, typically measured on a daily basis.

CData Cloud

SiteStatsReferrers

Query the SiteStatsReferrers in Worpress.

Table Specific Information

SELECT

The Cloud uses the WordPress API to process some of the filters.

  • Date supports the '=' comparison.
  • Period supports the '=' comparison.
  • Summarize supports the '=' comparison.

The Cloud processes other filters client-side within the Cloud.

For example, the following queries are processed server side.

SELECT * FROM SiteStatsReferrers WHERE Date='2025-05-14'
SELECT * FROM SiteStatsReferrers WHERE Period='month';

Columns

Name Type References Description
Date Date The most recent date for which referrer statistics are available.
GroupsAggregate String A list of referrer groups, where each entry represents a referring website, platform, or source domain that directed traffic to the site.
OtherViews Int The total number of views from referrers not included in the main groups, such as uncommon or unidentified traffic sources.
TotalViews Int The total number of views generated from all referrers, including both grouped and uncategorized sources.
DaysAggregate String A collection of daily referral data showing how views changed over time (omitted when summarize=true).
Period String The reporting period covered by the returned statistics, such as 'day', 'week', or 'month'.

Pseudo-Columns

Pseudo-column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the data returned by the operation.

Name Type Description
HasSummarize Boolean Indicates whether the summarize parameter is supported for this dataset.
NumofPeriods Int Specifies how many time periods are included in the result set.

CData Cloud

SiteStatsSummary

Query the SiteStatsSummary in Wordpress.

Table Specific Information

SELECT

The Cloud uses the WordPress API to process some of the filters.

  • Date supports the '=' comparison.
  • Period supports the '=' comparison.

The Cloud processes other filters client-side within the Cloud.

For example, the following queries are processed server side.

SELECT * FROM SiteStatsSummary where Date='2025-05-08'

Columns

Name Type References Description
Comments Int The total number of comments received during the specified reporting period.
Date Date The date marking the most recent point in the reporting period for which statistics are returned.
Followers Int The cumulative number of users following the site.
Likes Int The total number of likes recorded during the specified reporting period.
Period String The time range covered by the statistics, such as day, week, or month.
Reblogs Int The total number of times posts were reblogged during the specified reporting period.
Views Int The total number of views recorded during the specified reporting period, up to the given date.
Visitors Int The total number of unique visitors who accessed the site during the specified reporting period, up to the given date.

CData Cloud

SiteStatsTags

Get the SiteStatsTags for a blog.

Table Specific Information

SELECT

The Cloud processes all the filters client-side within the Cloud.

SELECT * FROM SiteStatsTags;

Columns

Name Type References Description
Date Datetime The most recent date for which tag statistics are available.
TagsAggregate String A collection of tag data, where each entry includes details such as the tag name, post count, and related metrics.

CData Cloud

SiteStatsVideo

Query the SiteStatsVideo in Wordpress.

Table Specific Information

SELECT

The Cloud uses the WordPress API to process some of the filters.

  • PostID supports the '=' comparison.

The Cloud processes other filters client-side within the Cloud.

For example, the following queries are processed server side.

SELECT * FROM SiteStatsVideo WHERE PostID=21

Columns

Name Type References Description
PostID [KEY] Int The unique identifier of the video post.
PostName String The slug or name assigned to the video post.
PostParent Int The identifier of the parent post, if this post is part of a hierarchy.
PostPassword String The password required to access the post, if it is password-protected.
PostStatus String The publication status of the post, such as publish, draft, or private.
PostTitle String The title of the video post.
PostType String The content type of the post, such as post, page, or a custom post type like video or product.
FieldsAggregate String A collection of field definitions that describe the structure of the returned data.
DataAggregate String A collection of video-related statistics, including views, plays, and engagement data.
PagesAggregate String A list of pages on which the video appears or is embedded.
PostCommentCount String The total number of comments made on the post.
PostCommentStatus String Indicates whether comments are open or closed for the post.
PostFilter String Specifies how the post content is filtered before being returned.
PostGuid String The globally unique identifier (GUID) for the post, typically used internally by WordPress.
PostMenuOrder Int The numeric value used to determine the post's position in manual sorting or custom menus.
PostPermaLink String The full public URL where the post can be viewed in a browser.
PostPingStatus String Indicates whether pingbacks and trackbacks are allowed for the post.
PostPinged String A list of URLs that have already been pinged by this post.
PostAuthor String The user ID or username of the author who created the post.
PostContent String The full content of the post, including HTML or text formatting.
PostContentFiltered String A filtered version of the post content after WordPress or plugins apply transformations.
PostDate Datetime The date and time the post was created, in the site's local timezone.
PostDateGmt Datetime The creation date and time of the post in Greenwich Mean Time (GMT).
PostExcerpt String A short summary or excerpt of the post content.
PostMimeType String The Multipurpose Internet Mail Extensions (MIME) type of the post, used mainly for media attachments such as videos.
PostModified Datetime The date and time when the post was last modified, in the site's local timezone.
PostModifiedGmt Datetime The last modified date and time of the post in GMT.
PostToPing String A list of URLs to notify (ping) when the post is published.

CData Cloud

SiteTopAuthors

Query the SiteTopAuthors in Wordpress.

Table Specific Information

SELECT

The Cloud uses the WordPress API to process some of the filters.

  • Date supports the '=' comparison.
  • Period supports the '=' comparison.
  • Summarize supports the '=' comparison.

The Cloud processes other filters client-side within the Cloud.

For example, the following queries are processed server side.

SELECT * FROM SiteTopAuthors WHERE Date='2025-05-08' AND Period='day'

Columns

Name Type References Description
Date Date The most recent date for which author statistics are available.
DaysAggregate String A collection of daily author view data, showing how many views each author received per day (omitted when summarize=true).
SummaryAggregate String A summary of total author views aggregated over the selected period (omitted when summarize=false).
Period String The time interval represented by the statistics, such as day, week, or month.

Pseudo-Columns

Pseudo-column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the data returned by the operation.

Name Type Description
HasSummarize Boolean Indicates whether the SiteTopAuthors results include summarized data.
NumofPeriods Int The number of reporting periods included in the results.

CData Cloud

SiteTopComments

Query the SiteTopComments in Wordpress.

Table Specific Information

SELECT

The Cloud processes all the filters client-side within the Cloud.

SELECT * FROM SiteTopComments

Columns

Name Type References Description
Authors String A list of the top comment authors ranked by activity.
Date Date The most recent date for which comment statistics are available.
MonthlyComments Int The average number of comments received per month.
MostActiveDay String The day of the week when the site receives the highest comment activity.
MostActiveTime String The time of day when comment activity is at its peak.
MostCommentedPost String A list of posts that have received the highest number of comments.
Posts String A collection of posts included in the comment analysis.
TotalComments Int The total number of comments recorded during the selected reporting period.

CData Cloud

SiteTopPostsStats

Query the SiteTopPostsStats in Wordpress.

Table Specific Information

SELECT

The Cloud uses the WordPress API to process some of the filters.

  • Date supports the '=' comparison.
  • Period supports the '=' comparison.
  • Summarize supports the '=' comparison.

The Cloud processes other filters client-side within the Cloud.

For example, the following queries are processed server side.

SELECT * FROM SiteTopPostsStats WHERE Date='2025-05-08' AND Period='day'

Columns

Name Type References Description
Date Date The most recent date for which post view statistics are available.
DaysAggregate String A collection of daily post view data, showing how many views each post received on specific days (omitted when summarize=true).
SummaryAggregate String A summary of post view totals aggregated across the selected reporting period (omitted when summarize=false).
Period String The reporting interval for which statistics are returned, such as day, week, or month.

Pseudo-Columns

Pseudo-column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the data returned by the operation.

Name Type Description
HasSummarize Boolean Indicates whether the SiteTopPostsStats results include summarized data.
NumofPeriods Int The number of reporting periods included in the returned statistics.

CData Cloud

SiteTotalViewsforPost

Query the SiteTotalViewsforPost in Wordpress.

Table Specific Information

SELECT

The Cloud uses the WordPress API to process some of the filters.

  • ID supports the '=', 'IN' comparisons.
  • Date supports the '=' comparison.

The Cloud processes other filters client-side within the Cloud.

For example, the following queries are processed server side.

SELECT * FROM SiteTotalViewsforPost WHERE ID=21
SELECT * FROM SiteTotalViewsforPost WHERE ID IN (21,66)

Columns

Name Type References Description
ID [KEY] Int The unique identifier of the post whose view count is being reported.
Views Int The total number of times the post has been viewed across all tracked periods.
Date Date The most recent date for which the post view statistics are available.

CData Cloud

SiteVideoPlays

Query the SiteVideoPlays in Wordpress.

Table Specific Information

SELECT

The Cloud uses the WordPress API to process some of the filters.

  • Date supports the '=' comparison.
  • Period supports the '=' comparison.

The Cloud processes other filters client-side within the Cloud.

For example, the following queries are processed server side.

SELECT * FROM SiteVideoPlays where Date='2025-05-08' 
SELECT * FROM SiteVideoPlays where Period='day'

Columns

Name Type References Description
Date Date The most recent date for which video play statistics are returned.
DaysAggregate String A collection of daily video play data showing how many times videos were played on specific days.
period String The reporting interval for which statistics are returned, such as day, week, or month.

Pseudo-Columns

Pseudo-column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the data returned by the operation.

Name Type Description
NumofPeriods Int The number of reporting periods included in the results.

CData Cloud

SiteWordAdsEarnings

List the SiteWordAdsEarnings for the WordPressOnline website.

Table Specific Information

SELECT

The Cloud processes all the filters client-side within the Cloud.

SELECT * FROM SiteWordAdsEarnings

Columns

Name Type References Description
Id [KEY] Int The unique identifier of the site associated with the earnings data.
Name String The display name or title of the WordPress site.
ItemURL String The full URL of the site whose earnings are being reported.
EarningsTotalEarnings Int The total amount of revenue the site has earned through WordAds and related programs.
EarningsTotalAmountOwed Int The remaining balance owed to the site owner based on total earnings and payouts.
EarningsWordAdsAggregate String A collection of detailed earnings data from WordAds advertisements displayed on the site.
EarningsSponsoredAggregate String A collection of earnings data from sponsored posts and content partnerships.
EarningsAdjustmentAggregate String A collection of adjustments applied to earnings, such as refunds, chargebacks, or manual corrections.

CData Cloud

SiteWordAdsStats

List the SiteWordAdsStats for the WordPressOnline website.

Table Specific Information

SELECT

The Cloud uses the WordPress API to process some of the filters.

  • Date supports the '=' comparison.
  • Unit supports the '=' comparison.

The Cloud processes other filters client-side within the Cloud.

For example, the following queries are processed server side.

SELECT * FROM SiteWordAdsStats
SELECT * FROM SiteWordAdsStats where Date='2024-08-19 11:42:25.0'
SELECT * FROM SiteWordAdsStats where Unit='day'

Columns

Name Type References Description
Date Date The date for which WordAds performance metrics are reported.
Unit String The reporting interval or unit of measurement, such as day, week, or month.

The allowed values are day, week, month.

Fields String A list of the statistical fields included in the report, such as impressions, clicks, and earnings.
DataAggregate String A collection of WordAds performance data organized by date, reflecting traffic and revenue trends over time.

CData Cloud

StatHighlights

Query the StatHighlights for a site in Wordpress.

Table Specific Information

SELECT

The Cloud processes all the filters client-side within the Cloud.

SELECT * FROM StatHighlights

Columns

Name Type References Description
PastSevenDaysComments Int The total number of comments received in the past seven days.
PastSevenDaysLikes Int The total number of likes received in the past seven days.
PastSevenDaysRangeEnd Date The end date of the most recent seven-day reporting period for your WordPress site statistics.
PastSevenDaysRangeStart Date The start date of the most recent seven-day reporting period for your WordPress site statistics.
PastSevenDaysViews Int The total number of views recorded in the past seven days.
PastSevenDaysVisitors Int The total number of unique visitors during the past seven days.
BetweenPastEightAndFifteenDaysComments Int The total number of comments received between eight and fifteen days ago.
BetweenPastEightAndFifteenDaysLikes Int The total number of likes received between eight and fifteen days ago.
BetweenPastEightAndFifteenDaysRangeEnd Date The end date of the eight-to-fifteen-day reporting period for your WordPress site statistics.
BetweenPastEightAndFifteenDaysRangeStart Date The start date of the eight-to-fifteen-day reporting period for your WordPress site statistics.
BetweenPastEightAndFifteenDaysViews Int The total number of views recorded between eight and fifteen days ago.
BetweenPastEightAndFifteenDaysVisitors Int The total number of unique visitors between eight and fifteen days ago.
PastThirtyDaysComments Int The total number of comments received during the past thirty days.
PastThirtyDaysLikes Int The total number of likes received during the past thirty days.
PastThirtyDaysRangeEnd Date The end date of the most recent thirty-day reporting period for your WordPress site statistics.
PastThirtyDaysRangeStart Date The start date of the most recent thirty-day reporting period for your WordPress site statistics.
PastThirtyDaysViews Int The total number of views recorded during the past thirty days.
PastThirtyDaysVisitors Int The total number of unique visitors during the past thirty days.
BetweenPastThirtyOneAndSixtyDaysComments Int The total number of comments received between thirty-one and sixty days ago.
BetweenPastThirtyOneAndSixtyDaysLikes Int The total number of likes received between thirty-one and sixty days ago.
BetweenPastThirtyOneAndSixtyDaysRangeEnd Date The end date of the thirty-one-to-sixty-day reporting period for your WordPress site statistics.
BetweenPastThirtyOneAndSixtyDaysRangeStart Date The start date of the thirty-one-to-sixty-day reporting period for your WordPress site statistics.
BetweenPastThirtyOneAndSixtyDaysViews Int The total number of views recorded between thirty-one and sixty days ago.
BetweenPastThirtyOneAndSixtyDaysVisitors Int The total number of unique visitors between thirty-one and sixty days ago.

CData Cloud

SubscriberPosts

List the SubscriberPosts for the WordPressOnline website.

Table Specific Information

SELECT

The Cloud uses the WordPress API to process some of the filters.

  • PostID supports the '=' comparison.

The Cloud processes other filters client-side within the Cloud.

For example, the following queries are processed server side.

SELECT * FROM SubscriberPosts where PostID=21

Columns

Name Type References Description
PostID [KEY] Int

Posts.ID

The unique identifier of the post associated with the subscription.
Subscriptions String Details about the user's subscription to the specified post, including follow status or notification preferences.

CData Cloud

SubscriptionCount

Get the SubscriptionCount for a blog.

Table Specific Information

SELECT

The Cloud processes all the filters client-side within the Cloud.

SELECT * FROM SubscriptionCount;

Columns

Name Type References Description
Blogs Int The total number of WordPress sites the user is currently subscribed to.
Comments Int The total number of comment threads the user is following across subscribed sites.
Pending Int The number of subscriptions awaiting confirmation or approval.

CData Cloud

TaxonomyPostType

Get a list of taxonomies associated with a post type.

Table Specific Information

SELECT

The Cloud uses the WordPress API to process some of the filters.

  • PostType supports the '=' comparison.

The Cloud processes other filters client-side within the Cloud.

For example, the following queries are processed server side.

SELECT * FROM TaxonomyPostType where PostType='Post_type_string'

Columns

Name Type References Description
PostType [KEY] String The post type associated with the taxonomy (for example, post, page, or a custom post type).
Name [KEY] String The internal name (slug) of the taxonomy.
IsPublic Bool Indicates whether the taxonomy is publicly visible and queryable through the WordPress REST API.
Description String A short explanation describing the purpose of the taxonomy.
IsHierarchical Bool Specifies whether the taxonomy supports parent-child term relationships, such as categories.
Label String The main label used to identify the taxonomy in the WordPress admin interface.
LabelsAddNewItem String The label displayed for adding a new item in this taxonomy.
LabelsAddorRemoveItems String The label shown when adding or removing taxonomy terms.
LabelsAllItems String The label used to display all available taxonomy terms.
LabelsBacktoItems String The label displayed for navigation back to the taxonomy list.
LabelsChoosefromMostUsed String The label used for choosing from the most frequently used terms.
LabelsDescFieldDescription String Descriptive text shown beneath the taxonomy's description field.
LabelsEditItem String The label displayed when editing an existing taxonomy term.
LabelsFilterbyItem String The label used for filtering items by taxonomy term in the admin interface.
LabelsItemLink String The label for the term link field within the taxonomy editor.
LabelsItemLinkDescription String A description shown below the item link field in the taxonomy editor.
LabelsItemsList String The label for the taxonomy's item list view in the admin area.
LabelsItemsListNavigation String The label used for navigation controls in the item list view.
LabelsMenuName String The label displayed in the admin menu for the taxonomy.
LabelsMostUsed String The label used for the most frequently used taxonomy terms.
LabelsName String The plural display name for the taxonomy.
LabelsNameAdminBar String The label shown in the WordPress admin bar for quick taxonomy access.
LabelsNameFieldDescription String A short description displayed under the name input field in the taxonomy editor.
LabelsNewItemName String The label shown for entering a new taxonomy term name.
LabelsNoTerms String The label displayed when no terms exist in this taxonomy.
LabelsNotFound String The label displayed when no matching taxonomy terms are found.
LabelsParentFieldDescription String Descriptive text shown beneath the parent term field for hierarchical taxonomies.
LabelsParentItem String The label for selecting the parent taxonomy term.
LabelsParentItemColon String The label for the parent taxonomy term followed by a colon (used in some admin layouts).
LabelsPopularItems String The label for the section listing popular taxonomy terms.
LabelsSearchItems String The label used for the taxonomy term search field.
LabelsSeparateItemsWithCommas String The instructional label for separating multiple taxonomy terms with commas.
LabelsSingularName String The singular display name for the taxonomy.
LabelsSlugFieldDescription String A description displayed below the slug input field in the taxonomy editor.
LabelsTemplateName String The label for selecting a taxonomy template, if applicable.
LabelsUpdateItem String The label displayed when updating a taxonomy term.
LabelsViewItem String The label for viewing a taxonomy term on the front end.
CapabilitiesAssignTerms String The capability required to assign existing taxonomy terms to posts.
CapabilitiesDeleteTerms String The capability required to delete taxonomy terms.
CapabilitiesEditTerms String The capability required to edit taxonomy terms.
CapabilitiesManageTerms String The capability required to manage taxonomy terms, including creating and assigning them.

CData Cloud

TopTags

Get a filtered list of top tags, grouped by letter.

Table Specific Information

SELECT

The Cloud processes all the filters client-side within the Cloud.

SELECT * FROM TopTags;

Columns

Name Type References Description
ID [KEY] String The unique identifier assigned to the tag.
Title String The display title of the tag, often matching its name in WordPress.
DisplayName String The name of the tag as shown to site visitors or readers.
Slug String The URL-friendly version of the tag name, used in permalinks and API requests.
Description String A brief summary or explanation of what the tag represents.
ItemURL String The full URL to the tag's archive page on the site.

Pseudo-Columns

Pseudo-column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the data returned by the operation.

Name Type Description
Alphabet String The alphabet letter used to group or sort tags for display.

CData Cloud

TrendingTags

Get a list of trending tags.

Table Specific Information

SELECT

The Cloud uses the WordPress API to process some of the filters.

  • Count supports the '=' comparison.

The Cloud processes other filters client-side within the Cloud.

For example, the following queries are processed server side.

SELECT * FROM TrendingTags
SELECT * FROM TrendingTags where Count=10

Columns

Name Type References Description
TagID [KEY] Int The unique numeric identifier assigned to the tag.
TagsTitle String The display title of the tag, often matching its WordPress name.
TagDisplayName String The name of the tag as shown to site visitors or readers.
TagsSlug String The URL-friendly version of the tag name, used in permalinks and API requests.
TagDescription String A short description or summary that explains what the tag represents.
ItemURL String The full URL linking to the tag's archive page or listing on the site.
Count Int The total number of posts or items associated with this tag.

CData Cloud

UserBillingHistory

Query the Billing History in Wordpress.

Table Specific Information

SELECT

The Cloud processes all the filters client-side within the Cloud.

SELECT * FROM UserBillingHistory

Columns

Name Type References Description
Id [KEY] String The unique identifier for the billing record.
Address String The billing address associated with the user's account.
Amount String The total billed amount, including the currency symbol.
AmountInteger Int The billed amount expressed in the smallest currency unit (for example, cents).
BillingHistoryTotal Int The total number of billing records available for the user.
Date Datetime The date and time when the transaction occurred.
CCDisplayBrand String The display name or brand of the credit card used for the transaction.
CCEmail String The email address linked to the credit card account.
CCName String The name of the credit card holder.
CCNum String The masked credit card number displayed for reference.
CCType String The type or category of credit card used (for example, Visa or MasterCard).
Credit String The amount of credit or discount applied to this transaction.
Currency String The three-letter currency code used for the transaction (for example, USD or EUR).
Desc String A description of the billing item or service charged.
Icon String The resource path or URL for the icon image representing the billing item.
Items String A list of items or services included in the billing transaction.
Org String The organization responsible for issuing the billing or payment request.
PayPart String The payment partner or processor used to complete the transaction.
PayRef String The reference or charge ID from the payment processor for this transaction.
Service String The platform, product, or service associated with the billed item.
ServiceSlug String A URL- and code-friendly version of the service name.
Subtotal String The subtotal amount displayed in readable currency format before taxes or additional fees.
SubtotalInteger Int The subtotal amount represented in the smallest currency unit (for example, cents).
Support String The URL to the customer support page related to this billing item or service.
Tax String The total amount of tax charged for this transaction.
TaxCountryCode String The ISO country code for the country where the tax was applied.
TaxExternalId String The external tax ID or reference code associated with the applied tax.
TaxInteger Int The taxed amount represented in the smallest currency unit (for example, cents).
TaxVendorInfo String Metadata or response details returned by the third-party tax service provider.
UpcomingCharges String The total amount scheduled for the next billing or renewal period.
ItemURL String The full URL linking to this billing record in the user's billing history.
Volume String The quantity of items or units included in this billing record.

CData Cloud

UserFollowedPosts

List the UserFollowedPosts for the WordPressOnline website.

Table Specific Information

SELECT

The Cloud uses the WordPress API to process some of the filters.

  • DateRangeAfter supports the '<', '>' comparisons.
  • DateRangeBefore supports the '<', '>' comparisons.

The Cloud processes other filters client-side within the Cloud.

For example, the following queries are processed server side.

SELECT * FROM UserFollowedPosts
SELECT * FROM UserFollowedPosts where DateRangeBefore<'2025-05-08'

Columns

Name Type References Description
DateRangeAfter Datetime Filters followed posts to include only those published after this date and time.
DateRangeBefore Datetime Filters followed posts to include only those published before this date and time.
Number Int The total number of followed posts returned in the query.
Posts String An array containing details about each post the user follows, including title, ID, and publication metadata.

CData Cloud

UserFollowingFeeds

Query the info about the user following feeds.

Table Specific Information

SELECT

The Cloud processes all the filters client-side within the Cloud.

SELECT * FROM UserFollowingFeeds

Columns

Name Type References Description
ID [KEY] String The unique identifier assigned to the user's feed subscription.
BlogID String The unique ID of the WordPress site associated with the followed feed.
DateSubscribed Datetime The date and time when the user subscribed to the feed.
Url String The full URL of the followed site or blog feed.

CData Cloud

UserLikedPosts

List the UserLikedPosts for the WordPressOnline website.

Table Specific Information

SELECT

The Cloud uses the WordPress API to process some of the filters.

  • DateRangeAfter supports the '<', '>' comparisons.
  • DateRangeBefore supports the '<', '>' comparisons.

The Cloud processes other filters client-side within the Cloud.

For example, the following queries are processed server side.

SELECT * FROM UserLikedPosts
SELECT * FROM UserLikedPosts where where DateRangeBefore<'2025-05-08'

Columns

Name Type References Description
DateRangeAfter Datetime Filters liked posts to include only those created after this date and time.
DateRangeBefore Datetime Filters liked posts to include only those created before this date and time.
Number Int The total number of liked posts returned in the query.
Posts String An array containing details about each post the user has liked, including title, ID, and publication information.

CData Cloud

UserLikes

Query the info about the posts liked by the user.

Table Specific Information

SELECT

The Cloud processes all the filters client-side within the Cloud.

SELECT * FROM UserLikes

Columns

Name Type References Description
PostID [KEY] String The unique identifier of the post that was liked by the user.
SiteID String The unique identifier of the WordPress site where the liked post is published.
Added Datetime The date and time when the like action was recorded.
MetaSelf String Metadata describing the user's like action, such as the like ID and related user context.
MetaHelp String Metadata containing available actions, permissions, or related help links for managing likes.
MetaLikes String A list of all users who have liked the same post, including their basic profile details.
MetaPost String Comprehensive details about the liked post, such as its title, author, and publication status.
MetaSite String Metadata about the WordPress site hosting the post, including site name, URL, and post statistics.

CData Cloud

UserPreferences

Update and List the UserPreferences for the WordPressOnline website.

Table Specific Information

SELECT

The Cloud processes all the filters client-side within the Cloud.

SELECT * FROM UserPreferences;

Columns

Name Type References Description
CalypsoPreferencesColorScheme String The user's selected color scheme for the WordPress.com (Calypso) interface.
CanCalypsoPreferencesDismissibleCardDismissibleCardA8cForAgenciesSites Bool Indicates whether the user has dismissed the ‘Agencies Sites' informational card in Calypso.
CanCalypsoPreferencesHasSeenReaderOnboarding Bool Whether the user has completed or viewed the Reader onboarding experience.
CanCalypsoPreferencesHelpCenterOpen Bool Indicates whether the Help Center panel in the Calypso interface is currently expanded or collapsed.
CanCalypsoPreferencesIsNewReader Bool Shows whether the user is flagged as new to the WordPress Reader.
CalypsoPreferencesRecentSites String A list of recently accessed WordPress site identifiers for quick navigation.
CanCalypsoPreferencesSidebarCollapsed Bool Indicates whether the Calypso left sidebar is currently collapsed or expanded in the user interface.
CanCalypsoPreferencesSiteManagementPanelDismiss Bool Specifies whether the Site Management panel was dismissed by the user.
CalypsoPreferencesSiteManagementPanelTimestamp Long The timestamp recording when the Site Management panel was last dismissed.
CalypsoPreferencesSitesSorting String Defines the sorting order of sites displayed in the Calypso site list (for example, by name or last updated).

CData Cloud

UserSitesPosts

List the UserSitesPosts for the WordPressOnline website.

Table Specific Information

SELECT

The Cloud uses the WordPress API to process some of the filters.

  • AuthorId supports the '=' comparison.
  • Status supports the '=' comparison.

The Cloud processes other filters client-side within the Cloud.

For example, the following queries are processed server side.

SELECT * FROM UserSitesPosts
SELECT * FROM UserSitesPosts where AuthorId = 21

Columns

Name Type References Description
ID [KEY] Int The unique identifier of the post.
SiteID [KEY] Int The unique identifier of the WordPress site the post belongs to.
AuthorAvatarURL String The URL of the author's avatar image.
IsAuthorEmailAvailable Boolean Indicates whether the author's email address is available.
AuthorFirstName String The author's first name.
AuthorID Int The unique identifier of the post author.
AuthorLastName String The author's last name.
AuthorLogin String The author's WordPress login name.
AuthorName String The display name of the author, typically shown on posts and comments.
AuthorNiceName String A URL-friendly version of the author's display name.
AuthorProfileURL String The full URL to the author's public WordPress profile.
AuthorSiteID Int The unique identifier of the author's primary WordPress site.
AuthorURL String The author's website or profile URL.
Date Datetime The date and time the post was created, in the site's local timezone.
Modified Datetime The date and time the post was last updated.
Title String The title of the post.
URL String The full permalink URL to the post.
ShortURL String The WordPress shortlink (wp.me) version of the post URL.
Content String The full content of the post, in HTML or plain text format.
Excerpt String A short excerpt or summary of the post content.
Slug String The post's slug — the URL-friendly name used in its permalink.
Guid String The globally unique identifier (GUID) for the post.
Status String The publication status of the post, such as publish, draft, or private.
IsSticky Boolean Indicates whether the post is marked as sticky (pinned to the top of the blog).
Password String The password required to view the post, if it is password protected.
HasParent Boolean Indicates whether the post has a parent (for hierarchical post types).
Type String The post type, such as post, page, or a registered custom type.
DiscussionCommentCount Int The total number of comments associated with the post.
DiscussionCommentStatus String The current comment status, such as open or closed.
HasDiscussionCommentsOpen Boolean Indicates whether new comments can be added to the post.
DiscussionPingStatus String The pingback or trackback status for the post.
HasDiscussionPingsOpen Boolean Indicates whether pingbacks or trackbacks are allowed.
HasLikesEnabled Boolean Indicates whether the post can receive likes.
HasSharingEnabled Boolean Indicates whether social sharing buttons are enabled for this post.
LikeCount Int The total number of likes the post has received.
ILike Boolean Indicates whether the current user has liked the post.
IsFollowing Boolean Indicates whether the current user follows the blog containing this post.
IsReblogged Boolean Indicates whether the current user has reblogged this post.
GlobalID String A unique WordPress.com-wide identifier for the post.
FeaturedImage String The URL of the post's featured image, if available.
PostThumbnail String The attachment object representing the post's featured image.
Format String The post format, such as standard, image, quote, video, or gallery.
HasGeo Boolean Indicates whether the post includes geolocation data.
MenuOrder Int The order value used to arrange pages hierarchically or in menus.
PageTemplate String The page template assigned to this post, if applicable.
PublicizeURLsAggregates String An array of URLs to posts shared via connected Publicize services (for example, Facebook).
CategoriesAggregates String A collection of categories assigned to the post, keyed by category name.
TermsCategoryAggregates String A taxonomy mapping that lists category terms applied to the post.
TermsPostTagAggregates String A taxonomy mapping that lists tag terms applied to the post.
TermsPostFormatAggregates String A taxonomy mapping that lists post format terms applied to the post.
TermsMentionsAggregates String A taxonomy mapping that lists mention terms applied to the post.
TagsAggregates String A collection of tags applied to the post, keyed by tag name.
Attachments String A list of attachment objects (keyed by attachment ID), limited to the most recent 20 items.
AttachmentCount Int The total number of media attachments associated with this post.
MetadataAggregates String A collection of post metadata key-value pairs.
HasCapabilitiesDeletePost String Indicates whether the current user has permission to delete the post.
HasCapabilitiesEditPost String Indicates whether the current user has permission to edit the post.
HasCapabilitiesPublishPost String Indicates whether the current user has permission to publish the post.

CData Cloud

UserSubscribedTags

Get a list of tags subscribed to by the user

Table Specific Information

SELECT

The Cloud processes all the filters client-side within the Cloud.

SELECT * FROM UserSubscribedTags

Columns

Name Type References Description
ID [KEY] String The unique identifier of the tag the user is subscribed to.
Title String The title of the tag as it appears in WordPress.
DisplayName String The display name of the tag shown to users in the Reader or Tag pages.
Slug String The URL-friendly version of the tag name used in permalinks.
Description String A short description or summary of the tag's purpose or topic.
ItemURL String The full URL linking to the tag's public page on WordPress.com.

CData Cloud

VideoPoster

Get the poster for a specified VideoPress video.

Table Specific Information

SELECT

The Cloud uses the WordPress API to process some of the filters.

  • VideoGUID supports the '=' comparison.

The Cloud processes other filters client-side within the Cloud.

For example, the following queries are processed server side.

SELECT * FROM VideoPoster where VideoGUID='guid_string'

Columns

Name Type References Description
VideoGUID [KEY] String

Videos.Id

The globally unique identifier (GUID) of the video associated with the poster image.
Poster String The URL of the image used as the video's poster or preview thumbnail.
IsPosterImageGenerating Bool Indicates whether the poster image is currently being generated (true) or has already been created and is available (false).

CData Cloud

VideopressChapter

Get the chapters for a specified VideoPress video of the WordPressOnline website.

Table Specific Information

SELECT

The Cloud uses the WordPress API to process some of the filters.

  • GUID supports the '=' comparison.

The Cloud processes other filters client-side within the Cloud.

For example, the following queries are processed server side.

SELECT * FROM videopresschapter where GUID='529DrhwH';

Columns

Name Type References Description
Description String A brief description or title of the video chapter segment.
Start Int The start time (in seconds) marking when this chapter begins within the video.
End Int The end time (in seconds) marking when this chapter segment finishes.
Guid String The globally unique identifier (GUID) of the video used to retrieve chapter details for the specified VideoPress video.

CData Cloud

Videos

Get the metadata for a specified VideoPress video.

Table Specific Information

SELECT

The Cloud uses the WordPress API to process some of the filters.

  • VideoGUID supports the '=' comparison.

The Cloud processes other filters client-side within the Cloud.

For example, the following queries are processed server side.

SELECT * FROM Videos where VideoGUID='guid_string'

Columns

Name Type References Description
GUID [KEY] String The globally unique identifier (GUID) assigned to the video.
Title String The title of the video as displayed in the media library or post editor.
Description String A short summary or description of the video's content.
width Integer The width of the video frame in pixels.
Height Integer The height of the video frame in pixels.
Duration Integer The total playback length of the video, measured in milliseconds.
HasDisplayEmbed Boolean Indicates whether the video embed menu is visible to viewers.
HasAllowDownload Boolean Specifies whether viewers can download the video from the player interface.
Rating String The video's content rating, if applicable.
Poster String The URL of the image displayed as the video's poster or preview thumbnail.
Original String The URL of the original, uncompressed video file.
Watermark String The URL of a watermark or logo overlay applied to the video.
BgColor String The custom background color used in the video player.
BlogId String The unique identifier of the WordPress site where the video was uploaded.
PostId Integer The post ID of the video attachment or associated post.
IsPrivate Boolean Indicates whether the video is private and restricted to authorized viewers.
PrivacySetting Integer The numeric value representing the video's privacy level or access control setting.
HasPrivateEnabledForSite Boolean Indicates whether private video mode is enabled for the site.
UploadDate Datetime The date and time the video was uploaded, in ISO 8601 format.
HasVideoTranscodingFinished Boolean Indicates whether the video transcoding process has completed.
Subtitles String A list of available subtitle or caption files, including languages and formats.
TracksAggregate String A collection of auxiliary media tracks, such as subtitles or metadata tracks, linked to the video.
AdaptiveStreaming String The HLS (HTTP Live Streaming) URL used for adaptive bitrate playback.
IsThumbnailGenerating Boolean Indicates whether thumbnail grid generation is currently in progress.
FilesAggregate String A list of available video file formats and their corresponding file names.
FileUrlBaseHttp String The base HTTP URL structure used to generate video file links.
FileUrlBaseHttps String The base HTTPS URL structure used to generate video file links.
PrivacyDetailsAggregate String Additional metadata describing the video's privacy configuration.
FilesStatusAggregate String Status information for each video file format during or after transcoding.
FormatMetaAggregate String Technical metadata describing each encoded video format.
ThumbnailsGridAggregate String Detailed information about the generated video thumbnail grid.

CData Cloud

Stored Procedures

Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT/INSERT/UPDATE/DELETE operations with WordPress.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from WordPress, along with an indication of whether the procedure succeeded or failed.

CData Cloud - WordPress Stored Procedures

Name Description
ActivateWidgets Activates widgets on a WordPress site by updating their configuration and status.
CreateMedia Creates a new media item, such as an image, video, or document, and uploads it to the WordPress.com Media Library for use in posts or pages.
DeleteTracks Deletes tracking or activity records from WordPress.
FollowSpecifiedBlog Allows the user to follow a specific WordPress blog by providing its blog Id or URL.
LikeAComment Adds a like to a specific WordPress comment and updates the like count accordingly.
LikeAPost Adds a like to a specific WordPress post and updates the post's like count accordingly.
MarkNotificationAsRead Mark the user's notifications as read, updating their status in WordPress.com so they no longer appear as new or unread.
PostCounts Get number of posts in the post type groups by post status.
ReblogPost Reblog a post.
RecentNotificationSeenTimestamp Set the timestamp of the most recently seen notification.
RemoveLikeFromComment Remove like from a comment.
ReplytoAnotherComment Create a comment as a reply to another comment.
ReportReferrerAsSpam Report a referrer as spam.
RestorePosts Restore multiple posts
RestorePoststoPreviousStatus Restore a post or page from the trash to its previous status.
SendTwoStepCode Sends a two-step code via SMS to the current user.
SiteEmbeds Sends a two-step code via SMS to the current user.
SiteRenderedEmbeds Like a comment.
SiteShortCodes Get a list of shortcodes available on a site. Note: The current user must have publishing access.
SubscribeNewTag Subscribe to a new tag.
UnFollowSpecifiedBlog Follow the specified blog.
UnLikeAPost UnLike a post.
UnReportReferrerAsSpam Unreport a referrer as spam.
UnsubscribeTag Unsubscribe to a tag.
WordAdsApproved Request streamlined approval to join the WordAds program.

CData Cloud

ActivateWidgets

Activates widgets on a WordPress site by updating their configuration and status.

Table Specific Information

Execute

Sends a two-step code via SMS to the current user.

Note: To activate a widget, you must specify the IdBase column. <

EXEC ActivateWidgets IdBase='"text"';

Input

Name Type Description
IdBase String The base identifier for the widget type in WordPress, such as 'text' or 'recent-posts'.
Sidebar String The identifier of the sidebar where this widget is active. If empty, the widget is added in the first sidebar available. This field is optional.
Position Integer Specifies the position in which the widget appears within the assigned sidebar. This field is optional.
SettingsAggregate String Contains the widget's configuration data, stored as aggregated settings returned by WordPress. This field is optional.

Result Set Columns

Name Type Description
Success String Indicates whether the operation was successful or not.
Id String The unique identifier for the widget instance being activated.
IdBase String The base identifier for the widget type in WordPress, such as 'text' or 'recent-posts'.
Position Integer Specifies the position in which the widget appears within the assigned sidebar. This field is optional.
SideBar String The identifier of the sidebar where this widget is active. If empty, the widget is added in the first sidebar available. This field is optional.
SettingsAggregate String Contains the widget's configuration data, stored as aggregated settings returned by WordPress. This field is optional.

CData Cloud

CreateMedia

Creates a new media item, such as an image, video, or document, and uploads it to the WordPress.com Media Library for use in posts or pages.

Table Specific Information

Execute

Upload a new piece of media.

Note: To Upload a new piece of media, you must specify the Media column.

EXEC CreateMedia Media='"C:\\Users\\Downloads\\cdata.png"';

Input

Name Type Description
FileLocation String The path or URL of the file to be uploaded to the WordPress Media Library.
MediaUrls String The URL or list of URLs for the media items uploaded to WordPress.
Title String The title assigned to the media item in WordPress.
Description String The description text for the media item in WordPress.
Caption String The caption text to display with the media item in WordPress.
ParentId String The identifier of the post or page the media item is attached to in WordPress.
FileName String The file name assigned to the uploaded media item in WordPress.

Result Set Columns

Name Type Description
Success String Indicates whether the operation was successful or not.
Media String An array of uploaded media objects representing the files added to the WordPress Media Library.

CData Cloud

DeleteTracks

Deletes tracking or activity records from WordPress.

Stored Procedure Specific Information

Execute

Call this procedure to delete an existing subtitle/caption track for a specified VideoPress video. To delete an existing subtitle/caption track for a specified VideoPress video, you must specify the following columns: GUID, Kind, and SrcLang. For example:

EXEC DeleteTracks GUID='529DrhwH', Kind='"subtitles"', SrcLang='"en"';

Input

Name Type Description
GUID String The globally unique identifier of the tracking record to be deleted.
Kind String The type or category of the tracking record being deleted, such as a view or click event.
SrcLang String The source language code associated with the tracking record to be deleted.

Result Set Columns

Name Type Description
Success String Indicates whether the WordPress operation completed successfully.
Deleted Boolean Indicates whether the tracking record was successfully deleted from WordPress.

CData Cloud

FollowSpecifiedBlog

Allows the user to follow a specific WordPress blog by providing its blog Id or URL.

Stored Procedure Specific Information

Execute

Call this procedure to follow the specified blog. To follow the specified blog, you must specify the following column: BlogUrl. A successful authentication is also required. For example:

EXEC FollowSpecifiedBlog BlogUrl='http://ramaarya.blog';

Input

Name Type Description
BlogUrl String The URL of the blog to follow.

Result Set Columns

Name Type Description
Success String Indicates whether the operation to follow the specified WordPress blog was successful.
Subscribed Boolean Indicates whether the user successfully subscribed to the specified WordPress blog.
Info String Provides additional details or messages returned by WordPress about the follow operation.
SubscriptionId Integer The unique identifier of the WordPress subscription created for the followed blog.
SubscriptionBlogId Integer The unique identifier of the WordPress blog that was followed.
SubscriptionURL String he URL of the WordPress blog that was followed.
SubscriptionDateSubscribed String The date and time when the user subscribed to the specified WordPress blog.
SubscriptionFeedId String The unique identifier of the feed associated with the blog subscription.
DeliveryMethodsEmailSendPosts Boolean Indicates whether new posts from the followed blog are sent by email.
DeliveryMethodsEmailSendComments Boolean Indicates whether new comment notifications from the followed blog are sent by email.
DeliveryMethodsEmailPostDeliveryFrequency String The frequency at which email notifications for new posts are sent.
DeliveryMethodsEmailDateSubscribed Datetime The date and time when the user subscribed to receive email notifications from the followed blog
NotificationSendPosts Boolean Indicates whether the user receives notifications for new posts from the followed blog.
MetaAggregate String Aggregated metadata for the follow subscription returned by the WordPress API.

CData Cloud

LikeAComment

Adds a like to a specific WordPress comment and updates the like count accordingly.

Stored Procedure Specific Information

Execute

Call this procedure to like a comment. To like a comment, you must specify the following column: CommentId. A successful authentication is also required. For example:

EXEC LikeAComment CommentId=80;

Input

Name Type Description
CommentId Integer The unique identifier of the WordPress comment being liked.

Result Set Columns

Name Type Description
Success String Indicates whether the like action for the specified comment completed successfully.
ILike Boolean Indicates whether the current user has liked the comment.
LikeCount Integer The total number of likes the comment has received in WordPress.
MetaAggregate String Aggregated metadata for the comment like action returned by the WordPress API.

CData Cloud

LikeAPost

Adds a like to a specific WordPress post and updates the post's like count accordingly.

Input

Name Type Description
PostId Integer The unique identifier of the WordPress post being liked.

Result Set Columns

Name Type Description
Success String Indicates whether the like action for the specified post completed successfully.
PostId Integer The unique identifier of the WordPress post being liked.
SiteId Integer The unique identifier of the WordPress site where the liked post is hosted.
ILike Boolean The unique identifier of the user who liked the post.
LikerId Integer The unique identifier of the user who liked the post.
LikerLogin String The WordPress username of the user who liked the post.
LikerEmail String The email address of the user who liked the post.
LikerName String The display name of the user who liked the post.
LikerFirstName String The first name of the user who liked the post.
LikerLastName String The last name of the user who liked the post.
LikerNiceName String The URL-friendly version of the liker's display name used in profile URLs.
LikerURL String The website URL associated with the user who liked the post.
LikerAvatarURL String The URL of the avatar image for the user who liked the post.
LikerProfileURL String The URL of the WordPress profile page for the user who liked the post.
LikerIPAddress String The IP address associated with the user who liked the WordPress post.
LikerSiteId Int The unique identifier of the WordPress site associated with the user who liked the post.
LikerSiteVisibile Boolean Indicates whether the liker's WordPress site is publicly visible.
LikerDefaultAvatar Boolean Indicates whether the user who liked the post is using the default WordPress avatar image.
MetaAggregate String Aggregated metadata for the post like action returned by the WordPress API.

CData Cloud

MarkNotificationAsRead

Mark the user's notifications as read, updating their status in WordPress.com so they no longer appear as new or unread.

Stored Procedure Specific Information

Execute

Call this procedure to mark a set of notifications as read. To mark a set of notifications as read, you must specify the following column: Count. A successful authentication is also required. For example:

EXEC MarkNotificationAsRead Count='{\"123456\":\"1\"}';

Input

Name Type Description
Count String Specifies the number of notifications to mark as read for the current user.

Result Set Columns

Name Type Description
Success String Indicates whether the operation to mark notifications as read completed successfully.
Updated String Returns the IDs of notifications that were updated and now marked as read.

CData Cloud

PostCounts

Get number of posts in the post type groups by post status.

Stored Procedure Specific Information

Execute

Call this procedure to get number of posts in the post type groups by post status. To get number of posts in the post type groups by post status, you must specify the following column: PostType. For example:

EXEC PostCounts PostType='post';

Input

Name Type Description
PostType String Specifies the WordPress post type to analyze, such as post, page, or custom post type.

Result Set Columns

Name Type Description
Success String Indicates whether the post count retrieval operation completed successfully.
CountsAllPublish String Returns the total number of published posts across all users for the specified post type.
CountsAllDraft String Returns the total number of draft posts across all users for the specified post type.
CountsMinePublish String Returns the total number of published posts created by the current authenticated user.

CData Cloud

ReblogPost

Reblog a post.

Stored Procedure Specific Information

Execute

Call this procedure to reblog a post. To reblog a post, you must specify the following column: PostId. A successful authentication is also required. For example:

EXECUTE ReblogPost PostId='166';

Input

Name Type Description
PostId Integer The unique identifier of the WordPress post to be reblogged.

Result Set Columns

Name Type Description
Success String Indicates whether the reblog operation completed successfully.
Id Integer The unique identifier assigned to the newly created reblogged post.
CanReblog String Indicates whether the post is eligible to be reblogged by any WordPress user.
CanUserReblog Boolean Indicates whether the authenticated user has permission to reblog the specified post.
IsReblogged Boolean Shows whether the authenticated user has already reblogged this post.
MetaAggregate String Contains metadata and response details returned from the WordPress API related to the reblog operation.

CData Cloud

RecentNotificationSeenTimestamp

Set the timestamp of the most recently seen notification.

Stored Procedure Specific Information

Execute

Call this procedure to set the timestamp of the most recently seen notification. To set the timestamp of the most recently seen notification, you must specify the following column: Time. A successful authentication is also required. For example:

EXEC RecentNotificationSeenTimestamp Time='1746934534';

Input

Name Type Description
Time String The UNIX timestamp representing the most recent notification seen by the user on their WordPress client.

Result Set Columns

Name Type Description
Success String Indicates whether the request to update or retrieve the notification timestamp completed successfully.
LastSeenTime Datetime The UNIX timestamp showing when the user last viewed their notifications in WordPress.

CData Cloud

RemoveLikeFromComment

Remove like from a comment.

Stored Procedure Specific Information

Execute

Call this procedure to remove your like from a comment. To remove your like from a comment, you must specify the following column: CommentId. A successful authentication is also required. For example:

EXEC RemoveLikeFromComment CommentId=80;

Input

Name Type Description
CommentId Int The unique identifier of the comment from which the like is removed.

Result Set Columns

Name Type Description
Success String Indicates whether the request to remove the like was completed successfully.
ILike Boolean Indicates whether the authenticated user currently likes the comment after the operation.
LikeCount Integer The total number of likes the comment has after the operation.
MetaAggregate String Contains metadata and response details returned by the WordPress API for the unlike operation.

CData Cloud

ReplytoAnotherComment

Create a comment as a reply to another comment.

Stored Procedure Specific Information

Execute

Call this procedure to create a comment as a reply to another comment. To create a comment as a reply to another comment, you must specify the following columns: CommentId and Content. A successful authentication is also required. For example:

EXEC ReplytoAnotherComment CommentId=80,Content='\"testing123\"';

Input

Name Type Description
CommentId Integer The CommentId.
Content String The comment text.

Result Set Columns

Name Type Description
Success String Indicates whether the operation was successful or not.
Id Integer The comment ID.
PostId Integer The post ID.
PostTitle String The post title.
PostType String The post type.
PostLink String The post link.
AuthorId Integer The author id.
AuthorLogin String The author login.
AuthorEmail String The author email.
AuthorName String The author name.
AuthorFirstName String The author first name.
AuthorLastName String The author last name.
AuthorNiceName String The author nice name.
AuthorURL String The author URL.
AuthorAvatarURL String The author Avatar URL.
AuthorProfileURL String The author Profile URL.
AuthorIPAddress String The author IP Address.
AuthorSiteId Integer The author site ID.
AuthorSiteVisible Boolean The author site Visible.
AuthorNiceName String The author nice name.
Date Datetime Date.
URL String Url.
ShortURL String Short Url.
Content String Content.
RawContent String Content.
Status String Status.
ParentId String parentId.
ParentType String parenttype.
ParentLink String parentlink.
Type String Type for the comment.
LikeCount Integer Like Count for the comment.
Ilike Boolean ILike for the comment.
MetaAggregate String MetaAggregate for the comment.
CanModerate Boolean CanModerate for the comment.
IReplied Boolean IReplied for the comment.

CData Cloud

ReportReferrerAsSpam

Report a referrer as spam.

Stored Procedure Specific Information

Execute

Call this procedure to report a referrer as spam. To report a referrer as spam, you must specify the following column: Domain. A successful authentication is also required. For example:

EXEC ReportReferrerAsSpam Domain='testingra.wordpress.com';

Input

Name Type Description
Domain String The domain name of the referrer site being reported as spam.

Result Set Columns

Name Type Description
Success String Indicates whether the request to flag the referrer domain as spam was processed successfully.

CData Cloud

RestorePosts

Restore multiple posts

Stored Procedure Specific Information

Execute

Call this procedure to restore mulitple posts. To restore a post, you must specify the following column: PostId. A successful authentication is also required. For example:

EXECUTE RestorePosts PostId='6'

Input

Name Type Description
PostIds String A comma-separated list of post IDs to restore from the trash.

Result Set Columns

Name Type Description
Success String Indicates whether the request to restore the specified post or posts was completed successfully.
Id Integer The unique identifier of the restored post.
SiteId Integer The unique identifier of the WordPress site the restored post belongs to.
AuthorId Integer The unique identifier of the user who authored the restored post.
AuthorLogin String The login name of the post author.
AuthorEmail String The email address of the post author.
AuthorName String The display name of the post author.
AuthorFirstName String The first name of the post author.
AuthorLastName String The last name of the post author.
AuthorNiceName String A URL-friendly version of the author's username.
AuthorURL String The author's website URL associated with the post.
AuthorAvatarURL String The URL to the author's avatar image.
AuthorProfileURL String The profile or Gravatar URL of the post author.
Date Date The date and time when the post was originally created, in the site's timezone.
Modified Datetime The date and time when the post was last modified after restoration.
Title String The title of the restored post.
URL String The permalink URL of the restored post.
ShortURL String The WordPress shortlink (wp.me) for the restored post.
Content String The full HTML content of the restored post.
Excerpt String The excerpt or summary text of the restored post.
Slug String The URL-friendly name (slug) for the restored post.
Guid String The globally unique identifier (GUID) for the restored post.
Status String The current publication status of the restored post, such as publish, draft, or private.
Sticky String Indicates whether the restored post is marked as sticky on the site.
Password String The password protecting the post, if applicable.
Parent String The ID of the parent post, if this post is a child page or revision.
Type String The post type, such as post, page, or custom type.
DiscussionCommentsOpen String Indicates whether comments are open for the restored post.
DiscussionCommentStatus String The moderation status of comments on the post, such as open or closed.
DiscussionPingsOpen String Indicates whether pingbacks and trackbacks are open for the post.
DiscussionPingStatus String The current pingback status of the post.
LikesEnabled String Indicates whether likes are enabled for the post.
SharingEnabled String Indicates whether sharing options are enabled for the post.
LikeCount String The number of likes the restored post currently has.
ILike String Indicates whether the authenticated user has liked the post.
IsReblogged String Indicates whether the authenticated user has reblogged this post.
IsFollowing String Indicates whether the authenticated user follows the site hosting this post.
GlobalId String A unique WordPress.com-wide identifier for the restored post.
FeaturedImage String The URL of the featured image for the post, if one is assigned.
PostThumbnail String Metadata or attachment object representing the post's featured image.
Format String The post format, such as standard, video, gallery, or quote.
Geo String Geolocation data associated with the post, if available.
MenuOrder String The order of the post relative to others of the same type.
PageTemplate String The page template applied to the post, if it is a page.
PublicizeURLs String A list of URLs where the post has been shared through Publicize integrations.
Terms String A collection of taxonomy terms associated with the post.
Tags String The tags assigned to the restored post.
Categories String The categories assigned to the restored post.
Attachments String A list of media attachments associated with the post.
AttachmentCount String The total number of attachments linked to the restored post.
Metadata String Custom metadata fields and values for the restored post.
Meta String Additional metadata returned from the WordPress API.
Capabilities String Permissions or capabilities associated with the post, such as edit or delete rights.
Revisions String A list of previous revisions available for the restored post.
OtherURLs String Additional URLs related to the post, such as alternate views or API endpoints.

CData Cloud

RestorePoststoPreviousStatus

Restore a post or page from the trash to its previous status.

Stored Procedure Specific Information

Execute

Call this procedure to restore a post or page from the trash to its previous status.

The only required column is PostId, which must reference a valid post in the trash. A successful authentication is also required.

EXECUTE RestorePoststoPreviousStatus PostId=6 

Input

Name Type Description
PostId Integer The unique identifier of the post to restore to its previous status.

Result Set Columns

Name Type Description
Success String Indicates whether the request to restore the post to its previous status was completed successfully.
Id Integer The unique identifier of the restored post.
SiteId Integer The unique identifier of the WordPress site that owns the restored post.
AuthorId Integer The unique identifier of the user who authored the restored post.
AuthorLogin String The login name of the post author.
AuthorEmail String The email address of the post author.
AuthorName String The display name of the post author.
AuthorFirstName String The first name of the post author.
AuthorLastName String The last name of the post author.
AuthorNiceName String A URL-friendly version of the author's username.
AuthorURL String The website URL provided by the post author.
AuthorAvatarURL String The URL to the author's avatar image.
AuthorProfileURL String The profile or Gravatar URL of the post author.
Date Date The original date and time when the post was created, in the site's timezone.
Modified Datetime The date and time when the post was last modified after being restored.
Title String The title of the restored post.
URL String The permalink URL of the restored post.
ShortURL String The WordPress shortlink (wp.me) for the restored post.
Content String The full HTML content of the restored post.
Excerpt String The excerpt or summary of the restored post.
Slug String The URL-friendly slug used for the restored post.
Guid String The globally unique identifier (GUID) of the restored post.
Status String The post's restored publication status, such as publish, draft, or private.
Sticky String Indicates whether the restored post is marked as sticky.
Password String The password protecting the post, if applicable.
Parent String The ID of the parent post, if this post is part of a hierarchy.
Type String The post type, such as post, page, or custom type.
DiscussionCommentsOpen String Indicates whether comments are open for the restored post.
DiscussionCommentStatus String The current moderation status of comments on the post.
DiscussionPingsOpen String Indicates whether pingbacks and trackbacks are open for the post.
DiscussionPingStatus String The pingback status of the post.
LikesEnabled String Indicates whether likes are enabled for the post.
SharingEnabled String Indicates whether sharing options are enabled for the post.
LikeCount String The total number of likes for the restored post.
ILike String Indicates whether the authenticated user has liked the post.
IsReblogged String Indicates whether the authenticated user has reblogged the post.
IsFollowing String Indicates whether the authenticated user follows the site hosting the post.
GlobalId String A unique WordPress.com-wide identifier for the restored post.
FeaturedImage String The URL of the featured image assigned to the restored post.
PostThumbnail String The attachment object representing the post's featured image.
Format String The post format, such as standard, gallery, quote, video, or audio.
Geo String Geolocation data associated with the restored post, if available.
MenuOrder String The order of the post relative to others of the same type.
PageTemplate String The page template applied to the post, if it is a page.
PublicizeURLs String A list of URLs where the post has been shared through connected Publicize services.
Terms String The taxonomy terms associated with the post.
Tags String The tags applied to the restored post.
Categories String The categories assigned to the restored post.
Attachments String A list of media attachments linked to the post.
AttachmentCount String The total number of media attachments associated with the post.
Metadata String Custom metadata fields and their values associated with the post.
Meta String Additional metadata details returned from the WordPress API.
Capabilities String The user's permissions related to this post, such as edit or delete rights.
Revisions String A list of available revisions for the restored post.
OtherURLs String Additional URLs associated with the post, such as alternate endpoints or feeds.

CData Cloud

SendTwoStepCode

Sends a two-step code via SMS to the current user.

Table Specific Information

Execute

Sends a two-step code via SMS to the current user.

There are no required columns to run the stored procedure, only a succesful authentication is required.

EXECUTE SendTwoStepCode 

Result Set Columns

Name Type Description
Success String Indicates whether the two-step verification request was completed successfully.
Sent Boolean Indicates whether the verification code was successfully sent to the user's registered device or contact method.

CData Cloud

SiteEmbeds

Sends a two-step code via SMS to the current user.

Stored Procedure Specific Information

Execute

Call this procedure to get a list of embeds available on a site. Note: The current user must have publishing access. To get a list of embeds available on a site, the following quey can be executed: For example:

EXEC SiteEmbeds;

Result Set Columns

Name Type Description
Success String Indicates whether the embed retrieval operation completed successfully.
Embeds String Contains the list or details of embedded items retrieved for the specified site, such as media, posts, or external content.

CData Cloud

SiteRenderedEmbeds

Like a comment.

Stored Procedure Specific Information

Execute

Call this procedure to get a rendered embed for a site. Note: The current user must have publishing access. To get a rendered embed for a site, you must specify the following column: EmbedUrl. For example:

EXEC SiteRenderedEmbeds EmbedUrl='https://www.youtube.com/watch?v=dQw4w9WgXcQ';

Input

Name Type Description
EmbedUrl String The query-string–encoded embed URL to render. Only one URL can be submitted per request.

Result Set Columns

Name Type Description
Success String Indicates whether the embed rendering operation completed successfully.
EmbedUrl String The embed URL that was processed for rendering.
Result String The rendered HTML output generated from the specified embed URL.

CData Cloud

SiteShortCodes

Get a list of shortcodes available on a site. Note: The current user must have publishing access.

Stored Procedure Specific Information

Execute

Call this procedure to get a list of shortcodes available on a site. Note: The current user must have publishing access. To get a list of shortcodes available on a site, the following quey can be executed: For example:

EXEC SiteShortCodes;

Result Set Columns

Name Type Description
Success String Indicates whether the shortcode retrieval operation completed successfully.
ShortCodes String Returns a list of all supported shortcodes available for the site, identified by their shortcode handles.

CData Cloud

SubscribeNewTag

Subscribe to a new tag.

Stored Procedure Specific Information

Execute

Call this procedure to subscribe to a new tag. To subscribe to a new tag, you must specify the following column: Slug. A successful authentication is also required. For example:

EXEC SubscribeNewTag Slug='tagsome';

Input

Name Type Description
Slug String The slug (URL-friendly name) of the tag to subscribe to.

Result Set Columns

Name Type Description
Success String Indicates whether the tag subscription request completed successfully.
Subscribed Boolean Returns true if the tag was successfully added to the user's subscription list.
AddedTag String The unique identifier of the newly subscribed tag.
TagsAggregate String A collection of tags currently subscribed to by the user.

CData Cloud

UnFollowSpecifiedBlog

Follow the specified blog.

Stored Procedure Specific Information

Execute

Call this procedure to unfollow the specified blog. To unfollow the specified blog, you must specify the following column: BlogUrl. A successful authentication is also required. For example:

EXEC UnfollowSpecifiedBlog BlogUrl='http://ramaarya.blog';

Input

Name Type Description
BlogUrl String The full URL of the blog that the user wants to unfollow.

Result Set Columns

Name Type Description
Success String Indicates whether the unfollow request completed successfully.
Subscribed Boolean Indicates whether the user is still subscribed to the blog after the operation.
Info String Additional details about the unfollowed blog, such as its name or status.

CData Cloud

UnLikeAPost

UnLike a post.

Input

Name Type Description
PostId Integer The unique identifier of the post to unlike.

Result Set Columns

Name Type Description
Success String Indicates whether the unlike operation completed successfully.
PostId Integer The unique identifier of the post affected by the operation.
SiteId Integer The unique identifier of the site the post belongs to.
ILike Boolean Indicates whether the current user still likes the post after the operation.
LikerId Integer The unique identifier of the user who performed the unlike action.
LikerLogin String The WordPress login name of the user who performed the unlike action.
LikerEmail String The email address associated with the user who performed the unlike action.
LikerName String The display name of the user who performed the unlike action.
LikerFirstName String The first name of the user who performed the unlike action.
LikerLastName String The last name of the user who performed the unlike action.
LikerNiceName String The user's nice name, used for URL-friendly profile references.
LikerURL String The URL associated with the user's account or personal site.
LikerAvatarURL String The direct link to the user's avatar image.
LikerProfileURL String The full URL to the user's public WordPress.com profile.
LikerIPAddress String The IP address of the user who performed the unlike action.
LikerSiteId String The unique site identifier associated with the user.
LikerSiteVisible Boolean Indicates whether the user's site is publicly visible.
LikerDefaultAvatar Boolean Specifies whether the default avatar is being used for the user.
MetaAggregate String An array of metadata returned for the unliked post, including contextual details.

CData Cloud

UnReportReferrerAsSpam

Unreport a referrer as spam.

Stored Procedure Specific Information

Execute

Call this procedure to unreport a referrer as spam. To unreport a referrer as spam, you must specify the following column: Domain. A successful authentication is also required. For example:

EXEC UnreportReferrerAsSpam Domain='testingra.wordpress.com';

Input

Name Type Description
Domain String The domain name of the referrer to remove from the spam report list.

Result Set Columns

Name Type Description
Success String Indicates whether the referrer was successfully unreported as spam.

CData Cloud

UnsubscribeTag

Unsubscribe to a tag.

Stored Procedure Specific Information

Execute

Call this procedure to unsubscribe from a tag. To unsubscribe from a tag, you must specify the following column: Slug. A successful authentication is also required. For example:

EXEC UnsubscribeTag Slug='tagsome';

Input

Name Type Description
Slug String The slug (URL-friendly name) of the tag that the user wants to unsubscribe from.

Result Set Columns

Name Type Description
Success String Indicates whether the unsubscribe operation completed successfully.
Subscribed Boolean Indicates whether the user is still subscribed to the tag after the operation.
RemovedTag String The unique identifier of the tag that was unsubscribed.
TagsAggregate String An array of tags associated with the user's subscriptions after the operation.

CData Cloud

WordAdsApproved

Request streamlined approval to join the WordAds program.

Table Specific Information

Execute

Request streamlined approval to join the WordAds program.

There are no required columns to run the stored procedure, only a succesful authentication is required.

EXECUTE WordAdsApproved 

Result Set Columns

Name Type Description
Success String Indicates whether the WordAds approval request was processed successfully.
Approved Boolean Confirms that the site has been approved and is now eligible to display WordAds.

CData Cloud

System Tables

You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.

Schema Tables

The following tables return database metadata for WordPress:

  • sys_catalogs: Lists the available databases.
  • sys_schemas: Lists the available schemas.
  • sys_tables: Lists the available tables and views.
  • sys_tablecolumns: Describes the columns of the available tables and views.
  • sys_procedures: Describes the available stored procedures.
  • sys_procedureparameters: Describes stored procedure parameters.
  • sys_keycolumns: Describes the primary and foreign keys.
  • sys_indexes: Describes the available indexes.

Data Source Tables

The following tables return information about how to connect to and query the data source:

  • sys_connection_props: Returns information on the available connection properties.
  • sys_sqlinfo: Describes the SELECT queries that the Cloud can offload to the data source.

Query Information Tables

The following table returns query statistics for data modification queries:

  • sys_identity: Returns information about batch operations or single updates.

CData Cloud

sys_catalogs

Lists the available databases.

The following query retrieves all databases determined by the connection string:

SELECT * FROM sys_catalogs

Columns

Name Type Description
CatalogName String The database name.

CData Cloud

sys_schemas

Lists the available schemas.

The following query retrieves all available schemas:

          SELECT * FROM sys_schemas
          

Columns

Name Type Description
CatalogName String The database name.
SchemaName String The schema name.

CData Cloud

sys_tables

Lists the available tables.

The following query retrieves the available tables and views:

          SELECT * FROM sys_tables
          

Columns

Name Type Description
CatalogName String The database containing the table or view.
SchemaName String The schema containing the table or view.
TableName String The name of the table or view.
TableType String The table type (table or view).
Description String A description of the table or view.
IsUpdateable Boolean Whether the table can be updated.

CData Cloud

sys_tablecolumns

Describes the columns of the available tables and views.

The following query returns the columns and data types for the Categories table:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Categories' 

Columns

Name Type Description
CatalogName String The name of the database containing the table or view.
SchemaName String The schema containing the table or view.
TableName String The name of the table or view containing the column.
ColumnName String The column name.
DataTypeName String The data type name.
DataType Int32 An integer indicating the data type. This value is determined at run time based on the environment.
Length Int32 The storage size of the column.
DisplaySize Int32 The designated column's normal maximum width in characters.
NumericPrecision Int32 The maximum number of digits in numeric data. The column length in characters for character and date-time data.
NumericScale Int32 The column scale or number of digits to the right of the decimal point.
IsNullable Boolean Whether the column can contain null.
Description String A brief description of the column.
Ordinal Int32 The sequence number of the column.
IsAutoIncrement String Whether the column value is assigned in fixed increments.
IsGeneratedColumn String Whether the column is generated.
IsHidden Boolean Whether the column is hidden.
IsArray Boolean Whether the column is an array.
IsReadOnly Boolean Whether the column is read-only.
IsKey Boolean Indicates whether a field returned from sys_tablecolumns is the primary key of the table.
ColumnType String The role or classification of the column in the schema. Possible values include SYSTEM, LINKEDCOLUMN, NAVIGATIONKEY, REFERENCECOLUMN, and NAVIGATIONPARENTCOLUMN.

CData Cloud

sys_procedures

Lists the available stored procedures.

The following query retrieves the available stored procedures:

          SELECT * FROM sys_procedures
          

Columns

Name Type Description
CatalogName String The database containing the stored procedure.
SchemaName String The schema containing the stored procedure.
ProcedureName String The name of the stored procedure.
Description String A description of the stored procedure.
ProcedureType String The type of the procedure, such as PROCEDURE or FUNCTION.

CData Cloud

sys_procedureparameters

Describes stored procedure parameters.

The following query returns information about all of the input parameters for the SelectEntries stored procedure:

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SelectEntries' AND Direction = 1 OR Direction = 2

To include result set columns in addition to the parameters, set the IncludeResultColumns pseudo column to True:

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SelectEntries' AND IncludeResultColumns='True'

Columns

Name Type Description
CatalogName String The name of the database containing the stored procedure.
SchemaName String The name of the schema containing the stored procedure.
ProcedureName String The name of the stored procedure containing the parameter.
ColumnName String The name of the stored procedure parameter.
Direction Int32 An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters.
DataType Int32 An integer indicating the data type. This value is determined at run time based on the environment.
DataTypeName String The name of the data type.
NumericPrecision Int32 The maximum precision for numeric data. The column length in characters for character and date-time data.
Length Int32 The number of characters allowed for character data. The number of digits allowed for numeric data.
NumericScale Int32 The number of digits to the right of the decimal point in numeric data.
IsNullable Boolean Whether the parameter can contain null.
IsRequired Boolean Whether the parameter is required for execution of the procedure.
IsArray Boolean Whether the parameter is an array.
Description String The description of the parameter.
Ordinal Int32 The index of the parameter.
Values String The values you can set in this parameter are limited to those shown in this column. Possible values are comma-separated.
SupportsStreams Boolean Whether the parameter represents a file that you can pass as either a file path or a stream.
IsPath Boolean Whether the parameter is a target path for a schema creation operation.
Default String The value used for this parameter when no value is specified.
SpecificName String A label that, when multiple stored procedures have the same name, uniquely identifies each identically-named stored procedure. If there's only one procedure with a given name, its name is simply reflected here.
IsCDataProvided Boolean Whether the procedure is added/implemented by CData, as opposed to being a native WordPress procedure.

Pseudo-Columns

Name Type Description
IncludeResultColumns Boolean Whether the output should include columns from the result set in addition to parameters. Defaults to False.

CData Cloud

sys_keycolumns

Describes the primary and foreign keys.

The following query retrieves the primary key for the Categories table:

         SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Categories' 
          

Columns

Name Type Description
CatalogName String The name of the database containing the key.
SchemaName String The name of the schema containing the key.
TableName String The name of the table containing the key.
ColumnName String The name of the key column.
IsKey Boolean Whether the column is a primary key in the table referenced in the TableName field.
IsForeignKey Boolean Whether the column is a foreign key referenced in the TableName field.
PrimaryKeyName String The name of the primary key.
ForeignKeyName String The name of the foreign key.
ReferencedCatalogName String The database containing the primary key.
ReferencedSchemaName String The schema containing the primary key.
ReferencedTableName String The table containing the primary key.
ReferencedColumnName String The column name of the primary key.

CData Cloud

sys_foreignkeys

Describes the foreign keys.

The following query retrieves all foreign keys which refer to other tables:

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
          

Columns

Name Type Description
CatalogName String The name of the database containing the key.
SchemaName String The name of the schema containing the key.
TableName String The name of the table containing the key.
ColumnName String The name of the key column.
PrimaryKeyName String The name of the primary key.
ForeignKeyName String The name of the foreign key.
ReferencedCatalogName String The database containing the primary key.
ReferencedSchemaName String The schema containing the primary key.
ReferencedTableName String The table containing the primary key.
ReferencedColumnName String The column name of the primary key.
ForeignKeyType String Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key.

CData Cloud

sys_primarykeys

Describes the primary keys.

The following query retrieves the primary keys from all tables and views:

         SELECT * FROM sys_primarykeys
          

Columns

Name Type Description
CatalogName String The name of the database containing the key.
SchemaName String The name of the schema containing the key.
TableName String The name of the table containing the key.
ColumnName String The name of the key column.
KeySeq String The sequence number of the primary key.
KeyName String The name of the primary key.

CData Cloud

sys_indexes

Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.

The following query retrieves all indexes that are not primary keys:

          SELECT * FROM sys_indexes WHERE IsPrimary='false'
          

Columns

Name Type Description
CatalogName String The name of the database containing the index.
SchemaName String The name of the schema containing the index.
TableName String The name of the table containing the index.
IndexName String The index name.
ColumnName String The name of the column associated with the index.
IsUnique Boolean True if the index is unique. False otherwise.
IsPrimary Boolean True if the index is a primary key. False otherwise.
Type Int16 An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3).
SortOrder String The sort order: A for ascending or D for descending.
OrdinalPosition Int16 The sequence number of the column in the index.

CData Cloud

sys_connection_props

Returns information on the available connection properties and those set in the connection string.

The following query retrieves all connection properties that have been set in the connection string or set through a default value:

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

Name Type Description
Name String The name of the connection property.
ShortDescription String A brief description.
Type String The data type of the connection property.
Default String The default value if one is not explicitly set.
Values String A comma-separated list of possible values. A validation error is thrown if another value is specified.
Value String The value you set or a preconfigured default.
Required Boolean Whether the property is required to connect.
Category String The category of the connection property.
IsSessionProperty String Whether the property is a session property, used to save information about the current connection.
Sensitivity String The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms.
PropertyName String A camel-cased truncated form of the connection property name.
Ordinal Int32 The index of the parameter.
CatOrdinal Int32 The index of the parameter category.
Hierarchy String Shows dependent properties associated that need to be set alongside this one.
Visible Boolean Informs whether the property is visible in the connection UI.
ETC String Various miscellaneous information about the property.

CData Cloud

sys_sqlinfo

Describes the SELECT query processing that the Cloud can offload to the data source.

See SQL Compliance for SQL syntax details.

Discovering the Data Source's SELECT Capabilities

Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.

NameDescriptionPossible Values
AGGREGATE_FUNCTIONSSupported aggregation functions.AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNTWhether COUNT function is supported.YES, NO
IDENTIFIER_QUOTE_OPEN_CHARThe opening character used to escape an identifier.[
IDENTIFIER_QUOTE_CLOSE_CHARThe closing character used to escape an identifier.]
SUPPORTED_OPERATORSA list of supported SQL operators.=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BYWhether GROUP BY is supported, and, if so, the degree of support.NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIESThe supported varieties of outer joins supported.NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINSWhether outer joins are supported.YES, NO
SUBQUERIESWhether subqueries are supported, and, if so, the degree of support.NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
STRING_FUNCTIONSSupported string functions.LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONSSupported numeric functions.ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONSSupported date/time functions.NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLESIndicates tables skipped during replication.
REPLICATION_TIMECHECK_COLUMNSA string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication.
IDENTIFIER_PATTERNString value indicating what string is valid for an identifier.
SUPPORT_TRANSACTIONIndicates if the provider supports transactions such as commit and rollback.YES, NO
DIALECTIndicates the SQL dialect to use.
KEY_PROPERTIESIndicates the properties which identify the uniform database.
SUPPORTS_MULTIPLE_SCHEMASIndicates if multiple schemas may exist for the provider.YES, NO
SUPPORTS_MULTIPLE_CATALOGSIndicates if multiple catalogs may exist for the provider.YES, NO
DATASYNCVERSIONThe CData Data Sync version needed to access this driver.Standard, Starter, Professional, Enterprise
DATASYNCCATEGORYThe CData Data Sync category of this driver.Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQLWhether enhanced SQL functionality beyond what is offered by the API is supported.TRUE, FALSE
SUPPORTS_BATCH_OPERATIONSWhether batch operations are supported.YES, NO
SQL_CAPAll supported SQL capabilities for this driver.SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONSA string value specifies the preferred cacheOptions.
ENABLE_EF_ADVANCED_QUERYIndicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side.YES, NO
PSEUDO_COLUMNSA string array indicating the available pseudo columns.
MERGE_ALWAYSIf the value is true, The Merge Mode is forcibly executed in Data Sync.TRUE, FALSE
REPLICATION_MIN_DATE_QUERYA select query to return the replicate start datetime.
REPLICATION_MIN_FUNCTIONAllows a provider to specify the formula name to use for executing a server side min.
REPLICATION_START_DATEAllows a provider to specify a replicate startdate.
REPLICATION_MAX_DATE_QUERYA select query to return the replicate end datetime.
REPLICATION_MAX_FUNCTIONAllows a provider to specify the formula name to use for executing a server side max.
IGNORE_INTERVALS_ON_INITIAL_REPLICATEA list of tables which will skip dividing the replicate into chunks on the initial replicate.
CHECKCACHE_USE_PARENTIDIndicates whether the CheckCache statement should be done against the parent key column.TRUE, FALSE
CREATE_SCHEMA_PROCEDURESIndicates stored procedures that can be used for generating schema files.

The following query retrieves the operators that can be used in the WHERE clause:

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.

Columns

Name Type Description
NAME String A component of SQL syntax, or a capability that can be processed on the server.
VALUE String Detail on the supported SQL or SQL syntax.

CData Cloud

sys_identity

Returns information about attempted modifications.

The following query retrieves the Ids of the modified rows in a batch operation:

         SELECT * FROM sys_identity
          

Columns

Name Type Description
Id String The database-generated Id returned from a data modification operation.
Batch String An identifier for the batch. 1 for a single operation.
Operation String The result of the operation in the batch: INSERTED, UPDATED, or DELETED.
Message String SUCCESS or an error message if the update in the batch failed.

CData Cloud

sys_information

Describes the available system information.

The following query retrieves all columns:

SELECT * FROM sys_information

Columns

NameTypeDescription
ProductStringThe name of the product.
VersionStringThe version number of the product.
DatasourceStringThe name of the datasource the product connects to.
NodeIdStringThe unique identifier of the machine where the product is installed.
HelpURLStringThe URL to the product's help documentation.
LicenseStringThe license information for the product. (If this information is not available, the field may be left blank or marked as 'N/A'.)
LocationStringThe file path location where the product's library is stored.
EnvironmentStringThe version of the environment or rumtine the product is currently running under.
DataSyncVersionStringThe tier of CData Sync required to use this connector.
DataSyncCategoryStringThe category of CData Sync functionality (e.g., Source, Destination).

CData Cloud

Connection String Options

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.

For more information on establishing a connection, see Establishing a Connection.

Authentication


PropertyDescription
AuthSchemeSpecifies the authentication scheme to use when connecting to WordPress or WordPressOnline.
URLThe URL of your WordPress site. For WordPress schema, the URL is the base URL for the site for wordpress. For WordPressOnline schema URL is the Rest API BaseURL for the wordpress site, sample URL will be testdev.wordpress.com.
SchemaThe Schema for the WordPress.
UserSpecifies the authenticating user's user ID.
PasswordSpecifies the authenticating user's password.

SSO


PropertyDescription
SSOLoginURLThe identity provider's login URL.
SSOPropertiesAdditional properties required to connect to the identity provider, formatted as a semicolon-separated list.
SSOExchangeURLThe URL used for consuming the SAML response and exchanging it for service specific credentials.

OAuth


PropertyDescription
OAuthClientIdSpecifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecretSpecifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
ScopeSpecifies the scope of the authenticating user's access to the application, to ensure they get appropriate access to data. If a custom OAuth application is needed, this is generally specified at the time the application is created.

SSL


PropertyDescription
SSLServerCertSpecifies the certificate to be accepted from the server when connecting using TLS/SSL.

Logging


PropertyDescription
VerbositySpecifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Schema


PropertyDescription
BrowsableSchemasOptional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Miscellaneous


PropertyDescription
MaxRowsSpecifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
PseudoColumnsSpecifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
TimeoutSpecifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
CData Cloud

Authentication

This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.


PropertyDescription
AuthSchemeSpecifies the authentication scheme to use when connecting to WordPress or WordPressOnline.
URLThe URL of your WordPress site. For WordPress schema, the URL is the base URL for the site for wordpress. For WordPressOnline schema URL is the Rest API BaseURL for the wordpress site, sample URL will be testdev.wordpress.com.
SchemaThe Schema for the WordPress.
UserSpecifies the authenticating user's user ID.
PasswordSpecifies the authenticating user's password.
CData Cloud

AuthScheme

Specifies the authentication scheme to use when connecting to WordPress or WordPressOnline.

Possible Values

Basic, OAuth, OAuthClient, OKTA, PingFederate, AzureAD, OAuthPassword

Data Type

string

Default Value

"Basic"

Remarks

This property specifies the authentication scheme to use when connecting to WordPress or WordPressOnline.

The available values are:

  • For WordPress: Basic, OAuth, OAuthClient, Okta, PingFederate, AzureAD.
  • For WordPressOnline: OAuth, OAuthPassword.

Option descriptions:

  • Basic: Use Basic user/password authentication. Recommended only for testing environments.
  • OAuth: Use standard OAuth 2.0 authentication flows.
  • OAuthClient: Use OAuth 2.0 Client Credentials grant type.
  • Okta: Use Okta SSO authentication.
  • PingFederate: Use PingFederate SSO authentication. Requires a valid license and customer-side configuration for validation.
  • AzureAD: Use Azure Active Directory (Entra ID) SSO authentication.
  • OAuthPassword: Use OAuth password authentication with the WordPressOnline schema.

CData Cloud

URL

The URL of your WordPress site. For WordPress schema, the URL is the base URL for the site for wordpress. For WordPressOnline schema URL is the Rest API BaseURL for the wordpress site, sample URL will be testdev.wordpress.com.

Data Type

string

Default Value

""

Remarks

The URL of your WordPress site. Required for both Basic and OAuth authentication.

CData Cloud

Schema

The Schema for the WordPress.

Possible Values

WordPressOnline, WordPress

Data Type

string

Default Value

"WordPress"

Remarks

The schemas available are WordPressOnline (to use WordPress REST API) and WordPress (to use WordPress OnPrem).

CData Cloud

User

Specifies the authenticating user's user ID.

Data Type

string

Default Value

""

Remarks

The authenticating server requires both User and Password to validate the user's identity.

CData Cloud

Password

Specifies the authenticating user's password.

Data Type

string

Default Value

""

Remarks

The authenticating server requires both User and Password to validate the user's identity.

CData Cloud

SSO

This section provides a complete list of the SSO properties you can configure in the connection string for this provider.


PropertyDescription
SSOLoginURLThe identity provider's login URL.
SSOPropertiesAdditional properties required to connect to the identity provider, formatted as a semicolon-separated list.
SSOExchangeURLThe URL used for consuming the SAML response and exchanging it for service specific credentials.
CData Cloud

SSOLoginURL

The identity provider's login URL.

Data Type

string

Default Value

""

Remarks

The identity provider's login URL.

CData Cloud

SSOProperties

Additional properties required to connect to the identity provider, formatted as a semicolon-separated list.

Data Type

string

Default Value

""

Remarks

Additional properties required to connect to the identity provider, formatted as a semicolon-separated list.

This is used with the SSOLoginURL.

SSO configuration is discussed further in .

CData Cloud

SSOExchangeURL

The URL used for consuming the SAML response and exchanging it for service specific credentials.

Data Type

string

Default Value

""

Remarks

The CData Cloud will use the URL specified here to consume a SAML response and exchange it for service specific credentials. The retrieved credentials are the final piece during the SSO connection that are used to communicate with WordPress.

CData Cloud

OAuth

This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.


PropertyDescription
OAuthClientIdSpecifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecretSpecifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
ScopeSpecifies the scope of the authenticating user's access to the application, to ensure they get appropriate access to data. If a custom OAuth application is needed, this is generally specified at the time the application is created.
CData Cloud

OAuthClientId

Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.

Data Type

string

Default Value

""

Remarks

This property is required in two cases:

  • When using a custom OAuth application, such as in web-based authentication flows, service-based authentication, or certificate-based flows that require application registration.
  • If the driver does not provide embedded OAuth credentials.

(When the driver provides embedded OAuth credentials, this value may already be provided by the Cloud and thus not require manual entry.)

OAuthClientId is generally used alongside other OAuth-related properties such as OAuthClientSecret and OAuthSettingsLocation when configuring an authenticated connection.

OAuthClientId is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can usually find this value in your identity provider’s application registration settings. Look for a field labeled Client ID, Application ID, or Consumer Key.

While the client ID is not considered a confidential value like a client secret, it is still part of your application's identity and should be handled carefully. Avoid exposing it in public repositories or shared configuration files.

For more information on how this property is used when configuring a connection, see Establishing a Connection.

CData Cloud

OAuthClientSecret

Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).

Data Type

string

Default Value

""

Remarks

This property (sometimes called the application secret or consumer secret) is required when using a custom OAuth application in any flow that requires secure client authentication, such as web-based OAuth, service-based connections, or certificate-based authorization flows. It is not required when using an embedded OAuth application.

The client secret is used during the token exchange step of the OAuth flow, when the driver requests an access token from the authorization server. If this value is missing or incorrect, authentication fails with either an invalid_client or an unauthorized_client error.

OAuthClientSecret is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can obtain this value from your identity provider when registering the OAuth application.

Notes:

  • This value should be stored securely and never exposed in public repositories, scripts, or unsecured environments.
  • Client secrets may also expire after a set period. Be sure to monitor expiration dates and rotate secrets as needed to maintain uninterrupted access.

For more information on how this property is used when configuring a connection, see Establishing a Connection

CData Cloud

Scope

Specifies the scope of the authenticating user's access to the application, to ensure they get appropriate access to data. If a custom OAuth application is needed, this is generally specified at the time the application is created.

Data Type

string

Default Value

""

Remarks

Scopes are set to define what kind of access the authenticating user will have; for example, read, read and write, restricted access to sensitive information. System administrators can use scopes to selectively enable access by functionality or security clearance.

When InitiateOAuth is set to GETANDREFRESH, you must use this property if you want to change which scopes are requested.

When InitiateOAuth is set to either REFRESH or OFF, you can change which scopes are requested using either this property or the Scope input.

CData Cloud

SSL

This section provides a complete list of the SSL properties you can configure in the connection string for this provider.


PropertyDescription
SSLServerCertSpecifies the certificate to be accepted from the server when connecting using TLS/SSL.
CData Cloud

SSLServerCert

Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Data Type

string

Default Value

""

Remarks

If you are using a TLS/SSL connection, use this property to specify the TLS/SSL certificate to be accepted from the server. If you specify a value for this property, all other certificates that are not trusted by the machine are rejected.

This property can take the following forms:

Description Example
A full PEM Certificate (example shortened for brevity) -----BEGIN CERTIFICATE-----
MIIChTCCAe4CAQAwDQYJKoZIhv......Qw==
-----END CERTIFICATE-----
A path to a local file containing the certificate C:\cert.cer
The public key (example shortened for brevity) -----BEGIN RSA PUBLIC KEY-----
MIGfMA0GCSq......AQAB
-----END RSA PUBLIC KEY-----
The MD5 Thumbprint (hex values can also be either space- or colon-separated) ecadbdda5a1529c58a1e9e09828d70e4
The SHA1 Thumbprint (hex values can also be either space- or colon-separated) 34a929226ae0819f2ec14b4a3d904f801cbb150d

Note: It is possible to use '*' to signify that all certificates should be accepted, but due to security concerns this is not recommended.

CData Cloud

Logging

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.


PropertyDescription
VerbositySpecifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.
CData Cloud

Verbosity

Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Data Type

string

Default Value

"1"

Remarks

This property defines the level of detail the Cloud includes in the log file. Higher verbosity levels increase the detail of the logged information, but may also result in larger log files and slower performance due to the additional data being captured.

The default verbosity level is 1, which is recommended for regular operation. Higher verbosity levels are primarily intended for debugging purposes. For more information on each level, refer to Logging.

When combined with the LogModules property, Verbosity can refine logging to specific categories of information.

CData Cloud

Schema

This section provides a complete list of the Schema properties you can configure in the connection string for this provider.


PropertyDescription
BrowsableSchemasOptional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
CData Cloud

BrowsableSchemas

Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Data Type

string

Default Value

""

Remarks

Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.

CData Cloud

Miscellaneous

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.


PropertyDescription
MaxRowsSpecifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
PseudoColumnsSpecifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
TimeoutSpecifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
CData Cloud

MaxRows

Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.

Data Type

int

Default Value

-1

Remarks

The default value for this property, -1, means that no row limit is enforced unless the query explicitly includes a LIMIT clause. (When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting.)

Setting MaxRows to a whole number greater than 0 ensures that queries do not return excessively large result sets by default.

This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.

CData Cloud

PseudoColumns

Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.

Data Type

string

Default Value

""

Remarks

This property allows you to define which pseudocolumns the Cloud exposes as table columns.

To specify individual pseudocolumns, use the following format:

Table1=Column1;Table1=Column2;Table2=Column3

To include all pseudocolumns for all tables use:

*=*

CData Cloud

Timeout

Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.

Data Type

int

Default Value

60

Remarks

The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.

Timeout is set to 60 seconds by default. To disable timeouts, set this property to 0.

Disabling the timeout allows operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server.

Note: Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.

CData Cloud

Third Party Copyrights

LZMA from 7Zip LZMA SDK

LZMA SDK is placed in the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

LZMA2 from XZ SDK

Version 1.9 and older are in the public domain.

Xamarin.Forms

Xamarin SDK

The MIT License (MIT)

Copyright (c) .NET Foundation Contributors

All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

NSIS 3.10

Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.

1. DEFINITIONS

"Contribution" means:

a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:

i) changes to the Program, and

ii) additions to the Program;

where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.

"Contributor" means any person or entity that distributes the Program.

"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.

"Program" means the Contributions distributed in accordance with this Agreement.

"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.

2. GRANT OF RIGHTS

a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.

b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.

c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.

d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.

3. REQUIREMENTS

A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:

a) it complies with the terms and conditions of this Agreement; and

b) its license agreement:

i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;

ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;

iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and

iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.

When the Program is made available in source code form:

a) it must be made available under this Agreement; and

b) a copy of this Agreement must be included with each copy of the Program.

Contributors may not remove or alter any copyright notices contained within the Program.

Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.

4. COMMERCIAL DISTRIBUTION

Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.

For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.

5. NO WARRANTY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.

6. DISCLAIMER OF LIABILITY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

7. GENERAL

If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.

If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.

All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.

Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.

This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9434