Get blog settings

Tool ID: kocodesk_blog_settings_get

Summary

Read how the Blog plugin is configured on your site: where the blog lives, how article URLs are built, the RSS path, the category root and how many posts appear per page.

When to use it

  • As the first step in any blog task, to confirm the Blog plugin is switched on.
  • When you want to know what a new post's URL will look like.

What you need

Requirement Required?
Metraclick connection Yes
Tool enabled for your account Yes
KocoDesk credentials Yes
Blog plugin enabled for the site Yes

Parameters

None.

What you get back

{
  "home_path": "/blog",
  "url_pattern": "/{slug}",
  "rss_path": "/blog/rss",
  "category_root_id": 12,
  "posts_per_page": 10
}

Example prompts

What are the blog settings on my site?

Where does my blog live and how are article URLs built?

Which category is the blog root?

Tips

  • If this returns a "Blog plugin is not enabled" error, ask your administrator to allow the Blog plugin for the site in KocoDesk under Sites → Plugins.
  • category_root_id is the value to pass to List categories to see blog categories only.

Related