Getting started with API Observability and Analytics

1.

Install Server Integration

Install a server SDK or API gateway plugin to automatically log API traffic.

View Integrations

2.

Create Users/Companies

Create users/companies in Moesif using moesif-browser-js or the API

View Company Profiles

3.

Install a Client Integration

Install moesif-browser-js or Segment to track customer actions within your apps.

View Integrations

With API observability and analytics, you can gain business metrics to better understand your API consumption patterns and ship better API products. You can also gain operational metrics to troubleshoot issues with your API.

The first step is to install a server integration to log API traffic to Moesif. Moesif has integrations with most API gateways and web frameworks providing. You can mix and match multiple integrations together to gain a unified view of your API usage even if you have different API management tools and technologies. Server integrations are low-code and automatically instrument your application. Moesif is compatible with OpenTelemetry as well.

For understanding client consumption patterns, you should ensure your server integration is configured to also identify the user or company. For most API gateway plugins, this is handled automatically. However, the integrations for web frameworks provide an identifyUser and identifyCompany option to define how to extract this from your request context.

Diagram of Moesif Server Integration

While not required, it’s strongly recommended to also sync your customer data to Moesif. This can include the user email, company name, subscription info, etc. Moesif has connectors for tools like Segment, Hubspot, and Stripe which can sync this data automatically. You can also send this data directly from your app using [moesif-browser-js] or via an API lib

Lastly, you can also install a client integration like moesif-browser-js to track web activity such as sign up events, viewing doc pages, etc. This ensures you can track the end-to-end customer journey from sign up to first API call.

Updated: