Skip to main content

Hosted index page

The hosted index page lists every calculator your cobrand can use, grouped, as cards that link to each hosted calculator page. Link to it when you want visitors to pick a calculator.

Before you start​

  • Your public key (pk_...) and the hosted site address from the Go live page in the portal.
  • At least one calculator group on your cobrand. Without one, the page shows an empty state.

Minimal example​

https://<your hosted host>/c/<your public key>

Replace the host and the key, then open the address in a browser. The page has your branded header and footer, the title "Calculators | your cobrand name", and one card for each calculator. A card shows the calculator's name and description, and links to its hosted calculator page.

<a href="https://<your hosted host>/c/<your public key>">All calculators</a>

Options​

PartDescription
/c/{publicKey}The index page.
?locale=en-US, es-US, en-CA or fr-CA. The default is your cobrand's default locale. The card links keep the language.

If your cobrand has a vanity URL, the index page is also at /{slug}. On a custom domain, it's at the root, /.

Errors and limits​

SituationWhat the visitor sees
No cobrand has the key"This calculator link isn't available"
No calculators are available"No calculators are currently available"
The calculator list can't be readA message that says calculators can't load right now, with a Retry link. The page keeps your branding.

As on every hosted page, error pages come with a 200 status. See Hosted calculator pages.

LimitValue
Stale listWhen the list can't be read, the page can show the last good copy for up to 24 hours.
Request rate1,200 requests a minute for each cobrand's public key. See Rate limits.

The index page reads the embed endpoints. See Embed endpoints and allowed domains.