user.getStats
Returns global statistics for your user.
Last updated
Returns global statistics for your user.
Last updated
Note:
requests must be made to https://api.flipsnack.com/v1
the embedded collection may not function properly while the collection is in the processing state or the PDF document conversion is incomplete
For complete list of error codes and messages go to API status codes section.
Name
Type
Description
apiKey (required)
string
The API key provided for your user. If it is not specified, the request will return the error code "30 - Missing mandatory parameter". If the key is incorrect the request returns the error code "41 - Invalid credentials".
signature (required)
string
The signature must be calculated by you and added to the request. See How to sign a request for more information. If the parameter is missing the request will return with error code "30 - Missing mandatory parameter". If the signature is incorrect the request will return the error code "44 - Invalid signature".
action (required)
string
The API method that should be called. In this case the value should be user.getStats. If it is not specified, the request will return the error code "30 - Missing mandatory parameter".
Name
Type
Description
impressions
number
The number of impressions for all the collections. Impressions are counted each time the player is loaded.
views
number
The number of views for all the collections. Views are counted each time a user interacts with the player.
time_spent
number
The total time spent is measured in seconds and shows how much time people spend viewing the flipbooks.
downloads
number
The number of times your documents were downloaded from your collections.
api_uploads_left
number
The number of uploads left via the API.