GET/api/v1/me/documents/{slug}/analytics/viewers

List viewers

Every view in the range, newest first: viewer (a signed-in viewer's name and email, or type: anonymous with a Visitor 3F2A name), started_at, active_s, completion (0–100 or null), location (city, region, country, timezone), system (device, OS and browser with versions, in_app, app: tab, pwa or embed), source, visit_n and acts; plus totals and breakdowns (country, city, device, os, browser, source). Filters: who (all, signed_in, anonymous), completion (any, low, mid, high, done), country, device, os, browser, source; own=1 includes your own views; internal=0 leaves out workspace members; offset and limit page. The owner, and for a workspace item its admins and editors; its viewers get access: counts with totals only.

API token required120 per minute per IPMCP: get_document_viewers

Guide: Who viewed it

Code samples and Try it

Path parameters

#
  • slugstringRequired

    The document's address: the part after markdrop.in/.

Query parameters

#
  • rangestring

    The period to count: 7d, 30d, 90d or all. One of 7d, 30d, 90d, all. One of 7d, 30d, 90d, all. Default "30d".

  • whostring

    One of all, signed_in, anonymous. One of all, signed_in, anonymous. Default "all".

  • completionstring

    One of any, low, mid, high, done. One of any, low, mid, high, done. Default "any".

  • owninteger

    From 0 to 1. Default 0.

  • internalinteger

    From 0 to 1. Default 1.

  • countrystring

    Up to 2 characters.

  • devicestring

    Up to 20 characters.

  • osstring

    Up to 40 characters.

  • browserstring

    Up to 40 characters.

  • sourcestring

    Up to 120 characters.

  • offsetinteger

    From 0 to 5,000. Default 0.

  • limitinteger

    How many to return. From 1 to 200. Default 50.

Responses

#
  • 200OK.
  • 401No token, or the token is revoked or mistyped.
  • 422The request didn't validate. detail lists each problem, with where it is (loc) and why (msg).
  • 429Too many requests from your IP address. Wait the seconds in Retry-After.
Did this page help?