Prospect Events

Fetch Prospects Events

curl --request POST \
  --url https://api.explorium.ai/v1/prospects/events \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "event_types": [],
  "prospect_ids": [
    "<string>"
  ],
  "request_context": null,
  "timestamp_to": null,
  "timestamp_from": null
}
'

import requests

url = "https://api.explorium.ai/v1/prospects/events"

payload = {
    "event_types": [],
    "prospect_ids": ["<string>"],
    "request_context": None,
    "timestamp_to": None,
    "timestamp_from": None
}
headers = {
    "api_key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {api_key: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    event_types: [],
    prospect_ids: ['<string>'],
    request_context: null,
    timestamp_to: null,
    timestamp_from: null
  })
};

fetch('https://api.explorium.ai/v1/prospects/events', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.explorium.ai/v1/prospects/events",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'event_types' => [
        
    ],
    'prospect_ids' => [
        '<string>'
    ],
    'request_context' => null,
    'timestamp_to' => null,
    'timestamp_from' => null
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "api_key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.explorium.ai/v1/prospects/events"

	payload := strings.NewReader("{\n  \"event_types\": [],\n  \"prospect_ids\": [\n    \"<string>\"\n  ],\n  \"request_context\": null,\n  \"timestamp_to\": null,\n  \"timestamp_from\": null\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("api_key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.explorium.ai/v1/prospects/events")
  .header("api_key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"event_types\": [],\n  \"prospect_ids\": [\n    \"<string>\"\n  ],\n  \"request_context\": null,\n  \"timestamp_to\": null,\n  \"timestamp_from\": null\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.explorium.ai/v1/prospects/events")

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

request = Net::HTTP::Post.new(url)
request["api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"event_types\": [],\n  \"prospect_ids\": [\n    \"<string>\"\n  ],\n  \"request_context\": null,\n  \"timestamp_to\": null,\n  \"timestamp_from\": null\n}"

response = http.request(request)
puts response.read_body

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

POST

prospects

events

Fetch Prospects Events

curl --request POST \
  --url https://api.explorium.ai/v1/prospects/events \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "event_types": [],
  "prospect_ids": [
    "<string>"
  ],
  "request_context": null,
  "timestamp_to": null,
  "timestamp_from": null
}
'

import requests

url = "https://api.explorium.ai/v1/prospects/events"

payload = {
    "event_types": [],
    "prospect_ids": ["<string>"],
    "request_context": None,
    "timestamp_to": None,
    "timestamp_from": None
}
headers = {
    "api_key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {api_key: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    event_types: [],
    prospect_ids: ['<string>'],
    request_context: null,
    timestamp_to: null,
    timestamp_from: null
  })
};

fetch('https://api.explorium.ai/v1/prospects/events', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.explorium.ai/v1/prospects/events",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'event_types' => [
        
    ],
    'prospect_ids' => [
        '<string>'
    ],
    'request_context' => null,
    'timestamp_to' => null,
    'timestamp_from' => null
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "api_key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.explorium.ai/v1/prospects/events"

	payload := strings.NewReader("{\n  \"event_types\": [],\n  \"prospect_ids\": [\n    \"<string>\"\n  ],\n  \"request_context\": null,\n  \"timestamp_to\": null,\n  \"timestamp_from\": null\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("api_key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.explorium.ai/v1/prospects/events")
  .header("api_key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"event_types\": [],\n  \"prospect_ids\": [\n    \"<string>\"\n  ],\n  \"request_context\": null,\n  \"timestamp_to\": null,\n  \"timestamp_from\": null\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.explorium.ai/v1/prospects/events")

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

request = Net::HTTP::Post.new(url)
request["api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"event_types\": [],\n  \"prospect_ids\": [\n    \"<string>\"\n  ],\n  \"request_context\": null,\n  \"timestamp_to\": null,\n  \"timestamp_from\": null\n}"

response = http.request(request)
puts response.read_body

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Introduction

The Prospect Events API provides insights into recent events related to selected prospects, including job changes, company transitions, and professional anniversaries. These insights are essential for timely engagement, personalized outreach, and tracking career movements. Key Benefits:

Track real-time career movements of prospects.
Identify engagement opportunities based on job changes.
Enhance lead nurturing by targeting prospects during career transitions.
Integrate with CRM and sales platforms for automated alerts.

Important: Events API tracks only recent events within the last quarter (3 months). If no relevant events occurred in this timeframe, no data will be returned. Looking for historical data? Use the Prospect Enrichment API to retrieve long-term career and engagement trends.

Endpoint: `POST https://api.explorium.ai/v1/prospects/events`

How It Works

Input: Provide a list of prospect IDs and event types.
Processing: The system retrieves relevant event details.
Output: A structured response with matched prospect events.

Query Parameters

Parameter	Type	Description
`event_types`	Array	List of event types to filter results. See event types below.
`prospect_ids`	Array	List of prospect IDs to track.
`timestamp_from`	String	Return only events that occurred after this timestamp.

Supported Event Types

Event Type	Description
prospect_changed_role	Prospect has changed their role.
prospect_changed_company	Prospect has changed their company.
prospect_job_start_anniversary	Employee’s workplace anniversary, marking the anniversary of the employee’s start date at their company.

Example and Response Request (cURL)

Example Request (cURL)

cURL

curl -X POST \
  "https://api.explorium.ai/v1/prospects/events" \
  -H "API_KEY: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "event_types": [
    "prospect_changed_role",
    "prospect_changed_company"
  ],
  "prospect_ids": [
        "20ae6cbf564ee683e66685e429844a5ff8ffc30f",
    "4c485f009d59e319dc039cdf3e935b85014e6a33",
    "fd4c46716295a2e4731417eee802a883280e4d57",
    "a7bbe0674c63338e62ae4c10751ae19da5723e5a"
  ],
  "timestamp_from": "2024-01-01T10:03:03.050Z"
}
'

