Get the visit statistics

GET /api/2.0/settings/statistics/visit

Request

Returns the user visit statistics for the period specified in the request.

Authorization

An API key is a token that you provide when making API calls. Include the token in a cookie parameter called asc_auth_key.

Example: asc_auth_key=864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string: Can be one of: application/json, text/json, text/plain.

Query

fromDateobject

Start period date

utcTimestringformat: date-time
timeZoneOffsetstringformat: date-span

toDateobject

End period date

utcTimestringformat: date-time
timeZoneOffsetstringformat: date-span

Examples

GET /api/2.0/settings/statistics/visit?fromDate=%7B%22utcTime%22%3A%222008-04-10T06%3A30%3A00.0000000%2B04%3A00%22%2C%22timeZoneOffset%22%3A%2200%3A00%3A00%22%7D&toDate=%7B%22utcTime%22%3A%222008-04-10T06%3A30%3A00.0000000%2B04%3A00%22%2C%22timeZoneOffset%22%3A%2200%3A00%3A00%22%7D HTTP/1.1
Accept: application/json
Host: example.com

curl --request GET \
  --url 'https://example.com/api/2.0/settings/statistics/visit?fromDate=%7B%22utcTime%22%3A%222008-04-10T06%3A30%3A00.0000000%2B04%3A00%22%2C%22timeZoneOffset%22%3A%2200%3A00%3A00%22%7D&toDate=%7B%22utcTime%22%3A%222008-04-10T06%3A30%3A00.0000000%2B04%3A00%22%2C%22timeZoneOffset%22%3A%2200%3A00%3A00%22%7D' \
  --header 'Accept: application/json'

Responses

200

List of point charts

displayDatestring: Display date
datestringformat: date-time: Date
hostsintegerformat: int32: Hosts
hitsintegerformat: int32: Hits

401

Unauthorized

403

Forbidden

Get Help

If you have any questions about ONLYOFFICE DocSpace, try the FAQ section first.
You can request a feature or report a bug by posting an issue on GitHub.
You can also ask our developers on ONLYOFFICE forum (registration required).