Integrate all of Keypup functionalities in Your DevOps Environment
The Keypup API allows to perform all actions accessible via the user interface, which includes adding team members, creating insights & dashboards, querying datasets and more.
Imagine a development environment where crucial information flows effortlessly between your tools, where manual tasks are minimized, and where your team can dedicate their energy to what they do best: crafting exceptional software. The Keypup API empowers you to turn this vision into a tangible reality.
Unlock a New Era of DevOps Efficiency and Insight
with Keypup's API
This isn't just another API - it's a transformative step forward, providing you with direct access to the heart of your development data and enabling you to build bespoke solutions that perfectly align with your team's unique requirements.
With the Keypup API, you can integrate Keypup's insightful data into your existing systems, automate tedious tasks, and create a truly interconnected development ecosystem.
Through the API, you can tap into real-time data about your projects, issues, pull requests, sprints, and team activities, gaining unparalleled visibility into every facet of your development process.
Let's Explore the Potential:
Three Transformative Use Cases
Supercharge your Daily Standups with a Tailored Slack Bot
Your bot could deliver insights such as:
> Pending Pull Requests: A curated list of pull requests awaiting review, highlighting those that have been open for an extended period and might be causing bottlenecks.
> Urgent Issues: A summarized view of high-priority issues demanding immediate attention, ensuring critical problems are addressed promptly.
> Team Activity Highlights: A quick overview of recent team accomplishments, key milestones achieved, and any significant updates, keeping everyone on the same page.
> Sprint Progress: If you're using sprints, your bot can provide a snapshot of the current sprint's progress, including burndown charts or completed story points.
Proactive Monitoring & Alerting: Integrate with Datadog, New Relic and More
For instance, you could create a monitor leveraging the Keypup API to:
> Track Stale Pull Requests: Periodically fetch the number of pull requests that have been pending review for longer than a specified duration (e.g., 3 days).
> Define Alert Thresholds: Establish a threshold for the number of stale pull requests that, when exceeded, indicates a potential bottleneck in your review process.
> Trigger Proactive Alerts: Configure your monitoring system to raise an alert when the threshold is breached, proactively notifying your team and prompting them to take action.
> Monitor Issue Resolution Time: Track the average time it takes to resolve issues and set up alerts for when this time exceeds an acceptable limit.
Intelligent DevOps Flows: Real-Time Metrics Driving Automation
Consider these examples:
> Monitor Bug Report Trends: Utilize the Keypup API to continuously track the number of recently reported bugs.
> Dynamically Adjust GitHub Review Processes: Implement a system that automatically increases the number of required reviewers on GitHub when the bug count surpasses a predefined threshold. This ensures that code changes undergo more rigorous scrutiny during periods of increased bug activity, helping to maintain code quality and stability.
> Temporary Release Freeze: In more critical situations, you could even configure your system to temporarily block all releases until the bug count returns to an acceptable level, preventing potentially unstable code from reaching production.
> Automated Capacity Planning: Monitor team velocity and automatically adjust sprint capacity or team assignments based on historical data and current workload.
Using the API in 3 simple steps
The Keypup API is split into two different purpose-specific endpoints:
The Platform API: This endpoint is the general-purpose API used to manage dashboards, insights, projects, and users.
The Reporting API : This endpoint is the actual reporting engine used by insights to query the datasets.
1. Use the API Explorer
Our allows you to get started with both APIs. No tokens are required to use the Explorer since you are authenticated through your Keypup account.
You can switch between APIs using the top-left dropdown.
You can access the documentation of each API by clicking the book icon on the left side.
2. Export Insights as Queries
After enabling API access on your account, a new "Open in API Explorer" button will appear in the Configure Table section of the insight editor.
Clicking this button will open the query used the insight in the API Explorer.
3. Use Queries in Application Code and Scripts
GraphQL queries are POST requests with three components:
> The header, containing the Bearer Authentication
> The query, passed as a body text attribute
> The query variables, passed as a body JSON attribute.
You can use any HTTP library in any language to make GraphQL queries.