Skip to content

Commit 6e15f2d

Browse files
authored
docs: align publisher analytics export schema (#2384)
* docs: align publisher analytics export schema * Apply suggestion from @Pierrci
1 parent d0c261f commit 6e15f2d

1 file changed

Lines changed: 6 additions & 6 deletions

File tree

docs/hub/publisher-analytics.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -62,20 +62,20 @@ Records are ordered chronologically and provide a daily granular view of downloa
6262
> [!WARNING]
6363
> This feature is an add-on for the <a href="https://huggingface.co/contact/sales?from=enterprise" target="_blank">Enterprise Plus</a> plan.
6464
65-
As an advanced feature, Hugging Face can export anonymized, request-level access logs for all of the models and datasets published by your organization. Each line represents a single download request (including HEAD and partial requests), giving you full granularity over your models and datasets' download data.
65+
As an advanced feature, Hugging Face can export anonymized, request-level access logs for all of the models and datasets published by your organization. Each line represents a single download-related request, giving you full granularity over your models and datasets' download data.
6666

67-
Your team is responsible for ingesting these logs and running computations on them — for example, to deduplicate downloads to get unique downloader counts.
67+
Your team is responsible for ingesting these logs and running computations on them. The export intentionally includes raw HTTP status codes and methods so you can classify `HEAD`, partial-content, redirect, and other request patterns based on your own analytics needs.
6868

6969
| Column | Description |
7070
| -------------- | ------------------------------------------------------- |
7171
| `timestamp` | Request timestamp |
72-
| `requestType` | Type of download request (`GET`, `HEAD`, partial/range) |
72+
| `status` | HTTP status code (for example `200`, `206`, `302`, `307`, `304`) |
73+
| `method` | HTTP method (for example `GET`, `HEAD`) |
7374
| `repoName` | Full repo name (e.g. `nvidia/segformer-b0`) |
74-
| `repoType` | `model` or `dataset` |
75+
| `repoType` | Repository type: `model`, `dataset`, or `space` |
7576
| `hashedUserId` | Non-reversible hash of user ID (if authenticated) |
7677
| `hashedIp` | Non-reversible hash of IP address (if unauthenticated) |
7778
| `country` | Country ISO code |
78-
| `region` | Region name |
79-
| `isInternal` | Whether the request comes from an HF internal service |
79+
| `region` | Region or city name |
8080

8181
As it requires setting up a custom data export pipeline on our side (custom Elastic index, etc), this is only available as an add-on to Enterprise Plus.

0 commit comments

Comments
 (0)