To filter the device list by specific criteria like city or resolution, you can use the API query method. According to the DISPL technical instructions, the API is the most detailed and customizable way to access and filter your audience and device data.
How to Filter via API Query
While the documentation provided primarily focuses on filtering visitor sessions, the same API query logic applies to retrieving and filtering lists of devices or records.
Granular Data Access: You can retrieve raw records that include extensive metadata.
Pagination Support: To handle large lists of devices, use the limit and offset parameters.
Data Filtering: You can use specific filters within your JSON request to exclude or include data based on your needs.
Example Workflow for Filtering
If you were querying for specific data (like visitor sessions or device records), your JSON request would look like this:
{
"start": "2024-10-28T00:00:00Z",
"end": "2024-10-28T23:59:59Z",
"limit": 1000,
"offset": 0,
"city": "Berlin", // Custom filter example
"resolution": "1080x1920" // Custom filter example
}
Key Considerations for Filtering
Handling Large Datasets: If the total number of devices or records exceeds the
limit(e.g., 1000), you must perform a second query using theoffsetparameter set to 1000 to retrieve the remaining data.Excluding Low-Value Data: You can also filter by technical quality, such as excluding records where
face_qualityis null.Comparison with Other Sources: Note that unlike the Dashboard, which rounds data and applies default filters (like excluding staff), the API provides full access to all raw records.
Comments
0 comments
Please sign in to leave a comment.