Our platform offers three distinct ways to access and analyze your audience data: the Dashboard, Raw Data Downloads, and the API. Each serves different needs and levels of detail. Below, we’ll guide you through how they correspond and when to use each.
1. Dashboard Overview
The Dashboard provides a summary view of your audience data, designed for quick and easy interpretation.
-
Key Features:
-
Readable Format: The data is slightly rounded for better readability.
-
Ideal for high-level insights and quick decisions.
-
Perfect for presentations or reporting to stakeholders who don’t require detailed raw data.
-
Dashboard specifics:
-
Including/Excluding Staff: Data tagged as "staff" is filtered out by default. You can see the whole data with staff or only staff data.Choose the needed perception in Filters.
-
Unique Visitor Count: The Total Visitors metric represents the count of unique visitors detected by the sensor on a specific day.
-
Contact Count: The Total Contacts metric shows the total number of interactions visitors had with the camera, whether it’s the same individual or different people.
-
Read more about the Dashboard and how each graph can be used here: Guide - Audience Analytics data application guide.pdf
2. Raw Data Downloads
To get the raw data click on Send report in your platform's dashboard. It will be sent to the specified email.
This is how the raw data spreadsheet looks like:
The raw data is available for detailed offline analysis and comes with three key tabs:
-
Visitors Tab:
-
Shows the total unique visitors detected during the selected period.
-
Correlates with the Total Visitors metric on the Dashboard.
-
Contacts Tab:
-
Displays the total contacts (not unique visitors), representing the number of times visitors interacted with the camera.
-
Correlates with the Total Contacts metric on the Dashboard.
-
Content Tab:
-
Provides data about content shown on your screens, including:
-
Who viewed the content.
-
How long they engaged with the content.
-
Helps you evaluate the effectiveness of displayed content.
-
When to Use:
-
For offline processing or advanced visualization in external tools.
-
When you need to cross-reference visitor counts, engagement, and campaign effectiveness.
-
Note on Comparison with Raw Data:
-
If you compare Dashboard data with raw data, ensure you exclude IDs tagged as "staff" from the raw data to match the Dashboard metrics.
3. API
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.
To get detailed instructions on API, please see this file public-api_v1-11.en.html (API Description) and API help.pdf or contact our support team.
To get the latest version of DISPL API, please contact our support at support@displ.com
Comments
0 comments
Article is closed for comments.