Third-party softwares may use the DISPL technology to integrate it's groundbreaking face metrics detection into their processes. The other way around is also possible: to integrate third-party softwares information into DISPL for the end-user convenience.
 

Integrating DISPL's Visitor Insights Report information via API

First of, you will need a API key to access the report data contained in your DISPL Content Management System. You may purchase an API key via the DISPL Sales Team and also via DISPL Support Team.

The API offers the most detailed and customizable access to your data. It’s perfect for developers and advanced users.

Key Features:

• Granular Data Access: Retrieve raw records with extensive metadata like face_quality, demographics, and engagement.
• Pagination Support: Handles large datasets with limit and offset parameters for batch processing.
• Data Filtering: Use filter face_quality to exclude low-value data.
• Ideal for custom integrations with BI tools or systems.
• When you need to automate reporting.
  
   

Example Workflow

Use the API query to fetch data (e.g., visitor sessions). A request of this type will return 1,000 sessions within the specified time frame:

     { 
       "start": "2024-10-28T00:00:00Z", 
       "end": "2024-10-28T23:59:59Z", 
       "tracks": true, 
       "face_quality": true, 
       "limit": 1000, 
       "offset": 0 
     } 

If the total exceeds 1000 records, query the remaining data using the offset parameter:

     { 
       "limit": 1000, 
       "offset": 1000 
     } 
 

Combine the queries into a single dataset for analysis. Filter out low-value data such as records with "face_quality": null.
 

How API Data Corresponds to Other Sources:

The Dashboard and raw data exclude records with face_quality marked as null and any tagged as "staff."
The API provides full access, including dropped records, if needed.
 

Downloads

To get detailed instructions on API, please see these two files: 

1. public-api_v1-11.en.html (API Description) - please download this file to your device and open it. 
   
2. API help.pdf 
   

Contact our support team to get the latest version of DISPL API.