Connectors Reference
WordPress is web software you can use to create a beautiful website, blog, or app.
|
Status: Preview |
Tier: Standard |
Version: 1.0.20 |
|
Name |
Summary |
|
List posts |
|
|
Get site stats chart data |
|
|
Get site related list of metrics and insights |
|
|
SiteStats (string siteId, [internal][Optional]string fields) |
Get site statistics |
|
Get site top posts and pages by views |
|
|
List posts from a site |
|
|
Get post |
|
|
Create post |
|
|
List sites |
|
Name |
Summary |
|
When a post is created |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: List posts
Description: List all posts from current user's sites
Syntax:
WordPress.ListAllMyPosts ([internal][Optional]string fields)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
fields |
string (Fields) |
Comma-separated list of fields to include. |
False |
Returns:
Type:array of (ListAllMyPostsResponseItem)
Summary: Get site stats chart data
Description: Get site stats chart data
Syntax:
WordPress.SiteStatsChartData (string siteId, [Optional]string unit, [internal][Optional]integer http_envelope, [advanced][Optional]string quantity, [Optional]string date)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
siteId |
string (Site Id) |
The site's id or domain |
True |
|
|
unit |
string (Unit) |
year, week, month or day |
False |
|
|
http_envelope |
integer (Http Envelope) |
http_envelope |
False |
|
|
quantity |
string (Quantity) |
Number of units to return |
False |
|
|
date |
string (Date) |
Date |
False |
Returns:
Type:array of (SiteStatsChartDataResponseItem)
Summary: Get site related list of metrics and insights
Description: Get site related list of metrics and insights
Syntax:
WordPress.ListInsightsStats (string siteId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
siteId |
string (Site Id) |
The site's id or domain |
True |
Returns:
Type:SiteInsightsModel
Summary: Get site statistics
Description: Get statistics for a specified site
Syntax:
WordPress.SiteStats (string siteId, [internal][Optional]string fields)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
siteId |
string (Site Id) |
The site's id or domain |
True |
|
|
fields |
string (Fields) |
Fields to include |
False |
Returns:
Type:SiteStatsModel
Summary: Get site top posts and pages by views
Description: View a site's top posts and pages by views
Syntax:
WordPress.SiteTopPosts (string siteId, [advanced][Optional]string num, [Optional]string period, [advanced][Optional]string max)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
siteId |
string (Site Id) |
The site's id or domain |
True |
|
|
num |
string (Number) |
Number of periods to include in the results Default is 1. |
False |
|
|
period |
string (Period) |
Time filter- day, week, month or year. |
False |
|
|
max |
string (Max) |
The maximum number of results to return Default is 10. |
False |
Returns:
Type:array of (SiteTopPostsResponseItem)
Summary: List posts from a site
Description: List posts from a site
Syntax:
WordPress.ListPosts (string siteId, [advanced][Optional]string number, [advanced][Optional]string after, [advanced][Optional]string before, [Optional]string status, [internal][Optional]string fields)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
siteId |
string (Site Id) |
The site's id or domain |
True |
|
|
number |
string (Number) |
The number of posts to return.Limit 100, Default 10 |
False |
|
|
after |
string (After) |
Return posts dated after the specified datetime. (iso 8601 datetime) |
False |
|
|
before |
string (Before) |
Return posts dated before the specified datetime. (iso 8601 datetime) |
False |
|
|
status |
string (Status) |
Comma-separated list of statuses for which to query, including any of: publish, private, draft, pending, future, and trash, or simply any. Defaults to publish |
False |
|
|
fields |
string (Fields) |
Comma-separated list of fields to include. |
False |
Returns:
Type:array of (ListAllMyPostsResponseItem)
Summary: Get post
Description: Get post
Syntax:
WordPress.GetPost (string siteId, string postId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
siteId |
string (Site Id) |
The site's id or domain |
True |
|
|
postId |
string (Post Id) |
The post Id. |
True |
Returns:
Type:PostModel
Summary: Create post
Description: Create post
Syntax:
WordPress.CreatePost (string siteId, CreatePostModel post)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
siteId |
string (Site ID) |
The site's id or domain. |
True |
|
|
post |
|
A Blogger post object for new post requests |
True |
Returns:
Type:PostModel
Summary: List sites
Description: List sites
Syntax:
WordPress.ListSites ([internal][Optional]string fields)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
fields |
string (Fields) |
Comma-separated list of fields to include. |
False |
Returns:
Type:SiteList
Description: A list of sites
Summary: When a post is created
Description: Triggers a new flow when there is a new post on the logged in user's timeline
Syntax:
WordPress.OnTriggerNewPost ()
Returns:
Type:ListPostsResponse
Summary:
Description: A Blogger post object for new post requests
Properties:
|
Name |
Type |
Summary |
|
title |
string Title |
The title of the post |
|
content |
string(html) Content |
The content of the post |
|
status |
string Status |
The status of the post Values: [draft, publish, private, pending, future, auto-draft] |
|
tags |
string Tags |
The tags for post |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
ID |
integer ID |
|
|
comment_count |
integer Comment Count |
|
|
site_ID |
integer Site ID |
|
|
date |
string Date |
|
|
modified |
string Modified |
|
|
title |
string Title |
|
|
URL |
string URL |
|
|
slug |
string Slug |
|
|
guid |
string Guid |
|
|
type |
string Type |
|
|
like_count |
integer Like Count |
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
posts |
array of (PostResponse) Posts |
Posts |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
ID |
integer ID |
|
|
site_ID |
integer Site ID |
|
|
date |
string Date |
|
|
modified |
string Modified |
|
|
title |
string Title |
|
|
URL |
string URL |
|
|
short_URL |
string Short URL |
|
|
content |
string Content |
|
|
excerpt |
string Excerpt |
|
|
slug |
string Slug |
|
|
guid |
string Guid |
|
|
status |
string Status |
|
|
sticky |
boolean Sticky |
|
|
password |
string Password |
|
|
parent |
Parent |
|
|
type |
string Type |
|
|
likes_enabled |
boolean Likes Enabled |
|
|
sharing_enabled |
boolean Sharing Enabled |
|
|
like_count |
integer Like Count |
|
|
i_like |
boolean I Like |
|
|
is_reblogged |
boolean Is Rebloggled |
|
|
is_following |
boolean Is Following |
|
|
global_ID |
string Global ID |
|
|
featured_image |
string Featured Image |
|
|
post_thumbnail |
Post Thumbnail |
|
|
format |
string Format |
|
|
geo |
boolean Geo |
|
Summary: Parent
Description:
Properties:
|
Name |
Type |
Summary |
Summary: Post Thumbnail
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
ID |
integer ID |
|
|
comment_count |
integer Comment Count |
|
|
site_ID |
integer Site ID |
|
|
date |
string Date |
|
|
modified |
string Modified |
|
|
title |
string Title |
|
|
URL |
string URL |
|
|
slug |
string Slug |
|
|
guid |
string Guid |
|
|
type |
string Type |
|
|
like_count |
integer Like Count |
|
Summary:
Description: List of site items
Properties:
|
Name |
Type |
Summary |
|
ID |
integer Site ID |
Site ID |
|
name |
string Site Name |
Site Name |
|
description |
string Site Description |
Site Description |
|
URL |
string Site Url |
Site URL |
|
is_multisite |
boolean Is Multisite |
Whether the site is a Multisite site or not. Always true for WP.com sites. |
|
post_count |
integer Post Count |
The number of posts the site has |
|
subscribers_count |
integer Subscribers Count |
The number of subscribers the site has |
|
lang |
string Language |
Language |
|
visible |
boolean Visible |
Site visibility |
|
is_private |
boolean Is Private |
Is site private |
|
single_user_site |
boolean Is Single User Site |
Is single user site |
|
is_vip |
boolean Is VIP |
Is VIP |
|
is_following |
boolean Is Following |
Is Following |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
highest_hour |
integer Highest Hour |
|
|
highest_hour_percent |
number Highest Hour Percent |
|
|
highest_day_of_week |
integer Highest Day Of Week |
|
|
highest_day_percent |
number Highest Day Percent |
|
Summary:
Description: A list of sites
Properties:
|
Name |
Type |
Summary |
|
sites |
array of (Site) Sites |
List of sites |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
period |
string Period |
|
|
views |
integer Views |
|
|
visitors |
integer Visitors |
|
|
likes |
integer Likes |
|
|
reblogs |
integer Reblogs |
|
|
comments |
integer Comments |
|
|
posts |
integer Posts |
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
visitors_today |
integer Visitors Today |
|
|
visitors_yesterday |
integer Visitors_Yesterday |
|
|
visitors |
integer Visitors |
|
|
views_today |
integer View Today |
|
|
views_yesterday |
integer Views Yesterday |
|
|
views_best_day |
string Views Best Day |
|
|
views_best_day_total |
integer Views Best Day Total |
|
|
views |
integer Views |
|
|
comments |
integer Comments |
|
|
posts |
integer Posts |
|
|
followers_blog |
integer Followers Blog |
|
|
followers_comments |
integer Followers Comments |
|
|
comments_per_month |
integer Comments Per Month |
|
|
comments_most_active_recent_day |
string Comments Most Active Recent Day |
|
|
comments_most_active_time |
string Comments Most Active Time |
|
|
comments_spam |
integer Comments Spam |
|
|
categories |
integer Categories |
|
|
tags |
integer Tags |
|
|
shares |
integer Shares |
|
|
shares_twitter |
integer Shares Twitter |
|
|
shares_facebook |
integer Shares Facebook |
|
|
shares_press-this |
integer Shares Press This |
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
integer ID |
|
|
href |
string Link |
|
|
date |
string Date |
|
|
title |
string Title |
|
|
type |
string Type |
|
|
views |
integer Views |
|
|
video_play |
boolean Video Play |
|