Public API help

The Public API help file is a repository of all methods that can be called to retrieve data from your DISPL CMS platform's Insights & data section.

This means you can gather all informations such as visitor list, campaigns played, views, device status, and more, and apply it in many many ways. 

For example: you may use our API extension to display live visitor insights data in a public website. 
Or, another example: you may keep control all your campaign statuses via Microsoft PowerBI.  

Download the Public API help file

Attached to this article, you can download our latest version of the DISPL Public API help archive. This HTML file is meant to be downloaded and opened with your web browser, such as Google Chrome. 
Please check the bottom of this article for the link.

First steps

The api_domain must be changed to api.displayforce.ai.

Visitor List

POST > https://api.displayforce.ai/public/v1/stats/visitor/list

Retrieve visitor information.
Required request body with parameters. Parameters "start" and "end" are mandatory, others are optional.
Filtering by campaigns and devices is possible.
Paginated data output mechanism. A maximum of 1 000 visits can be returned in a single response.
For detailed information on request parameters, see Schema.

 

Download the API help archive here.