Get top posts with the WordPress.com API
Returns the most viewed posts and pages of a site over the last num periods up to date: per day in days, or added up in summary when summarize is true.
- Identifier
- wordpress_com_get_top_posts
The request
POST https://connect.reportei.com/api/tools/wordpress_com_get_top_posts/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"site": "<site>"
}
}Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| site | string | Yes | ID of the site, from List sites, or its domain, like example.wordpress.com. |
| period | string | No | Unit of the window. The default is day.Values: day, week, month, year |
| num | integer | No | How many periods the window has, ending at date. The default is 1. |
| date | string | No | Last day of the window, as YYYY-MM-DD. The default is today. |
| max | integer | No | How many posts to return. The default is 10. |
| summarize | boolean | No | true adds up the whole window in summary instead of returning each day. |
Supported connections
Your customer connects their WordPress.com account once, with one of the modes below. The same connection serves every tool of the toolkit.
OAuth with your product's app
You register your product's OAuth app once, with POST /api/merchants/credentials/wordpress_com, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.
The response
On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.
Ready for AI agents
This tool's input is a JSON Schema, available at GET /api/tools/wordpress_com_get_top_posts. It becomes your agent's tool definition with no conversion.
Other WordPress.com tools
- List sitesGETLists the sites of the account, with the ID that the other tools ask for as site, the name and the URL. The connection reaches only the site the client chose when authorizing it.
- List postsGETLists the posts or pages of a site, newest first, with found as the total. Only published ones by default; status lists the others. To read the next page, pass the meta.next_page of the response as page_handle.
- Get postGETReturns a post or page with its title, content, excerpt, status, URL, categories and tags.
- Create postPOSTCreates a post or page and returns it. The default status is publish, which puts it live right away: send draft to save it unpublished. Once published, it is also shared on the social accounts connected to the site, unless publicize is false.
- Update postPOSTUpdates a post or page and returns it. Only the fields sent change. When editing a draft, also send status draft, so the change never publishes it. status trash sends the post to the trash.
- List categoriesGETLists the categories of a site with their ID, name, slug and post_count, sorted by name. Create post and Update post take the category names or IDs.
- List commentsGETLists the comments of a site, newest first, with found as the total and the post of each comment in post. Only approved ones by default; status unapproved lists the moderation queue. The last page is when page times number reaches found.
- Update commentPOSTModerates or edits a comment and returns it. status approved publishes it, unapproved sends it back to the moderation queue, spam marks it as spam and trash sends it to the trash.
Toolkits in the same category
See all 100 toolkitsSee Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
