{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-user-guide/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"API usage analytics","description":"Access documentation, use cases, and technical guides for Lusha. Learn how to query our comprehensive dataset of business profiles and company information using our three main endpoints.","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"api-usage-analytics","__idx":0},"children":["API usage analytics"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The API Usage Analytics dashboard shows a breakdown of your credit consumption by endpoint and API key. This lets you monitor credit usage, investigate spikes, and optimise your integrations without needing to contact Support."]},{"$$mdtype":"Tag","name":"blockquote","attributes":{"className":"callout-note"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["💡 Note: This feature is available to Admins on paid plans only."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"how-to-access-api-usage-analytics","__idx":1},"children":["How to access API usage analytics"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Log in to your ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://dashboard.lusha.com/dashboard"},"children":["Lusha dashboard"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Click your name in the top-right corner."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Go to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Analytics"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Click the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Credit usage"]}," section."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Use the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Source"]}," or ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["User"]}," tabs to filter by API origin, or scroll to the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["API credit usage"]}," table for a detailed technical breakdown."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"filtering-your-api-data","__idx":2},"children":["Filtering your API data"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Click the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["All API keys"]}," dropdown on the right side of the API section and select a specific key, or keep it on All API keys for a full account view."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Use the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Time range"]}," selector (Daily, Weekly, Monthly) to see when credits were used."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Check the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Endpoint"]}," column to see which specific actions (such as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v2/person"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v2/company"]},") are driving consumption."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"understanding-the-consumption-table","__idx":3},"children":["Understanding the consumption table"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The table at the bottom of the page provides the most granular view:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Endpoint"]}," - the specific API path called (e.g., ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prospecting/contact/enrich"]},")"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Number of calls"]}," - total requests made to that endpoint"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Credits consumed"]}," - actual credits deducted for those calls"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["% of total usage"]}," - a visual bar showing how much of your total API spend this endpoint represents"]}]},{"$$mdtype":"Tag","name":"blockquote","attributes":{"className":"callout-note"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["💡 Note: API usage is tracked at the account level. Credits are drawn from your organisation's total pool, regardless of which API key made the call."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"if-you-dont-see-the-api-section","__idx":4},"children":["If you don't see the API section"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Permissions"]}," - you must be logged in as an Admin. Regular users don't have access to account-wide API billing data."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Plan"]}," - API access and advanced analytics aren't available on the Free plan."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["No activity"]}," - if no API calls were made in the selected time range, the table will appear empty."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You're all set - now you have full visibility into how your API credits are being used."]}]},"headings":[{"value":"API usage analytics","id":"api-usage-analytics","depth":1},{"value":"How to access API usage analytics","id":"how-to-access-api-usage-analytics","depth":2},{"value":"Filtering your API data","id":"filtering-your-api-data","depth":2},{"value":"Understanding the consumption table","id":"understanding-the-consumption-table","depth":2},{"value":"If you don't see the API section","id":"if-you-dont-see-the-api-section","depth":2}],"frontmatter":{"title":"API usage analytics","description":"How to access and interpret the API Usage Analytics dashboard to monitor credit consumption by endpoint and API key.","seo":{"title":"API usage analytics"}},"lastModified":"2026-06-25T08:28:34.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/user-guide/lushas-api/api-usage-analytics","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}