Example Response

JSON

{
  "response_context": {
    "correlation_id": "2826dd3eca6b4625aeddc30a3b96e11d",
    "request_status": "success",
    "time_took_in_seconds": 0.931
  },
  "output_events": [
    {
      "event_name": "prospect_changed_company",
      "event_time": "2024-07-01T00:00:00+00:00",
      "event_id": "3f7e8cf51cfd522ff0cef2249772ec0c",
      "data": {
        "event_name": "prospect_changed_company",
        "current_company_name": "Headovations",
        "current_company_id": "23d794056048ff2bc8c6b3a4ecd223d1",
        "current_job_title": "Vice President Of Business Development",
        "previous_company_name": "Gods Gang",
        "previous_company_id": "23d794056048ff2bc8c6b3a4ecd223d1",
        "previous_job_title": "Vice President Of Business Development"
      },
      "prospect_id": "4c485f009d59e319dc039cdf3e935b85014e6a33"
    },
    {
      "event_name": "prospect_changed_company",
      "event_time": "2024-06-01T00:00:00+00:00",
      "event_id": "10f4a011c10112a6a986ff856107104c",
      "data": {
        "event_name": "prospect_changed_company",
        "current_company_name": "Actalent",
        "current_company_id": "97a52bce42dfc8f332fd534c4de8139f",
        "current_job_title": "Aec Career Consultant / Recruiter",
        "previous_company_name": "Koln/Kgin Tv 10/11 News",
        "previous_company_id": "d8c9b663c31e377b0fdc80d156e66a06",
        "previous_job_title": "Aec Career Consultant / Recruiter"
      },
      "prospect_id": "20ae6cbf564ee683e66685e429844a5ff8ffc30f"
    }
  ]
}

Best Practices

Monitor career movements to enhance engagement strategies.
Leverage anniversaries for personalized outreach.
Refine search criteria to track only relevant prospects.
Utilize automation to integrate prospect event tracking into CRM workflows.
Combine with enrichment data to build a full profile of each prospect.

Event Categories

Employee job changes - Tracks when an employee changes their job title within the same company.
Recently changed company - Identifies when an employee transitions to a new company.
Employee’s workplace anniversary - Marks the annual anniversary of an employee’s start date at their current company.

Authorizations

api_key

string

header

required

Body

application/json

event_types

enum<string>[]

required

Minimum array length: 1

The ProspectsEventIdentifier class is an enumeration that defines event identifiers related to prospects.

This enum is used to categorize and track events associated with prospects, such as:

Role changes (e.g., when a prospect changes their role within a company)
Company changes (e.g., when a prospect moves to a new company)
Job anniversaries (e.g., celebrating the anniversary of a prospect's job start date)

These identifiers ensure consistent handling and classification of prospect-related events across the application.

Available options:

prospect_changed_role,

prospect_changed_company,

prospect_job_start_anniversary

prospect_ids

string[]

required

Required array length: 1 - 40 elements

Pattern: ^[a-f0-9]{40}$

request_context

Request Context · object | null

Example:

null

entity_type

enum<string>

The EntityType class is an enumeration that defines the types of entities.

This enum is used to specify whether the entity is a business or a prospect. It ensures consistent handling of entity types across the application.

Attributes: BUSINESS: Represents a business entity. PROSPECT: Represents a prospect entity.

Available options:

business,

prospect

timestamp_to

ISO format datetime string or date in format YYYY-MM-DD

Example:

null

timestamp_from

ISO format datetime string or date in format YYYY-MM-DD

Example:

null

Response

Successful Response

Autocomplete prospects Add prospects enrollments

⌘I

Explorium AgentSource

Partners

Introduction

Endpoint: `POST https://api.explorium.ai/v1/prospects/events`

Example Request (cURL)

Example Response

Authorizations

Body

Response

​Introduction

​Endpoint: POST https://api.explorium.ai/v1/prospects/events

​Example Request (cURL)

​Example Response

Authorizations

Body

Response

Introduction

Endpoint: `POST https://api.explorium.ai/v1/prospects/events`

Example Request (cURL)

Example Response