Analytics

Get workspace analytics

One aggregate for the whole workspace, same shape as code analytics plus top_codes ranked within the same window.

get/workspace/{workspace_id}/analytics/

Request

  • Base URL: https://hovercode.com/api/v2
  • URL: https://hovercode.com/api/v2/workspace/{workspace_id}/analytics/
  • Auth: API key in header Authorization

Path parameters

workspace_idstring uuid required

Workspace ID (from account settings).

Query parameters

daysinteger

Rolling look-back in days (1-365).

startstring

Window start (ISO date or date-time).

endstring

Window end, inclusive (ISO date or date-time).

topinteger

Number of top codes (default 10, max 100).

Response

OK

qr_code_idstring uuid
period_daysinteger
startstring date-time
endstring date-time
total_scansinteger
unique_scansinteger
workspacestring uuid

Changes

No recorded changes to this operation across all 1 revision of this API.