> ## Knowledge Base Index
> Fetch the complete knowledge base index at: https://help.vturb.com/sitemap.xml
> Use this file to discover available pages before exploring further.
> Pure-Markdown content can be obtained by appending a '.md' suffix to the content URLs listed in the sitemap (without the trailing slash).

# Analytics API

If you want to integrate VTurb Analytics metrics with other tools or custom reports, you can use our public Analytics API.

# 📚 Official Documentation

**The documentation is available at this link: [https://vturb.gitbook.io/analytics-api/pt](https://vturb.gitbook.io/analytics-api/pt)

There, you’ll find:
* How to generate and use your API key (authentication)
* Available endpoints (plays, views, retention, etc.)
* Parameters to filter data (by video, date, traffic source)
* Usage examples with curl and JavaScript
* API response structure

# 🔑 How to generate your API key

1. Go to your VTurb dashboard

![](https://storage.crisp.chat/users/helpdesk/website/-/3/9/0/a/390a843820d6ba00/image_fmaf7d.png)

2. Navigate to **Settings > Analytics API** and click on **"Generate New API Key"**

![](https://storage.crisp.chat/users/helpdesk/website/-/3/9/0/a/390a843820d6ba00/image_1g1or8y.png =1052xauto)

 **Important:** Never expose your key in public code (like scripts in the browser)

# 👨‍💻 **What is it for?**

The API is ideal for those who need to:
* Integrate VTurb data with BI tools (such as Power BI, Google Data Studio, etc.)
* Automate reports
* Create custom dashboards
* Consolidate data from multiple accounts

### ➡️ Examples of Automations with N8N
We’ve selected some automation examples for you to connect our API using the N8N tool.
[__Click here to access the drive with the templates!__](https://drive.google.com/drive/folders/10Y8E2X93r9dB70Xs-EmtWYCLB2hknnyU)

# ⚙️ **Usage Tips**

* Always use filters and pagination in your requests to avoid overload
* Use tokens carefully and store them securely

If you have questions or suggestions about the API, If you have any questions, contact us via [Chat](https://go.crisp.chat/chat/embed/?website_id=064e812f-2997-4b04-978b-b2516f33e989) or [WhatsApp](https://wa.me/5548991786092).