PapermarkDocs
APIReferenceAnalytics

List views for a share link

Returns cursor-paginated view records for a link in reverse-chronological order.

GET
/v1/links/{id}/views

Authorization

bearerAuth analytics.read
AuthorizationBearer <token>

Dashboard-issued token (pm_live_... / pm_test_...) or OAuth-issued access token.

In: header

Scope: analytics.read

Path Parameters

id*string

Query Parameters

limit?integer
Default25
Range1 <= value <= 100
cursor?string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.papermark.com/v1/links/string/views"
{
  "data": [
    {
      "id": "clxview1234567890",
      "link_id": "string",
      "document_id": "string",
      "dataroom_id": "string",
      "viewer_email": "jane@acme.com",
      "view_type": "DOCUMENT_VIEW",
      "viewed_at": "2019-08-24T14:15:22Z",
      "downloaded_at": "2019-08-24T14:15:22Z",
      "download_type": "string"
    }
  ],
  "next_cursor": "string"
}
{
  "error": {
    "code": "unauthorized",
    "message": "Missing bearer token.",
    "doc_url": "https://papermark.com/docs/api/errors#unauthorized",
    "details": null
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "Missing bearer token.",
    "doc_url": "https://papermark.com/docs/api/errors#unauthorized",
    "details": null
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "Missing bearer token.",
    "doc_url": "https://papermark.com/docs/api/errors#unauthorized",
    "details": null
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "Missing bearer token.",
    "doc_url": "https://papermark.com/docs/api/errors#unauthorized",
    "details": null
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "Missing bearer token.",
    "doc_url": "https://papermark.com/docs/api/errors#unauthorized",
    "details": null
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "Missing bearer token.",
    "doc_url": "https://papermark.com/docs/api/errors#unauthorized",
    "details": null
  }
}

Analytics

Aggregate analytics backed by Tinybird. Subject to a tighter per-minute rate limit.

Document analytics

Aggregate analytics for a single document: total views, unique viewers, total read time, per-page average duration. Backed by Tinybird — subject to a tighter per-minute rate limit than other endpoints.