Skip to main content
GET

Authorizations

Authorization
string
header
required

A key generated from Settings → Developers, sent as Authorization: Bearer dr_live_<12 hex chars>_<64 hex chars>. Keys carry explicit scopes — each endpoint states the one it requires. The full key is shown exactly once at generation time and cannot be retrieved again; only the keyId prefix is shown afterward. A revoked key fails auth on its very next request.

Path Parameters

id
string<uuid>
required

The document's id.

Query Parameters

from
string<date-time>
required

Start of the range, inclusive. RFC 3339 with Z or a numeric offset.

to
string<date-time>
required

End of the range, exclusive. RFC 3339 with Z or a numeric offset. At most 366 days after from.

compare
enum<string>

Set to previous to also return the same numbers for the window of identical length right before the range. The only accepted value.

Available options:
previous

Response

The aggregates for the range, plus the previous window when compare=previous was sent.

The four analytics numbers for one window.

views
integer
required

Visits that started in the window, excluding your own.

uniqueVisitors
integer
required

Distinct viewers across those visits.

leads
integer
required

Distinct leads (by email, or phone for phone-only leads) first seen in the window.

conversionRate
number
required

leads / uniqueVisitors, 4 decimals; 0 with no visitors; can exceed 1.

documentId
string<uuid>
required

The id of the document the numbers are for.

from
string<date-time>
required

Start of the range as requested, in UTC (inclusive).

to
string<date-time>
required

End of the range as requested, in UTC (exclusive).

previous
object

The same four numbers for the previous window. Only with compare=previous.

previousFrom
string<date-time>

Start of the previous window, UTC (inclusive); from minus the length of the range. Only with compare=previous.

previousTo
string<date-time>

End of the previous window, UTC (exclusive); equal to from. Only with compare=previous.