API Portal
SEO and marketing
Set your API Portal's title and meta tags, understand what search engines and link previews see, and connect Google Tag Manager, including the developer details the portal passes to it. All from Settings, Portal settings, Marketing.
The Marketing settings control the page title and meta tags your API Portal adds, and connect a Google Tag Manager container. Both live on one page. Read the notes on link previews and on developer data before you rely on either. For how the portal fits together, start with the API Portal overview.
Where do you set SEO and marketing for your API Portal?
Open Settings, Portal settings, Marketing. The page has two blocks, each with its own Save Changes button.
| Block | What it controls |
|---|---|
| Google Tag Manager | The Tag Manager container the portal loads, and the data the portal hands to it. |
| Search Engine Optimization | The meta and Open Graph tags the portal adds, and the Portal title used in browser tabs. |
How do you set the API Portal page title?
Type it in Portal title in the Search Engine Optimization block, then choose Save Changes. An empty title is saved as API Portal. The portal uses it as the browser tab title, and portal pages and products put their own name in front of it.
- Open Settings, Portal settings, Marketing.
- In Search Engine Optimization, type your title in Portal title.
- Choose Save Changes. The button enables once the title or a tag row changes.
A page called Pricing on a portal titled Acme Developers shows as "Pricing - Acme Developers" in the tab.
How do you add meta and Open Graph tags?
Each row in the Search Engine Optimization block is one tag: a property name on the left and its content on the right. Choose + Add property for a new row, fill both fields, then choose Save Changes. A portal that never saved tags starts with no rows.
| Field | What you enter |
|---|---|
| Property (left) | The tag name, for example og:title, og:image or description. |
| Content (right) | The value, for example your portal's name or the full address of an image. |
A row named description sets the page's meta description. Every other row is added as a meta tag with that property. Remove a row with the cross at its end.
Do search engines and link previews see these tags?
Only crawlers that run the page's scripts see them. The portal adds your title and tags in the browser after the page loads. The HTML it first sends always carries the default title API Portal and the description "API portal powered by apiable.io".
Link-preview crawlers in chat and social apps read that first HTML without running the page, so shared links to your portal show the default title and description, not your Open Graph image. Portal pages and product pages add their own title, description and image in the browser too, so the same applies to them.
How do you connect Google Tag Manager?
Paste your container ID into the Google Tag Manager block and choose Save Changes. The ID must start with GTM-. The portal then loads your container for every visitor.
- Open Settings, Portal settings, Marketing.
- In Google Tag Manager, paste your container ID, for example
GTM-XXXXXXX. - Choose Save Changes. The button enables once the ID starts with
GTM-and differs from the saved one.
The field only accepts values that start with GTM-, so you cannot clear it here. To disconnect Tag Manager, contact Apiable.
What developer data does the portal pass to Google Tag Manager?
When a developer is signed in, the portal adds their personal details to the Tag Manager data layer, where any tag in your container can read them. Account for this in your privacy notice and in how you configure tags.
| Data layer key | What it holds |
|---|---|
email | The developer's email address. |
name | Their full name. |
givenName, familyName | Their first and last name. |
userId | Their Apiable user ID. |
currentTeam | The ID of their active team. |
company | The ID of their company, when they belong to one. |
For visitors who are not signed in, the data layer carries no personal details. The container itself loads for every visitor, signed in or not.
Why is the Google Tag Manager save button disabled?
It enables only when the value starts with GTM- and is different from the saved ID. The usual cause is a Google Analytics measurement ID pasted in place of a Tag Manager container ID.
| What you see | What to do |
|---|---|
| Save Changes stays disabled | The value does not start with GTM-. Paste the container ID from Tag Manager, for example GTM-XXXXXXX. |
| Save Changes stays disabled after editing | The ID matches the one already saved. Nothing has changed. |
| You want to remove Tag Manager | An empty value cannot be saved. Contact Apiable to disconnect the container. |
| The fields are greyed out | Your role cannot manage portals. Ask your Organisation Owner or an Organisation Admin. |