Skip to main content
What is the Jiminny API?
Harry Hawkins avatar
Written by Harry Hawkins
Updated over a month ago

Unlocking the Potential of Your Jiminny Data

At Jiminny, we believe in empowering our customers by giving you control over your data. Having access to your Jiminny data opens up new possibilities for driving revenue-generating activities. That’s why we provide you with the autonomy and insights you need to make informed, data-driven decisions.

What is the Jiminny API?

An API (Application Programming Interface) allows different software applications to communicate and exchange data. The Jiminny API enables you to pull information from Jiminny and integrate it with other systems in your technology stack. Our API is a partial REST API, and the data you receive will be in JSON format. For full technical details, visit our documentation.

How Do I Use the API?

While we respect anyone with a DIY spirit, we recommend having someone with coding experience (such as a software engineer or developer) handle the API setup, as it requires technical knowledge. Once the API connection between Jiminny and your external applications is established, you’ll also need to connect a database to store the data being retrieved.

We suggest using a BI System or Data Warehouse (DWH), which allows you to efficiently manage the data and generate custom reports or triggers. Most of our customers use a DWH to create centralised, multi-application dashboards for reporting, insights, and alerts. If you need recommendations for setting up a DWH, don’t hesitate to reach out—we’re here to help.

The good news is that once your reporting framework is in place, ongoing data extraction becomes a straightforward process. If you prefer, you can hire a consultant to set up regular, predefined reports for you. However, bear in mind that as we update and enhance the API, you’ll need to adjust your setup accordingly.

How to Generate an API Key?

To generate an API key for the Jiminny API, follow these steps:

1. Access the API Key Section:

  • Go to Organisation Settings in your account.

  • Navigate to General and locate the API Key section.

2. Generate API Key:

  • Click on the Generate API Key button to create a new key.

3. Copy the API Key:

  • Use the Copy button to copy the key to your clipboard.

4. Regenerate the API Key:

  • If needed, you can also use the Regenerate button to receive a new key.

  • Regenerating a key, when there is already an existing one, will affect the integrations supported with the existing key.

Note: Only Admins/Owners can access and generate API keys.

Sharing your API Key

Your API key should be considered secret and protected at all times, since it provides access to your data. If you need to share your API Key securely with a third party (for example an Integration that does not allow copy/paste), please consider the following options:

  • 1Password Secure Note

  • Google Doc with strict sharing

  • Azure Secure Blob

Do not share your key via unsecure means like email.

What Can I Do with the Data from the API?

Reports:

One of the primary uses of the Jiminny API is to create detailed reports. By pulling data from Jiminny and other sources, you can generate precise insights into your sales team's performance. For example, you could compare the number of call recordings logged by each sales representative in Jiminny against the call records in your CRM to ensure data accuracy.

Dashboards and Monitors:

You can centralise data from Jiminny and other applications into a single view, giving you a comprehensive overview of your sales team's performance. The advantage of such dashboards is the visibility they provide, allowing you to identify high-performing team members, pinpoint growth opportunities, and spot potential challenges, thereby enabling more strategic decision-making.

Customisable Team Insights:

While Jiminny’s built-in Team Insights feature is powerful, there may be cases where you need more specific metrics. The API allows you to create customised views and actionable insights tailored to your unique business requirements.

Alerts and Notifications:

As you gather and analyse data, the ability to act quickly is essential. By integrating the Jiminny API with communication platforms like Slack, email, or SMS, you can set up custom alerts to notify you in real-time about critical events, ensuring you can respond promptly.

What Information Can the Jiminny API Provide?

The Jiminny API offers a wealth of activity data within a defined period. Accessing this information requires a unique token identifier that will be provided to you, ensuring that only your data is accessible.

Each activity record pulled from Jiminny contains the following information:

  • Metadata (title, host, participants, duration, etc.)

  • CRM Data linked to the activity

  • Playback Summaries and Action Items

  • Teams and Topics at both organisation and call levels

  • Playback Questions, Notes, and Comments

  • Playback Statistics (e.g. listens, coaching activity, automated call scoring)

  • Coaching Frameworks (ratings, coach, and coachee information)

  • Call Transcriptions (who said what, and when)

  • Ask Jiminny insights at the call level

You can also set volume thresholds to manage the amount of data pulled. We recommend starting with the top 500-1000 activities to streamline the data retrieval process. It’s better to pull data regularly in manageable batches, rather than doing large annual dumps, which can lead to performance issues.

Note: The data is provided in JSON format, and video content or call recordings are available for download, though these links are only active for 24 hours once issued.


Head over here to see for more details API Documentation


How can I get access?

Like what you hear and want to find out more? Well you can book some time directly with your CSM if you’re an existing customer below or for new enquiries, just schedule a meeting with our team to get started!


Did this answer your question?