All topics
Getting started
What is SolarKnock? Install SolarKnock on your phone Join your team and sign in Roles and permissions
Map and knocking
Using the map Logging a knock Creating a lead from the map Solar estimates Territories
Leads and appointments
Working with leads Booking appointments Closers and setters Connecting Google Calendar Commission
AutoKnock
How AutoKnock works Getting the best results from AutoKnock Reviewing your AutoKnock day Reviewing a rep's AutoKnock day AutoKnock audio, privacy and consent
Stats and team
What the numbers on Stats mean The Team tab and the leaderboard
Admin
Manage team members Organization settings SitePilot sold-deal sync The Reporting API
Troubleshooting
Fixing common problems Contacting support
Help Center Admin

The Reporting API

Connect your own systems to SolarKnock with an API key. Admins create keys on the Profile tab; developer docs are at solarknock.com/api.

On this page
Create a keyKeep your keys safeSending data into SolarKnockDeveloper documentation

The Reporting API lets your company's own systems, such as a CRM, a spreadsheet or a reporting tool, pull your SolarKnock data automatically: your team, knocks, leads, appointments and daily numbers. It uses a secret key that belongs to your organization, so nobody has to sign in as a person.

Create a key

Who can do this: admins.

  1. Open the Profile tab.
  2. Under Integrations, tap Reporting API key (it says Not generated — tap to create until you have one).
  3. Confirm Generate API key?.
  4. The API key created window shows the key. Tap the copy icon and store the key somewhere safe, then tap Done.

Important: The key is shown only once. SolarKnock can't show it to you again. If you lose it, create another one.

Once you have a key, the tile shows ✓ and the key's last four characters. Tapping it again creates an additional key; your existing keys keep working. That way each system you connect can have its own key.

Keep your keys safe

Anyone with a key can read your organization's data. Give it only to the people or systems that need it, and never post it in a shared document or a chat.

Turning off a single key isn't available in the app yet. If a key has leaked, or you want one turned off, tap Contact Us on the Profile tab (see Contacting support).

Sending data into SolarKnock

A new key can read your data straight away. Sending data into SolarKnock through the API, such as knocks created in another system, stays off until you ask for it. Tap Contact Us on the Profile tab to have it turned on.

Developer documentation

Give your developer the key and point them to the full documentation at https://solarknock.com/api.

Still stuck? Contact support.