Data Enrichment API

Data Enrichment API

Ash
Written by AshLast update 10 months ago

Data Enrichment API


This API endpoint will provide enriched data from an email input, with fallback data from a defined image template.


This API endpoint is intended to be used to ingest enriched email data into other platforms.


Base API URL:


https://app.hyperise.io/api/v1/regular/data-enrichment?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

Email

email

String

Yes



The API will provide a JSON output.


Sample of business object Output


{
    "id": 201587,
    "business_name": "Hyperise",
    "business_address": "London",
    "business_phone": "",
    "email": "info@hyperise.io",
    "website": "hyperise.io",
    "logo": {
    "file_name": "images/csv_businesses/logos/2019/03/12/image_1552374585_5448.png",
     "url": "https://storage.googleapis.com/growthlist-storage/app/images/csv_businesses/logos/2019/03/12/image_1552374585_5448.png",
     "width": 329,
     "height": 329
    },
    "phone": "",
    "title": "Mr.",
    "first_name": "Ian",
    "last_name": "Naylor",
    "gender": "male",
    "job_title": "Founder",
    "profile_image": {
    "file_name": "images/csv_businesses/profile_images/2019/03/12/image_1552374585_1215.jpeg",
    "url": "https://storage.googleapis.com/growthlist-storage/app/images/csv_businesses/profile_images/2019/03/12/image_1552374585_1215.jpeg",
     "width": 225,
     "height": 225
    },
    "created_at": "2019-03-12 07:09:45",
    "updated_at": "2019-03-12 07:09:45"
}




Discover other Hyperise APIs:


  1. User Authentication - Authorise the API token.

  2. List Image Templates - List all active Image templates for the authorised user.

  3. Image Views - List the most recent personalised views for selected image.

  4. Business Data - Add/Update/View prospect data for images to use.

  5. Short Links - Create personalised Short Links.

Did this answer your question?