The document discusses 7 steps to achieving effective API insights:
1. Identify the problem of ensuring API metrics evolve in a "virtuous" rather than "vicious" way.
2. Select meaningful metrics that are understandable, measurable, and can drive tangible outcomes.
3. Align metrics to business outcomes and objectives to ensure long-term API value.
4. Apply metrics in practice by connecting them to business goals, establishing a frequency, tracking trends over time, and avoiding "vanity" measures.
5. Instrument metrics and visualize them on a single dashboard using tools like Anypoint Monitoring and the Elastic Stack to provide insights.
6. Measure outcomes around people, processes, the application platform,
1. 6 July 2022
Manchester MuleSoft Meetup Group
API Specification Automation via Platform APIs and
7 Steps to Achieving Effective API Insights
2. 2
●About the organizer:
○ Akshata Sawant
○ Meghana Prasad
○ Terry Lockwood
○ Nitish Raj
●About the sponsor:
○ EPAM
○ Slalom
○ MuleSoft
Introductions
A SHOW OF HANDS:
Who is new to this Meetup?
3. 3
● API Specification Automation via Platform APIs
● 7 Steps to Achieving Effective API Insights
● Trivia Quiz
● Networking time
Agenda
5. Latest Releases/News
● Join on July 7th for an in-depth session on MuleSoft Anypoint Code Builder-
https://meetups.mulesoft.com/events/details/mulesoft-mulesoft-community-leaders-presents-
anypoint-code-builder-enablement-feedback-and-open-beta-release/
● MuleSoft CONNECT Lives: We have 9 amazing live streams for you to catch up on from
MuleSoft CONNECT. We’ll be highlighting 3 each week. Check out a few of our highlights
below:
All Aboard the Automation Train
Battle of the Graphs: DataGraph vs GraphQL
Real talk: The Future of Integration
● MuleSoft Composer Possible New Feature Feedback Session: This session was designed for
Composer users and enthusiasts to join MuleSoft Engineers as they demo a potential new
Composer search feature. This is a great opportunity to see some of the behind-the-scenes
projects our teams are working on (in real time!), and influence where we take the product
next! 5
6. Latest Releases/News
● Become a leading community mentor -
○ https://tinyurl.com/sv4rupew
● All Meetup Calendar
○ Link for Meetup Calendar
● The calendar subscription link for other apps:
○ Google calendar Link
6
7. 7
• Anypoint Studio 7.12 with Mule Runtime 4.4
• Anypoint Flex Gateway : API Gateway for APIs running anywhere
• API Governance
• MuleSoft Composer : No code integration tool for Salesforce
• Anypoint Code Builder
New Product Release
8. About the Speaker
Nitish Raj, Lead Software Engineer – EPAM Systems
8
●Started IT journey in 2014 as a Java developer
●Was asked to work on MuleSoft assignments in 2016
●Assisted previous organizations in building Mule practice by
delivering Mule sessions
●Co-Leader of Engineering Student Meetup and
Manchester Meetup group.
●Certified MCDL2 (Something nice to brag, isn’t it ?)
10. MuleSoft Practice History
PAM MULESOFT EXPERIENCE
Ross Mason
founds MuleSoft
EPAM establishes
API Practice
EPAM acquires Ricston
Salesforce acquires
MuleSoft
Ross Mason and Peter Delia
founded Ricston that became one
of the first MuleSource partners
MuleSource started Mule, a
successful open-source project
EPAM established
Integration CC
2006 2009 2018 2020
2016
2013
Over 15+ years, Ricston have:
• Contributed to the open-source Mule project, the core runtime of MuleSoft’s
Anypoint Platform
• Provided MuleSoft product support capabilities whilst integrated with MuleSoft’s
support organization
• Co-authored and delivered Mule runtime training programs
• Developed MuleSoft certified connectors for both MuleSoft and our customers
• Enabled customers’ digital transformation through successful use of API-led
connectivity
12. Glossary
● API Specification: API skeleton/ Structure of request, response.
● Design Center: Anypoint Design Center is a development environment. API Designer
enables you to create API specifications in several modelling languages and to create RAML
API fragments.
● Anypoint Exchange: Where you publish that API Specification to create an Exchange Asset
so that anyone in the organization can find, consume, and reuse them.
● Platform APIs (Anypoint): RESTful web services exposed by Anypoint Platform.
12
13. Anypoint Platform APIs
● Anypoint Platform UI is backed by REST APIs to expose its management capabilities.
● Also known as Anypoint Platform APIs, public APIs, MuleSoft’s Platform APIs
13
16. 16
● Automate API Specification lifecycle via Platform APIs.
○ Uploading/ Importing a Spec in Design Center, manipulating files/ folders/ dependencies, publishing
to Exchange etc.
API Specification Automation
19. 19
Pre Requisites
Login Profile Information
API Specification
Automation
via Platform APIs
Access Token Organization Id
& Owner Id +
Access Token
Get the required data for calling Anypoint Platform APIs
• Access Token
• Organization Id
• Owner Id
Username & Password/
Connected App
21. 21
● Branch: Acquire write lock, release write lock, create a branch, delete a branch, clean branch,
branch status, list branches, check lock status etc.
● Project: Create a new project, Create fragment, Import API Spec
● File(s) & Folders: Add/ Update file content, Get file/ folder structure, get file content, move or
rename file/ folder
● Dependencies: Add, Update or delete dependency
● Publish: Publish to Exchange, Publish to Platform
● Delete: Delete a file or folder, delete a project, delete an asset (Soft/ Hard delete)
More operations
24. ● Australian born, dual Oz/UK national
● 25 years total experience
● Worked globally across Asia/Pac, EMEA, US,
Africa and places in-between such as a few
pacific islands that are barely visible on a map!
● 25 years in systems integration across every
tech stack imaginable – Oracle, IBM, APIGEE –
and MuleSoft
● Been using MuleSoft for nearly 6 years –
dropped into it at the deep end a client wanting a
POC ! Went from there ☺
● Enjoy riding the elevator from C-Suite to Engine
Room and always having my hands on the tech
About the Speaker
24
Steve Clarke, Practice Director UKI – MuleSoft & Integration – Slalom
25. Slalom is a modern consulting firm
focused on strategy, technology,
and business transformation.
STRATEGY
Redefine what’s possible
Go beyond the expected. We help you move
confidently through ambiguity and risk, focus
on your customer needs, and deliver
sustainable business value.
We analyze, architect,
and co-create
Learn from your data, create incredible digital
experiences, or make the most of new tech.
We blend design, engineering, and analytics
expertise to help you build the future.
TECHNOLOGY
Enact lasting change
New technologies. Shifting customers.
Industry disruption. Business moves fast, and
we specialize in working through change with
you.
TRANSFORMATION
26. Expertise that
powers
innovation
• Marketing Cloud
• B2B Commerce
• Customer 360 platform
• Integration/Mulesoft
• Public Sector
• Revenue Cloud
• Sales Cloud
• Service Cloud
• Analytics (Tableau and
Einstein)
• B2B Commerce
• B2C Commerce
• Community Cloud
• Customer 360 Platform
• Field Service Lightning
• Heroku
TOP 10 CONSULTING
PARTNER
• B2B Commerce
• B2C Commerce
• Consulting Ecosystem
• Consumer Goods Cloud
• Field Service Lightning
• Financial Services
PARTNER
ADVISORY BOARD
• Health Cloud
• Marketing Cloud
• Pardot
• Sales Cloud
• Services Cloud
• Tableau
NAVIGATOR
EXPERT
As a leader in every area of
the Salesforce ecosystem
we help our clients connect
the dots to achieve the
extraordinary.
• MuleSoft
• Maps
• Marketing Cloud
• Public Sector
• Revenue Cloud
• Sales Cloud
• Service Cloud
• Vlocity
service cloud
sales cloud marketing cloud community cloud platform
financial services
cloud
health cloud einstein B2B commerce cloud
C360 audiences
B2C commerce cloud
maps
voice
quip
loyalty cloud
revenue cloud consumer goods cloud
communications cloud
experience cloud
CRM
enterprise architecture
field service lightning
datorama
interaction studio
chatbots
apps
CLOUD LEADERSHIP
27. Capability Highlights
Integration and API Strategy
Working with you to understand and frame the Integration and Connectivity
challenges within your organization and shaping an API led strategy via MuleSoft
that will lead to rapid success.
MuleSoft Accelerators
Establishing the foundational People, Process and Technology capabilities
needed to support and accelerate your API ecosystem with MuleSoft at the core
MuleSoft Platform Delivery
Providing Architectural, Build and Delivery services to rapidly accelerate your API
journey with MuleSoft and unlock value across your enterprise.
API and Platform Assurance
Capabilities and services designed to enable your MuleSoft API lifecycle and ensure
your are continually delivering the highest quality API’s for your business, customers
and partners.
API Insights and Optimization
Gaining insight into the operational effectiveness of your platform investment and
leveraging core MuleSoft and Third Party solutions to unlock and optimize value in
your API ecosystem.
Slalom is Focused
on MuleSoft
We define integration strategies, deliver solutions and are considered thought
leaders in the spaces of Enterprise Integration, Application Programming
Interfaces, Platform-as-a-Service and Microservices. Slalom has implemented
MuleSoft across an array of diverse customer use cases ranging from
ERP/CRM Integration, Legacy Modernization, Cloud Adoption and Data
Synchronization through to Customer 360 initiatives.
We take considerable pride in not only launching new customers on their
MuleSoft journey, but also accelerating existing MuleSoft customers derive the
most value from their platform investment to support their business.
85+
MuleSoft projects
completed
80+
MuleSoft
certifications
70+
MuleSoft
practitioners
40+
Slalom offices
worldwide
#4
MuleSoft Partner in
North America
28. 7 Steps to Effective API Insights
So, what’s the problem ?
1
28
31. API’s and KPI’s – Vicious vs Virtuous evolution
API’s can be equated to a ‘currency’ in an organisation. To make that currency of value,
one needs to provide a ‘direction of travel’ in measuring progress that is ‘virtuous’.
32. 7 Steps to Effective API Insights
What’s in a metric ?
2
So, what’s the problem ?
1
32
33. 33
What’s in a metric ?
A measure of value
Meaning
Tied to a business outcome – helps
move the needle forward
34. As an example, a recent project where a strong C4E and Platform Insights were combined
over time achieved the following outcomes:
34
Understandable
Recognised
Meaningful
Clearly understood
Has a value
Can be sourced or easily derived
Can form the basis of one or more POV
Measurable
Accessible
Choosing the right metrics to measure
Can be tied to Operational benefits
Can be tied to business objectives
Tied to ways of working or project delivery
Can drive tangible
outcomes
Minimal effort to expose
Ideally natively obtainable
35. What Metrics might we care about ?
API Reuse
Number of Users
Governance Gaps
(Categories, Tags,
Domains)
Number of API’s
vCores Usage
Assets By Type
Active Personas
Total Development
Time
API Development Time
Developer Throughput
Average
Rating of
Assets
Number of
Applications
By Status
Speed to
Onboard
Consumption
Chargeback
Operations Consumer Metrics
Savings from
Reusability
API Usage
Across
Domains
Defects By
Stage
Cost
Reduction
API Usage
Across
Domains
36. 7 Steps to Effective API Insights
Align your metrics to outcomes
3
What’s in a metric ?
2
So, what’s the problem ?
1
36
37. API Metrics – Mapping the journey
KPI’s
Metrics
Objectives
38. 38
Establish KPI’s
/ Identify business pain points
/ Identify metric consumer motivation
/ Understand Time, Quality and Cost
priorities of the metric consumer
/ Categorise metric as Operational or
Consumer oriented
/ Validate with metric ‘owner’ the ‘why’
Aligning metrics to outcomes
Validate
/ Validate measure has meaning
Playback
/ Metric owner involvement
/ Instrumentation design
Configure
/ Identify sources
/ Identify tooling
/ Correlate data sources to ensure
effective reuse
/ Map data sources + transform
Feedback
/ Measure impact of metric
/ Use metric to drive change in
bahavour
39. 7 Steps to Effective API Insights
Apply your metrics in practice
4
Align your metrics to outcomes
3
What’s in a metric ?
2
So, what’s the problem ?
1
39
40. Applying Metrics in Practice
Focus on the “why”, the “how” then becomes more transparent
Tying to business outcomes or
behavoural needs, such as
Operational Impacts, will ensure
longer term API value.
Connect To Business
Goals
How often you capture metrics can make a
real difference to their effectiveness. The
older they are, the less insightful they may
be.
Establish Frequency
Absolute values such as Static Metrics are
helpful to be sure, but real insight comes
from understanding impact over time. Think
longer term.
Track Trends over
Absolute
Where business outcomes are not being
met, revise and reset. Its an iterative
process.
Always remember the target behavour.
Reset and adjust
Measuring metrics or KPI’s that have
no tangible tie into business or
operational change can be seen as
measuring for the sake of doing so.
Best to avoid !
Avoid “vanity” measures
Metrics should be readily quantifiable and
qualifiable – the metrics have greater
meaning if they can provide inherent value.
Quantify and Qualify
41. 7 Steps to Effective API Insights
Instrumentation and Visualization
5
Apply your metrics in practice
4
Align your metrics to outcomes
3
What’s in a metric ?
2
So, what’s the problem ?
1
41
42. View all your ESG metrics on a single dashboard
Achieving a ‘single pane of glass’
across your metrics can give you true
insight.
Therefore, your approach to
instrumentation of your metrics and
KPI’s is important.
Instrumentation
43. 43
Identify your tech stack
Instrumentation Assembly
Assemble, Configure, Visualize
Road Test
Create Metric Building Blocks
Feedback
44. Straw Man’s View on the How…… Metrics Accelerator
Production
Monitoring
Sandbox
Events, Runtime Statistics
Logging
Basic Alerts
● For Applications and Servers
from Anypoint Monitoring
API Alerts
● Policy Violation
● Request Count
● Response Code
● Response Time
● Contract alerts
Runtime Alerts
● CPU Usage
● Deployment Failed
● Worker not Responding
● Memory Usage
● Custom Application
Notifications
● (Error notifications &
Operational Milestone alerts)
Functional API
Events
Notification
Ticketing
Elastic Stack for API Governance, Platform
Monitoring (Events) and Product Owner
Insights
Governance KPI’s
● API Policies Enforced
● Exchange Content Completed
● Tags, Domains, Categories
assigned
● Degree of Reuse
● Domain Usage
● Deployment Velocity
45. 7 Steps to Effective API Insights
Instrumentation and Visualization
5
Apply your metrics in practice
4
Align your metrics to outcomes
3
What’s in a metric ?
2
So, what’s the problem ?
1
45
Measure
6
46. Step 6 – Measure Outcomes
Different points of measure in your API ecosystem can exist around People, Process and Technology
Application Platform
Application
Cloud People
API Lifecycle
47. 7 Steps to Effective API Insights
Instrumentation and Visualization
5
Apply your metrics in practice
4
Align your metrics to outcomes
3
What’s in a metric ?
2
So, what’s the problem ?
1 47
Measure
6
Evangelize
7
48. Socialise the
goals, the journey,
the benefits of API
Insights.
Shout the
successes!
Identify effective
means of
proactively
informing KPI’s,
SLA’s and Need
for Course
Correction
Gather feedback,
ensure its
continuous.
Measure
behavioral
change
48
Step 7 - Evangalize
People you want to care probably won’t if you don’t educate, inform, give ownership
50. Collect metrics when
they are generated.
Some metrics are not
available later.
Retention of metrics
helps identify
trends.
Trends show
patterns of
behavour and this
can help your
focus.
Drive a positive
feedback loop into
your ecosystem
through alerts and
triggers.
50
One More Thing….. Timing and
Retention
52. Example #1: Measuring Usage of the Platform
5
2
• The What ?
1. Organisations and Business Groups – who
are your consumers ?
2. Number of reusable assets on Exchange
3. Total number of reusable API’s
4. Registered or active users of your platform
by type, role, business group, etc.
• The Why ?
1. Understand the usage of your platform,
where its high, where its needing C4E
focus
2. Monitor asset growth over time
3. Monitor and assist usage over time – who
are your ‘customers’ ?
53. Example #2 : API Usage by Organization, Top Used APIs
• The What ?
• Usage by different parts of the business
• Degree of reuse by API or Category
• The Why ?
• Low reuse can give insight into how
discoverable, flexible an API
• Low reuse can help identify where consumers
are seeing gaps in your API ecosystem
• Reuse monitoring can help identify
opportunities for further business enablement
54. Example #3: API by Business Domain
5
4
• The What ?
• Breakdown consumption by domain, type and
rating
• The Why ?
• Provides insight into usage across domains
• Insight into reusability across the enterprise vs
domain specific assets
• Insight into consumer feedback to drive further
enablement
55. Example #4: Using KPI’s for
Governance and Quality Improvement
• The What ?
• Identify gaps in Design, Non-Functionals,
Testing, etc.
• Monitor effectiveness of standards,
principles, patterns and their implementation
• Ensure platform configurations which enforce
NFR’s are being applied (e.g. Policies)
• Ensure Exchange documentation is up to
date
• The Why ?
• Gaps in quality can affect delivery
• Gaps in Non-Functionals can expose API’s to issues
around Security, Reliability, Scalability
• Non-Categorisation of assets can affect
discoverability, reusability
57. Example #6: Platform Capacity Monitoring
• The What ?
• Understand platform capacity usage and
consumption
• The Why ?
• Insight into platform consumption ensures effective
use of license
• It can also give insight into potential reuse
challenges or gaps in overall design strategy of the
API ecosystem (e.g. DDD)
58. Example #7: Defect Management
5
8
• The What ?
• Cross align API insights with incident
management insights
• Reliant on integration with your incident
management platform (e.g. ServiceNow)
• The Why ?
• Insight into Build, Test and Runtime
defects across API’s, Severity, etc.
63. 63
● Share:
○ Tweet using the hashtag #MuleSoftMeetups
○ Invite your network to join: https://meetups.mulesoft.com/mumbai/
● Feedback:
○ Fill out the survey feedback and suggest topics for upcoming events
○ Contact MuleSoft at meetups@mulesoft.com for ways to improve the program
○ Contact your organizers to suggest topics
○ Tweet your organizers & MuleSoft Community @sawantakshata02,
@@561d1102f4154f8
What’s next?
65. 65
● Anypoint Platform APIs can only be authenticated via username & password.
○ True
○ False
Quiz
66. 66
● When measuring metrics, what are 2 key measures that can help achieve success in your API
landscape?
Quiz
67. 67
● Name at least one Operational and one Consumer Metric?
Quiz
68. 68
● Share:
○ Tweet using the hashtag #MuleSoftMeetups
○ Invite your network to join: <URL of your Meetup site>
● Feedback:
○ Fill out the survey feedback and suggest topics for upcoming events
○ Contact MuleSoft at meetups@mulesoft.com for ways to improve the program
What’s next?