Products
Product marketing and menu
Set a product's presentation: the Product Overview marketing page, its Menu Items, and the Features Table that compares plans side by side.
A product carries its own presentation in the dashboard across three tabs: Product Overview is its marketing page, Menu Items is its in-portal navigation, and Features Table compares its plans. All three are part of the product and save when you click Save Changes.
What is the Product Overview tab?
Product Overview is the product's marketing page, built from Markdoc sections. You add sections, fill them in, toggle each one Active, and a live preview shows how the page renders in your API Portal.
The tab offers a set of predefined sections you can add and reorder:
| Section | Use it for |
|---|---|
| features | A list of the product's features. |
| workflows | A grid describing how the product is used. |
| statistics | A grid of numbers or metrics. |
| usages | A grid of usage scenarios. |
| callouts | Highlighted callout blocks. |
Each section has an Active / Inactive toggle that controls whether it shows on the page, and most sections hold records you add, edit, reorder, and delete. The right pane is a live preview; the Preview button renders the whole page as it will appear. Saving the product stores the overview.
How do I build the Product Overview page?
Add a section, turn it Active, add its records, and check the preview. Then save the product.
- Open the product and select the Product Overview tab.
- Open a section such as features or callouts and add it.
- Toggle the section Active so it appears on the page.
- Add records inside the section and edit their fields.
- Use Preview to see the rendered page, then click Save Changes.
Sections are reorderable, so the order you set is the order developers see. An empty page shows a placeholder in the preview until you add a section.
What are Menu Items?
Menu Items set the per-product navigation shown in your API Portal. You add, reorder, and remove entries, except for the protected ones that every product keeps.
The protected entries are details, plans, documentation, and changelog. These cannot be removed from the product menu. The changelog entry is available only when changelog is enabled for your account; without that entitlement it is disabled.
Use this tab to add links to the product's in-portal navigation alongside the protected entries. Saving the product stores the menu.
What is the Features Table?
The Features Table is a comparison grid with the product's features as rows and its plans as columns. For each feature you tick which plans include it, and you can give a feature a per-plan value.
The grid needs a plan, because it compares plans. Each plan column shows its name and version, and where a plan has more than one version a dropdown lets you pick which version the column shows. An Edit and Preview control switches between editing the grid and previewing it.
- Open the product and select the Features Table tab.
- Choose Add another Feature and name the feature.
- For each plan column, tick the feature to include it in that plan.
- Optionally type a per-plan value for the feature, for example a quota.
- Reorder features by dragging, and use Preview to check the result.
The comparison table is what developers use to tell the product's plans apart, for example a free tier next to a paid tier.
Troubleshooting
| What you see | What to do |
|---|---|
| Adding a feature is disabled with a note to create a plan first | The product has no plan. Add a plan on the API Plans tab, then add features. |
| Adding a feature is disabled because the product is not created yet | Save the new product first, then add features on the Features Table tab. |
| A marketing section does not appear in the preview | The section is set to Inactive. Toggle it Active to show it on the page. |
| There is no option to add a custom marketing section | Custom sections need custom global partials enabled for your account. Use the predefined sections instead. |
| The changelog entry in Menu Items is disabled | Changelog is not enabled for your account. The other protected entries stay available. |
| A protected menu entry cannot be removed | The details, plans, documentation, and changelog entries are protected and stay in every product menu. |
Where to next
Create and publish a product
Create a product, set its Details, add a plan, and publish it.
Product categories
Create categories and group products in your API Portal catalog.
Anatomy of a plan
The plan tabs, the plan lifecycle, and when to create a new version.
Assign scopes to a plan
Set each scope to Active, Optional, or Restricted on a plan.