Maximise AI Docs
  • Introduction
    • Authentication
    • Rate Limit
  • Whitelabel APIs
    • Check Credit Usage
    • Add Domain
    • Update Domain
    • Archive Domain
    • All Domains
    • Add Webhook
    • Domain Visitor List
    • Domain Account List
Powered by GitBook
On this page
  1. Whitelabel APIs

Domain Visitor List

Retrieve detailed information about visitors to your domain for real-time engagement.

curl --location 'https://api.maximise.ai/v1/whitelabel-api/visitor-profiles?id=EH1K7dtMJqf8V-ZMMX&page=1&limit=50&startDate&endDate' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json'
const axios = require('axios');

axios.get('https://api.maximise.ai/v1/whitelabel-api/visitor-profiles?did=EH1K7dtMJqf8V-ZMMX&page=1&limit=50&startDate&endDate', {
    headers: {accept: 'application/json', Authorization: 'Bearer <token>'}
})
  .then(response => {
    console.log(response.data);
  })
  .catch(error => {
    console.log(error);
  });
import requests
import json

url = "https://api.maximise.ai/v1/whitelabel-api/visitor-profiles?did=EH1K7dtMJqf8V-ZMMX&page=1&limit=50&startDate&endDate"

payload = {}
headers = {
  'Authorization': 'Bearer <token>',
  'Content-Type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
  .url("https://api.maximise.ai/v1/whitelabel-api/visitor-profiles?did=EH1K7dtMJqf8V-ZMMX&page=1&limit=50&startDate&endDate")
  .method("GET", body)
  .addHeader("Authorization", "Bearer <token>")
  .build();
Response response = client.newCall(request).execute();
require "uri"
require "json"
require "net/http"

url = URI("https://api.maximise.ai/v1/whitelabel-api/visitor-profiles?did=EH1K7dtMJqf8V-ZMMX&page=1&limit=50&startDate&endDate")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = "Bearer <token>"
request["Content-Type"] = "application/json"

response = https.request(request)
puts response.read_body
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.maximise.ai/v1/whitelabel-api/visitor-profiles?did=EH1K7dtMJqf8V-ZMMX&page=1&limit=50&startDate&endDate',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Authorization: Bearer <token>',
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Example response

Status Code: 200 OK

{
    "visitorProfiles": [
        {
            "visitor": {
                "_id": "12345abcdef67890ghijk",
                "enrichment_status": "completed",
                "sharing_status": "completed",
                "enriched": true,
                "uid": "bc3f8a9e-4d2a-4b1c-9f3e-abcdef123456-9876543210123",
                "confidence": "high",
                "domain_id": "XYZ123abcDEF456ghI",
                "first_name": "Jane",
                "last_name": "Doe",
                "display_name": "Jane Doe",
                "emails": [
                    {
                        "hash_md5": "e99a18c428cb38d5f260853678922e03",
                        "hash_sha1": "2fd4e1c67a2d28fced849ee1bb76e7391b93eb12",
                        "hash_sha256": "9b74c9897bac770ffc029102a200c5de0ef42e6a10e2b7e1d5e4f3a4f9b4c8d2",
                        "email": "[email protected]",
                        "email_type": "personal"
                    }
                ],
                "work_email": "[email protected]",
                "direct_dials": [
                    "5551234567",
                    "5559876543"
                ],
                "age": "35",
                "gender": "Female",
                "city": "San Francisco",
                "state": "CA",
                "location": "San Francisco, California, United States",
                "country": "United States",
                "street": "456 Elm Street",
                "postal_code": "94107",
                "geo_data": {
                    "city": "San Francisco",
                    "country": "United States",
                    "countryCode": "US",
                    "hosting": false,
                    "isp": "Dummy ISP",
                    "lat": 37.7749,
                    "lng": -122.4194,
                    "proxy": false,
                    "region": "California",
                    "query": "dummy-query",
                    "org": "Dummy Organization",
                    "regionName": "California",
                    "status": "success",
                    "timezone": "America/Los_Angeles",
                    "zip": "94107"
                },
                "full_address": "456 Elm Street, San Francisco, CA 94107, USA",
                "photo_url": "https://dummyimage.com/photo.jpg",
                "photo_url_hosted": "https://dummyhost.com/images/jane_doe.jpg",
                "linkedin_profile_url": "https://linkedin.com/in/janedoe",
                "current_position": "Lead Software Engineer at DummyCorp Inc.\nFull-Stack Development | Agile Methodologies | Cloud Computing | Team Leadership",
                "current_level": ["Senior"],
                "current_role": "Lead Software Engineer",
                "company_id": "67890abcDEF123ghI456jkl",
                "current_company": "DummyCorp Inc.",
                "current_company_logo": "https://dummycorp.com/logo.png",
                "current_company_size": {
                    "total": 150,
                    "size": "51-200 employees",
                    "range": {
                        "start": 51,
                        "end": 200
                    }
                },
                "industries": [
                    "Information Technology",
                    "Software Development"
                ],
                "salary_range": "$100K-$150K",
                "company_name": "DummyCorp Inc.",
                "company_desc": "DummyCorp Inc. is a leading provider of innovative software solutions, specializing in cloud-based applications and enterprise software development.",
                "company_domain": "dummycorp.com",
                "birth_date": "1989-05-15",
                "languages": ["English", "Spanish"],
                "locations": ["San Francisco, CA", "New York, NY"],
                "addresses": [
                    "456 Elm Street",
                    "789 Pine Avenue"
                ],
                "countries": ["United States"],
                "regions": ["California", "New York"],
                "social_profiles": {
                    "twitter": "https://twitter.com/janedoe",
                    "github": "https://github.com/janedoe"
                },
                "profile_summary": "As a Lead Software Engineer at DummyCorp Inc., I oversee the development of scalable web applications and lead a team of talented developers. My expertise lies in full-stack development, cloud computing, and implementing agile methodologies to enhance productivity and deliver high-quality software solutions. I am passionate about leveraging technology to solve complex problems and drive business growth.",
                "work_experience": [
                    {
                        "title": "Lead Software Engineer",
                        "startEndDate": {
                            "start": {
                                "month": 6,
                                "year": 2018
                            },
                            "end": {
                                "month": 0,
                                "year": 0
                            }
                        },
                        "company": {
                            "companyName": "DummyCorp Inc.",
                            "companyLocation": "San Francisco, CA",
                            "companyLogo": "https://dummycorp.com/logo.png",
                            "linkedInUrl": "https://www.linkedin.com/company/dummycorp/"
                        },
                        "companyName": "DummyCorp Inc.",
                        "companyLocation": "San Francisco, CA",
                        "companyLogo": "https://dummycorp.com/logo.png",
                        "linkedInUrl": "https://www.linkedin.com/company/dummycorp/"
                    },
                    {
                        "title": "Senior Software Engineer",
                        "startEndDate": {
                            "start": {
                                "month": 1,
                                "year": 2015
                            },
                            "end": {
                                "month": 5,
                                "year": 2018
                            }
                        },
                        "company": {
                            "companyName": "TechSolutions LLC",
                            "companyLocation": "Los Angeles, CA",
                            "companyLogo": "https://techsolutions.com/logo.png",
                            "linkedInUrl": "https://www.linkedin.com/company/techsolutions/"
                        },
                        "companyName": "TechSolutions LLC",
                        "companyLocation": "Los Angeles, CA",
                        "companyLogo": "https://techsolutions.com/logo.png",
                        "linkedInUrl": "https://www.linkedin.com/company/techsolutions/"
                    },
                    {
                        "title": "Software Engineer",
                        "startEndDate": {
                            "start": {
                                "month": 7,
                                "year": 2012
                            },
                            "end": {
                                "month": 12,
                                "year": 2014
                            }
                        },
                        "company": {
                            "companyName": "Innovatech",
                            "companyLocation": "San Diego, CA",
                            "companyLogo": "https://innovatech.com/logo.png",
                            "linkedInUrl": "https://www.linkedin.com/company/innovatech/"
                        },
                        "companyName": "Innovatech",
                        "companyLocation": "San Diego, CA",
                        "companyLogo": "https://innovatech.com/logo.png",
                        "linkedInUrl": "https://www.linkedin.com/company/innovatech/"
                    }
                ],
                "education": [
                    {
                        "school": {
                            "schoolname": "Stanford University",
                            "schoollocation": "Stanford, CA",
                            "schoollogo": "https://media.licdn.com/dms/image/C4E0BAQH4pNOMdpa1aA/company-logo_400_400/0/1659336837387/stanford_university_logo.png",
                            "linkedinurl": "https://www.linkedin.com/school/stanford-university/"
                        },
                        "degreeName": "Master's degree",
                        "startEndDate": {
                            "start": {
                                "month": 9,
                                "year": 2010
                            },
                            "end": {
                                "month": 6,
                                "year": 2012
                            }
                        },
                        "fieldOfStudy": "Computer Science",
                        "schoolName": "Stanford University",
                        "schoolLocation": "Stanford, CA",
                        "schoolLogo": "https://media.licdn.com/dms/image/C4E0BAQH4pNOMdpa1aA/company-logo_400_400/0/1659336837387/stanford_university_logo.png",
                        "linkedInUrl": "https://www.linkedin.com/school/stanford-university/"
                    },
                    {
                        "school": {
                            "schoolname": "University of California, Berkeley",
                            "schoollocation": "Berkeley, CA",
                            "schoollogo": "https://media.licdn.com/dms/image/C4D0BAQF6TmzLkch0dQ/company-logo_400_400/0/1630556159190/uc-berkeley-logo.png",
                            "linkedinurl": "https://www.linkedin.com/school/university-of-california-berkeley/"
                        },
                        "degreeName": "Bachelor's degree",
                        "startEndDate": {
                            "start": {
                                "month": 9,
                                "year": 2006
                            },
                            "end": {
                                "month": 6,
                                "year": 2010
                            }
                        },
                        "fieldOfStudy": "Software Engineering",
                        "schoolName": "University of California, Berkeley",
                        "schoolLocation": "Berkeley, CA",
                        "schoolLogo": "https://media.licdn.com/dms/image/C4D0BAQF6TmzLkch0dQ/company-logo_400_400/0/1630556159190/uc-berkeley-logo.png",
                        "linkedInUrl": "https://www.linkedin.com/school/university-of-california-berkeley/"
                    }
                ],
                "awards": [
                    {
                        "title": "Employee of the Year",
                        "date": "2019-12-15",
                        "awarder": "DummyCorp Inc.",
                        "summary": "Recognized for outstanding performance and leadership in software development."
                    }
                ],
                "publications": [
                    {
                        "title": "Optimizing Cloud Applications for Scalability",
                        "publisher": "Tech Journal",
                        "release_date": "2021-08-01",
                        "url": "https://techjournal.com/publications/optimizing-cloud-apps"
                    }
                ],
                "skills": [
                    "Full-Stack Development",
                    "Agile Methodologies",
                    "Cloud Computing",
                    "Team Leadership",
                    "JavaScript",
                    "Python",
                    "AWS",
                    "Docker",
                    "Kubernetes",
                    "React",
                    "Node.js",
                    "DevOps",
                    "Microservices",
                    "SQL",
                    "NoSQL",
                    "Git",
                    "CI/CD",
                    "RESTful APIs",
                    "Machine Learning",
                    "Data Analysis"
                ],
                "interests": [
                    "Open Source Contributions",
                    "Artificial Intelligence",
                    "Blockchain Technology",
                    "Cybersecurity",
                    "IoT Innovations"
                ],
                "patents": [
                    {
                        "title": "Scalable Microservices Architecture",
                        "date": "2020-05-20",
                        "patent_office": "USPTO",
                        "url": "https://patents.google.com/patent/US1234567B1/en"
                    }
                ],
                "projects": [
                    {
                        "name": "CloudOptimizer",
                        "description": "A tool designed to optimize cloud resource allocation for large-scale applications.",
                        "url": "https://github.com/janedoe/cloudoptimizer",
                        "start_date": "2019-01-01",
                        "end_date": "2020-12-31",
                        "role": "Project Lead"
                    }
                ],
                "certifications": [
                    {
                        "name": "AWS Certified Solutions Architect",
                        "issuing_organization": "Amazon Web Services",
                        "issue_date": "2018-07-15",
                        "expiration_date": "2023-07-15",
                        "credential_id": "AWS-1234567890",
                        "credential_url": "https://aws.amazon.com/certification/certified-solutions-architect-associate/"
                    }
                ],
                "volunteer_experiences": [
                    {
                        "organization": "Code for Good",
                        "role": "Volunteer Developer",
                        "start_date": "2017-03-01",
                        "end_date": "2019-08-31",
                        "description": "Developed web applications to support non-profit organizations in managing their operations."
                    }
                ],
                "treasury_media": [
                    {
                        "type": "video",
                        "url": "https://youtube.com/dummyvideo",
                        "description": "Presentation on scalable cloud architectures."
                    }
                ],
                "test_scores": {
                    "GRE": {
                        "verbal": 160,
                        "quantitative": 165,
                        "analytical_writing": 4.5
                    },
                    "TOEFL": {
                        "total": 110,
                        "listening": 28,
                        "reading": 30,
                        "speaking": 26,
                        "writing": 26
                    }
                },
                "websites": [
                    "https://janedoe.com",
                    "https://portfolio.janedoe.com"
                ],
                "createdAt": "2024-10-05T10:15:30.000Z",
                "updatedAt": "2024-10-05T10:15:30.000Z",
                "company_linkedin": "https://www.linkedin.com/company/dummycorp-inc/"
            },
            "sessions": [
                {
                    "sid": "session1234567890abcdef",
                    "firstSeen": "2024-10-05T09:00:00.000Z",
                    "lastSeen": "2024-10-05T09:30:00.000Z",
                    "totalDuration": 1800,
                    "activities": [
                        {
                            "sid": "session1234567890abcdef",
                            "url": "https://www.dummycorp.com/products",
                            "ua": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/113.0.0.0 Safari/537.36",
                            "doc_title": "DummyCorp Products",
                            "referrer": "https://www.google.com/",
                            "last_referrer": "https://www.google.com/search?q=DummyCorp",
                            "timestamp": "2024-10-05T09:15:00.000Z",
                            "duration": 600
                        },
                        {
                            "sid": "session1234567890abcdef",
                            "url": "https://www.dummycorp.com/contact",
                            "ua": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/113.0.0.0 Safari/537.36",
                            "doc_title": "Contact Us - DummyCorp",
                            "referrer": "https://www.dummycorp.com/products",
                            "last_referrer": "https://www.google.com/search?q=DummyCorp",
                            "timestamp": "2024-10-05T09:25:00.000Z",
                            "duration": 300
                        }
                    ]
                }
            ],
            "lastSeen": "2024-10-05T09:30:00.000Z",
            "lastActivity": {
                "sid": "session1234567890abcdef",
                "url": "https://www.dummycorp.com/contact",
                "ua": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/113.0.0.0 Safari/537.36",
                "doc_title": "Contact Us - DummyCorp",
                "referrer": "https://www.dummycorp.com/products",
                "last_referrer": "https://www.google.com/search?q=DummyCorp",
                "timestamp": "2024-10-05T09:30:00.000Z",
                "duration": 300
            }
        }
    ]
}
PreviousAdd WebhookNextDomain Account List

Last updated 7 months ago