GET /Usage/report/

Class: Usage, Method: report

Sends a document usage report. Returns true on success or an error on failure.

Path Parameters

Name Type Type Required Default
response_format Response data format. Default is json. String json

Query Parameters

Name Type Type Required Default
documentId Document's ID for which usage will be reported. Integer
accessTime The exact time at which the document has been accessed. It could be different from the current, reporting time. String
email - optional, to allocate usage to specific email profile String
projectCode - optional, to allocate usage to specific project code String

Responses

Status Code Type Type
200 Returns response result. Bool
400 Returns API error. ApiError[]
API Query Builder
Query
Query Result