All help topics

Start here

Your dashboard

Your account

Your account

APIs

The APIs page lets you pull your dashboard numbers into another tool, such as a spreadsheet, a reporting dashboard or your own systems. It returns the same numbers your dashboard shows, as last published, and can't change anything.

The APIs page: a list of keys with name, last four characters, who made it and when it was last used, a box to make a key, and how-to examples.

Opening the page

Choose APIs in your dashboard's sidebar. If the page says "Not switched on yet", the API isn't turned on for your account. Ask through Contact support if you'd like it.

Making and managing keys

  1. Type a name that says what the key is for, such as "Weekly sheet", and choose Make a key.
  2. Copy the key straight away. It's shown once and can't be shown again.
  3. The key starts working within a few minutes.

The Your keys list shows each key's name, its last few characters, who made it, when it was last used, and when it expires if it goes unused: a key nobody uses for a while stops working on its own. A dashboard can have a limited number of keys; the page says when you've reached it.

To stop a key working, for example because it might have leaked or you no longer need it, ask us to revoke it through Contact support. It stops working when your dashboard next updates, usually within a few minutes.

Treat a key like a password. Keep it out of shared documents, spreadsheet cells and web pages.

Using a key

The page has copy-ready examples, including one for Google Sheets and Looker Studio, and lists every address and field. In short: send the key in the Authorization header, and ask for your dashboard, the list of monthly reports, or one month's report. Your numbers change about once a week, so refreshing once a day is plenty.

What to do with itIf you just want a copy of the numbers to share, you don't need the API: Export report and the monthly report's Print / Save PDF are simpler. The API is for keeping another tool up to date without copying numbers by hand.