Image Views API
Image Views API
Image Views API
The Image Views API endpoint will provide a list of personalised views for the provided image template.
If no from date is provided the API will provide all views for the image template since the last call.
This API endpoint is intended to be polled for new image views, to provide prospect details, to trigger further automation.
Base API URL:
https://app.hyperise.io/api/v1/regular/image-impressions?api_token=<your_token>To use the API, you must first create an API token in the Settings area and use this token with all api requests.
Input:
Label | Key | Type | Required |
API Token | api_token | String | Yes |
Image Template Hash | image_hash | String | Yes |
From Date | date_from | Date ( Y-m-dTH:i:sZ ) | No |
To get the image template hash, you can use this API: https://support.hyperise.com/api/List-Image-Templates-API to retrieve a full list of your Active image templates and their hash.
To get an image template hash manually, select the Get Image Code button within the image template and select the file name from within the image URL, as illustrated below:
The API will provide a JSON output.
Example Output:
Key | Example |
id | 3 |
business_name | Hyperise |
image_name | |
image_url | |
enrichment_data | |
ian@hyperise.com | |
title | Mr |
first_name | Ian |
last_name | Naylor |
gender | Male |
job_title | Co-founder |
profile_url | |
business_name | Hyperise |
category | SaaS |
business_address | |
street | |
street2 | |
city | |
state | |
zip | |
country | |
business_lat | |
business_long | |
business_phone | |
business_website | |
website_screenshot | |
logo_url | |
custom_image_1 | |
custom_image_2 | |
custom_image_3 | |
custom_text_1 | |
custom_text_2 | |
custom_text_3 | |
custom_text_4 | |
custom_text_5 | |
processed_at | 2020-01-27T10:46:00Z |
Discover other Hyperise APIs:
User Authentication - Authorise the API token.
List Image Templates - List all active Image templates for the authorised user.
Business Data - Add/Update/View prospect data for images to use.
Short Links - Create personalised Short Links.
Data Enrichment - provides enriched data from an email input.
Did this answer your question?