Application Programming Interface (API)

Intel® Audience Impression Metrics Suite (Intel® AIM Suite) includes an interface for accessing your AIM Suite data that is also the pathway for merging AIM Suite data with other sources of data – facilitating the calculation of ROI and conversion ratios, for example.

Intel has a roadmap for adding features and expanding capabilities. We encourage third-party developers to build on the platform and expand the benefits even further. As a result, our solutions providers are finding exciting new ways to use AIM Suite – more than we ever imagined.

Intel provides three versions of the AIM Suite API (low-level socket-based, high-level socket-based, and HTTP), to give you the right capabilities for your specific needs and make it easy to create web and desktop applications that integrate with your account.

Low-level socket-based API
The low-level socket-based API provides access to detailed parameters about your audience, including:

• Face ID # (unique # per detected face)
• Gender
• Age bracket (Child, Young Adult, Adult, Senior)
• X, Y coordinate of the top-left corner of each detected face
• Width & height of each face
• Viewing time (in milliseconds)

High-level socket-based API
The high-level socket-based API helps paint an even broader picture of your audience by providing several extra audience parameters, including:

• Details for each detected viewer (parameters from low-level API)
• Total # of current viewers
• Face detected event
• Face lost event

HTTP API
The HTTP API returns information in a comma-separated values (CSV) format for each impression for your desired date range. The HTTP API is utilized by the customer’s web server pull the Intel hosted AIM Analytics server for this information.

• Date (YYYY/MM/DD)
• Impression Start Time (HH:MM:SS.MS)
• Viewing Time (in milliseconds)
• Date (YYYY/MM/DD)
• Gender (Male, Female, Unknown)
• Age (Child, Young Adult, Adult, Senior, Unknown)