Skip to content

Commit

Permalink
tracking pixel custom domain
Browse files Browse the repository at this point in the history
  • Loading branch information
ken-scarf committed Feb 18, 2025
1 parent d40dfaa commit 9de98bd
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 1 deletion.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ In the next section, you will create a tracking pixel that can be added to your
### Creating a Tracking Pixel for Your Package

How the Package-Pixel Pair Works:

- Package Distribution: When users install your package, metadata like download source, volume, and timing can be routed through Scarf's infrastructure (e.g., via Scarf Gateway).
- Pixel Integration: The pixel is included in the package or its associated documentation. When the pixel is triggered, it records usage events, similar to a web analytics tracker.

Expand Down
15 changes: 14 additions & 1 deletion docs/web-traffic.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Not relying on cookies has a some powerful effects:

## Creating a pixel

Head to your Scarf dashboard and click the + in the top-right corner, then click `New Pixel`. Give your pixel(s) a name, select an Owner to manage its scope (your organization recommended), and optionally attach it to a package you manage on Scarf. This package attachment is optional and is solely used for visualizing the statistics for a pixel and a package together on the same page within the Scarf dashboard.
Head to your Scarf dashboard and click the + in the top-right corner, then click `New Pixel`. Give your pixel(s) a name, select an Owner to manage its scope (your organization is recommended), and optionally attach it to a package you manage on Scarf. This package attachment is optional and is solely used for visualizing the statistics for a pixel and a package together on the same page within the Scarf dashboard.


![scarf v](https://github.com/user-attachments/assets/11889d39-dcd2-4dac-80d5-8af0014e79db)
Expand All @@ -21,6 +21,19 @@ Head to your Scarf dashboard and click the + in the top-right corner, then click

Pro Tip: All new pixels default to “Medium” importance. It’s a good idea to let Scarf start capturing data before determining if that needs to change.


By default, pixels are hosted in `static.scarf.sh`. You can use your own domain by filling in the domain field.

![create pixel with custom domain](./assets/pics/scarf-pixels/create-a-pixel-with-custom-domain.png)

After creating the pixel with a custom domain, instructions will be provided on how to verify your domain.

![pixel custom domain instructions](./assets/pics/scarf-pixels/pixel-custom-domain-instructions.png)

The speed of domain verification will depend on how fast your DNS provider propagates the domain changes. When your domain is verified you should see this indicator.

![pixel custom domain verified](./assets/pics/scarf-pixels/pixel-domain-verified.png)

Once created, you can access this Pixel in the Tools dropdown, under Pixels. Here, you will see a full list of all your existing Pixels.

## Embedding and using the pixel
Expand Down

0 comments on commit 9de98bd

Please sign in to comment.