The Displayr API allows you to automatically create and update documents. See the Reference for technical details.
|Uploading and configuring a new document||This the process of automatically taking a raw data file (e.g. SPSS .sav file) and creating a document from it.
Automating this process makes sense if you expect to have many data files with a similar structure.
|Automatically updating a document with new cases|
This is the process you use to keep a document up to date with new raw data from a tracking study.
A much easier alternative to using the API is to instead insert a new data set in Displayr using Insert > Data > Data Set, selecting URL and then pasting the URL of the data file from a cloud storage service such as Dropbox - this data will then update automatically whenever you edit your document.
To instead use the API, you would use a process such as this periodically (e.g. daily):
- Consider using naming conventions so your scripts can identify classes of variable sets. For example, you could name your demographic questions "D1", "D2", etc.
- Check status codes in responses from Displayr. If you get a failure, e-mail the response body to yourself because it will contain an explanation of the error.
- Calls involving long scripts or large data files may take multiple minutes to complete. Make sure you don't time out prematurely.