DocsChart URLs

Short URLs

A short URL (https://c.renderchart.com/s/{id}) is a saved chart. It hides your key and your data, and it is short enough for anywhere a long chart URL would be awkward: SMS, print, tight email templates. Short URLs need a paid plan (Starter or above) and a verified email address. See Choosing a URL to compare them with unsigned and signed URLs.

Creating one

  • In the app: build a chart, then "Save as short URL".
  • With the API: POST /api/v1/charts with the chart's parameters (see REST API).

The parameters are checked when you save, so a short URL never points at an invalid chart. format=pdf needs Pro: on Starter it is refused when you save.

How they behave

  • A short URL renders as if you had signed it: no watermark on paid plans, and past your allowance it goes on as an extra render.
  • A key set to accept signed URLs only still serves its short URLs.
  • Responses carry Cache-Control: public, max-age=300, so a changed chart shows everywhere within about five minutes.
  • Rendering a short URL counts as a unique render once per version of the chart, like any other chart URL. It renders again, and counts again, after the events that redraw every chart (see "Responses" in the URL spec) and after its key is rotated.
  • Each short URL shows how many times it has been rendered (views from the cache are not counted) and when it was last rendered.

Live short URLs (Pro)

On Pro you can change a short URL's data after you share it: edit it in the app or PATCH /api/v1/charts/{id} with new params. The URL stays the same and shows the new chart within about five minutes. This suits dashboards in emails and wikis that should always show the latest numbers. On Starter, a short URL is a snapshot: save a new one for new data.

Keys and deletion

A short URL renders with the key it was created with. Rotating that key moves your short URLs to the new key, so they keep working. Revoking it makes them return the 403 image for good: they cannot be moved to another key, so save them again with an active key. Deleting a short URL makes it return the 403 image within a minute, though a browser or image proxy may keep showing its copy for up to five minutes more.

Moving to Free

Short URLs you made on a paid plan keep working on Free, with these differences:

  • they carry the watermark, and each one renders again once (counted on Free's allowance);
  • when the Free allowance is used up, ones not yet rendered again show the 402 image;
  • their data can no longer be changed, though you can still rename and delete them in the app;
  • theme=brand draws the light theme, and format=pdf shows the 400 image.

Next: Examples