Enhance Your Business Intelligence with Open Source Usage Metrics
Overview
Exporting data tracked by Scarf is essential for analytics, reporting, and integration with other tools. Scarf adds open-source usage metrics to the data you already collect, giving you a fuller picture of how your project is used. This helps you monitor trends, measure impact, and make better data-driven decisions.
In this playbook, we’ll show you how to export data from Scarf, what data is exported, and how to make use of any available integrations.
What you’ll need:
- A paid plan in Scarf
- Scarf Pixels or Packages already set up. For help getting started, check out our Getting Started Guide on Pixels or Packages.
Step 0: Choose what data you want to export
You have different data export options:
- Package event data: This includes details about who accessed your packages or files from a custom domain. You can track Docker, npm, or Python packages, any file downloads, or any shortened link. Additionally, this includes telemetry data from within your application associated with a Scarf package, if already configured.
- Pixel event data: This includes information about README files, documentation, or any web property where you can embed Scarf's <img> tag. It shows which businesses are viewing the content, their location, and which parts of the web page they are focusing on.
In both package and pixel event data you export all event-related data for your package or pixel, including browser, OS, location, associated company, etc.
- Company data: You will export all the company names that have interacted with your organization, including information like their funnel stage at the time of the export, total events, date of the first and last event, etc.
You can export this data directly from the Scarf web application or set up exports via the API. The following steps will guide you through both options.
If you want to export data for a specific Package or Pixel, simply follow the same steps, selecting the specific Package or Pixel you wish to export.
Export Manually from the Scarf App
Before we dive into the steps, it's important to note that you can customize your data export. You can choose to export data for a different time range or focus on a specific package or pixel rather than exporting all package events or pixel events. In this playbook, we’ll cover exporting all Package and Pixel events and Company Events for the last month.
Step 1: Export Package and Pixel Event Data
Go to the Scarf App. If you have already created Scarf Pixels or Packages, you will be presented with the following screen:
As you can see, you now have the option to export all package-related data for the packages you've set up. You can learn more about how to set up a Scarf Package.
Click Export Packages Data and the data will download as a .csv file. This will export all data for the default period over the past month.
Similarly, you can export Pixel event data. Scroll down to Documentation Views. Click Export Pixel Data.
Step 2: Export Company Data
Starting from the Scarf App home screen, go to the Tools dropdown, and then click Company Insights.
From this screen, you can click Export Company Data and a similar .csv file will be downloaded with all the companies that engaged with your Packages and Pixels.
Pro tip: Before exporting, set your preferred Date Range to customize the time frame of your export.
Step 3: Use the Exported Data
Now that you have the data, it's time to import it into third-party platforms such as Salesforce, Hubspot, Common Room, ClickHouse, PostgreSQL, MongoDB, and others.
Go to the third-party platform and consult its documentation to understand the required data format. Adjust the .csv file accordingly to ensure compatibility with the platform's specifications.
Here is some documentation from the main platforms to help with this process:
The following examples illustrate Hubspot’s import process:
Depending on the technical resources at your disposal, you can also consider connecting the data through API endpoints to automate data migration and customize it to meet your specific needs.
Set Up One-Off Exports or Schedule Daily Exports through the Scarf API
Step 4: Set Up your S3 Account
Create an S3 Bucket in your AWS account and grant permissions to both Scarf and the tool you’ll be using to receive data. You can learn more about this in our Scarf Documentation.
In this case, we will be creating an S3 Bucket to export data from Scarf to Pocus. You can learn more about this integration here.
Step 5: Set Up Data Exports in your Scarf Account
Go to your organization, click the dropdown menu in the upper right corner and go to your organization Settings.
Click in the Exports section. From this section, you can manage your current export setups or create new ones. Here, you have the flexibility to either schedule daily exports or set up a one-off export. You'll see a series of required fields to help you configure your export. For details on each field, refer to our API documentation. This will allow you to import objects into your CRM (Salesforce or Hubspot).
Step 5: Configure the Desired Tool to Read Scarf Data Exported from S3
Once the data is in your S3 Bucket, configure your desired tool to import the data from the bucket. This may involve setting up a data import tool or using built-in tool features to pull data from your S3 Bucket into your CRM, or other system.
In your CRM, you'll likely want to add Scarf data to the accounts you're tracking. This might involve creating custom fields to store this data, which could be integrated into your existing lead-scoring mechanisms. Additionally, you can incorporate Scarf's funnel stages into your CRM to enhance your tracking and analysis of user engagement.
For this step, you’ll need to refer to the desired tool’s documentation.
Combining the data from open source projects with your existing dataset, can provide you with a panoramic view of your ecosystem and user behavior. This allows you to make informed product decisions, identify growth opportunities and refine business strategies.
If you haven’t already, sign up to try Scarf for free.