← Back to all apps

Find and engage prospects

14Tools
BusinessCategory

Available Tools

Clay provides 14 tools that can be used to interact with its services.

Add-company-data-points

add-company-data-points
Full Description

Add data points to companies in an existing search. Supports enriching ALL companies or specific companies via entityIds.

Quick Reference

  • This tool: Enrich COMPANIES with funding, tech stack, headcount, etc.
  • add-contact-data-points: Enrich CONTACTS with emails, phone numbers, work history, etc.
    • Requires a taskId from a previous find-and-enrich-* tool call
    • Use entityIds to enrich specific companies — do NOT create a new search to enrich one company from an existing search
    • ANY research question about companies = call this tool with a Custom data point

IMPORTANT: When to Call This Tool

Call this tool whenever the user asks for ANY information about companies, including:

  • Standard data points (tech stack, funding, headcount, etc.)
  • Any open-ended research question — use Custom type for these

Do NOT try to answer company research questions from your own knowledge. ALWAYS call this tool to fetch the data.

Examples that MUST trigger this tool:

  • "What's their tech stack?" → Standard type
  • "Find recent product announcements" → Custom type
  • "Get me their latest news" → Custom type
  • "What's their revenue model?" → Custom type
  • "Find their competitors" → Custom type
  • "Any recent acquisitions?" → Custom type

Parameters

taskId (required)

The task ID returned from find-and-enrich-contacts-at-company or find-and-enrich-list-of-contacts.

  • Do NOT fabricate a taskId—use the one from the prior search
  • If no search exists yet, prompt the user to search first
dataPoints (required)

Array of data points to add.

  • Standard: { type: "<DataPointType>" }
  • Custom: { type: "Custom", customDataPoint: "<brief description>" }

Available standard types: Headcount Growth, Recent News, Investors, Company Competitors, Company Customers, Tech Stack, Website Traffic, Open Jobs, Revenue Model, Annual Revenue, Latest Funding

Custom type: Use for ANY research question not covered by standard types. Examples:

  • "recent product announcements" → { type: "Custom", customDataPoint: "recent product announcements" }
  • "B2B vs B2C classification" → { type: "Custom", customDataPoint: "B2B vs B2C classification" }
  • "company founders" → { type: "Custom", customDataPoint: "company founders" }
entityIds (optional)

Array of entityIds to enrich. When omitted, enriches all companies in the search.

  • Use the entityId values from the company data returned by a previous search tool call
  • Useful when the user wants to enrich specific companies

Examples

| User request | dataPoints | |--------------|------------| | "What's their tech stack?" | [{ type: "Tech Stack" }] | | "Get funding info and headcount" | [{ type: "Latest Funding" }, { type: "Headcount" }] | | "Find recent product announcements" | [{ type: "Custom", customDataPoint: "recent product announcements" }] | | "Are they B2B or B2C?" | [{ type: "Custom", customDataPoint: "B2B vs B2C classification" }] | | "What's in the news about them?" | [{ type: "Custom", customDataPoint: "recent news and headlines" }] |

Response Behavior

Confirm briefly: "Fetching [data point] for [company/companies]—results will appear in the widget shortly." For single-company requests, name the company instead of saying "all companies."

Parameters

Required
dataPointsarray

The data points to apply to the company

searchIdstring

The ID of the search to add company data points to

taskIdstring

The task ID identifying the search to add company data points to

Optional
entityIdsarray

Optional. Array of entityIds to enrich. When omitted, enriches all companies.

Add-contact-data-points

add-contact-data-points
Full Description

Add data points to contacts in an existing search. Supports enriching ALL contacts or specific contacts via entityIds.

Quick Reference

  • This tool: Enrich CONTACTS with emails, phone numbers, work history, etc.
  • add-company-data-points: Enrich COMPANIES with funding, tech stack, headcount, etc.
    • Requires a taskId from a previous find-and-enrich-* tool call
    • Use entityIds to enrich specific contacts — do NOT create a new search to enrich one person from an existing search
    • ANY research question about contacts = call this tool with a Custom data point

IMPORTANT: When to Call This Tool

Call this tool whenever the user asks for ANY information about contacts, including:

  • Standard data points (email, phone, work history, etc.)
  • Any open-ended research question — use Custom type for these

Do NOT try to answer contact research questions from your own knowledge. ALWAYS call this tool to fetch the data.

Examples that MUST trigger this tool:

  • "Get their emails" → Standard type
  • "Find their recent publications" → Custom type
  • "What have they posted on LinkedIn?" → Custom type
  • "Summarize their career trajectory" → Custom type
  • "Any recent job changes?" → Custom type
  • "Score them against my ICP" → Custom type

Parameters

taskId (required)

The task ID returned from find-and-enrich-contacts-at-company or find-and-enrich-list-of-contacts.

  • Do NOT fabricate a taskId—use the one from the prior search
  • If no search exists yet, prompt the user to search first
dataPoints (required)

Array of data points to add.

  • Standard: { type: "<DataPointType>" }
  • Custom: { type: "Custom", customDataPoint: "<brief description>" }

Available standard types: Email, Summarize Work History, Find Thought Leadership

Custom type: Use for ANY research question not covered by standard types. Examples:

  • "recent publications" → { type: "Custom", customDataPoint: "recent publications" }
  • "LinkedIn activity" → { type: "Custom", customDataPoint: "recent LinkedIn posts" }
  • "ICP fit score" → { type: "Custom", customDataPoint: "ICP fit score based on seniority and tenure" }
entityIds (optional)

Array of entityIds to enrich. When omitted, enriches all contacts in the search.

  • Use the entityId values from the contact data returned by a previous search tool call
  • Useful when the user wants to enrich specific contacts (e.g., "get John's email")

Examples

| User request | dataPoints | |--------------|------------| | "Get their emails" | [{ type: "Email" }] | | "Add phone numbers and work history" | [{ type: "Phone" }, { type: "Summarize Work History" }] | | "Find their recent publications" | [{ type: "Custom", customDataPoint: "recent publications" }] | | "What's their LinkedIn activity?" | [{ type: "Custom", customDataPoint: "recent LinkedIn posts" }] | | "Score them for senior leaders in NYC" | [{ type: "Custom", customDataPoint: "ICP fit: senior leader in NYC" }] | | "Get John's email" (single contact) | [{ type: "Email" }] + entityIds: ["<john's entityId>"] |

Response Behavior

Confirm briefly: "Fetching [data point] for all contacts—results will appear in the widget shortly." For single-contact requests, name the contact instead of saying "all contacts."

Parameters

Required
dataPointsarray

The data points to apply to the contacts

searchIdstring

The ID of the search to add contact data points to

taskIdstring

The task ID identifying the search to add contact data points to

Optional
entityIdsarray

Optional. Array of entityIds to enrich. When omitted, enriches all contacts.

Find-and-enrich-company

find-and-enrich-company
Full Description

Find and enrich a single company by domain or LinkedIn URL.

Quick Reference

  • This tool: Find COMPANY info (e.g., "Tell me about Stripe", "What's OpenAI's funding?")
  • find-and-enrich-contacts-at-company: Find TYPES of people (e.g., "engineers at Stripe")
  • find-and-enrich-list-of-contacts: Find SPECIFIC named people (e.g., "John Smith at Stripe")
    • Do NOT use if user wants to find people—use the contact tools instead

Parameters

companyIdentifier (required)

Domain (e.g., "stripe.com") or LinkedIn company URL. Company names alone will fail.

  • Convert known companies: "Stripe" → "stripe.com"
  • If ambiguous (e.g., "Delta"), ask the user to clarify
companyDataPoints (optional)

Enrich the company when creating a NEW search. For existing searches, use add-company-data-points instead.

DataPoint format:

  • Standard: { type: "<DataPointType>" }
  • Custom: { type: "Custom", customDataPoint: "<brief description>" }

Important: Only include customDataPoint field when type is "Custom"

Important: Only add data points the user explicitly asks for. "Tell me about Stripe" → no data points. "What's Stripe's funding?" → add Latest Funding.

Available companyDataPoints: Headcount Growth, Recent News, Investors, Company Competitors, Company Customers, Tech Stack, Website Traffic, Open Jobs, Revenue Model, Annual Revenue, Latest Funding

Examples

| User request | Parameters | |--------------|------------| | "Tell me about Stripe" | companyIdentifier: "stripe.com" | | "What's OpenAI's funding?" | companyIdentifier: "openai.com", companyDataPoints: [{ type: "Latest Funding" }] | | "Canva's competitors and tech stack" | companyIdentifier: "canva.com", companyDataPoints: [{ type: "Company Competitors" }, { type: "Tech Stack" }] | | "Notion's product roadmap" | companyIdentifier: "notion.so", companyDataPoints: [{ type: "Custom", customDataPoint: "product roadmap" }] |

Response Behavior

Users see results in a widget, so:

  • Do NOT repeat company details—just summarize (e.g., "Found Stripe—here's their company info.")
  • Tool returns a taskId for use with add-company-data-points

Parameters

Required
companyIdentifierstring

Company identifier (domain like "clay.com" or LinkedIn URL like "https://www.linkedin.com/company/grow-with-clay")

Optional
companyDataPointsarray

Optional data points to enrich during search creation

Find-and-enrich-contacts-at-company

find-and-enrich-contacts-at-company
Full Description

Search for contacts at a company by role, title, or department.

Quick Reference

  • This tool: Find TYPES of people (e.g., "engineers at Stripe", "VPs at OpenAI")
  • find-and-enrich-list-of-contacts: Find SPECIFIC named people (e.g., "John Smith at Stripe")
  • Follow-ups: ALWAYS re-call this tool—never filter results in chat. When ambiguous, ask the user.

Parameters

companyIdentifier (required)

Domain (e.g., "stripe.com") or LinkedIn company URL. Company names alone will fail.

  • Convert known companies: "Stripe" → "stripe.com"
  • If ambiguous (e.g., "Delta"), ask the user to clarify
contactFilters (optional)

Narrow results. Only add filters the user explicitly requests.

Rules:

  • Filters combine with AND; values within arrays combine with OR
  • Keep compound titles as ONE string: "VP Finance" → ["VP Finance"], NOT ["VP", "Finance"]
  • Use specific terms to avoid false matches:
    • ✓ "Software Engineer" not "Engineer" (matches Sales Engineer, etc.)
    • ✓ "Product Manager" not "Manager" (matches Account Manager, etc.)

Available filters: | Filter | Type | Description | |--------|------|-------------| | job_title_keywords | string[] | Titles to include | | job_title_exclude_keywords | string[] | Titles to exclude (e.g., ["Intern"]) | | headline_keywords | string[] | LinkedIn headline search | | about_keywords | string[] | About/summary section search | | certification_keywords | string[] | Certifications (e.g., ["AWS", "CPA"]) | | languages | string[] | Profile languages | | school_names | string[] | Schools attended | | current_role_min_months_since_start_date | number | Min months in role (tenured) | | current_role_max_months_since_start_date | number | Max months in role (new hires) | | locations | string[] | Locations to include (use formal names: "United States", "California") | | locations_exclude | string[] | Locations to exclude |

dataPoints (optional)

Enrich contacts/companies when creating a NEW search. For existing searches, use add-contact-data-points or add-company-data-points instead.

Structure: { contactDataPoints?: DataPoint[], companyDataPoints?: DataPoint[] }

DataPoint format:

  • Standard: { type: "<DataPointType>" }
  • Custom: { type: "Custom", customDataPoint: "<brief description>" }

Important: Only include customDataPoint field when type is "Custom"

Important: Only add data points the user explicitly asks for. "Find engineers at Stripe" → no data points. "Find engineers at Stripe with emails" → add Email.

Available contactDataPoints: Email, Summarize Work History, Find Thought Leadership

Available companyDataPoints: Headcount Growth, Recent News, Investors, Company Competitors, Company Customers, Tech Stack, Website Traffic, Open Jobs, Revenue Model, Annual Revenue, Latest Funding

Examples: | User request | dataPoints | |--------------|------------| | "engineers at Stripe with emails" | { contactDataPoints: [{type: "Email"}] } | | "Canva's competitors and funding" | { companyDataPoints: [{type: "Company Competitors"}, {type: "Latest Funding"}] } | | "VPs at Figma with emails + company tech stack" | { contactDataPoints: [{type: "Email"}], companyDataPoints: [{type: "Tech Stack"}] } | | "Notion's product roadmap" (custom) | { companyDataPoints: [{type: "Custom", customDataPoint: "product roadmap"}] } |

Examples

| User says | Parameters | |-----------|------------| | "Find people at OpenAI" | companyIdentifier: "openai.com" | | "VP Finance at HubSpot" | companyIdentifier: "hubspot.com", contactFilters: { job_title_keywords: ["VP Finance"] } | | "VPs and Directors in California at HubSpot" | companyIdentifier: "hubspot.com", contactFilters: { job_title_keywords: ["VP", "Director"], locations: ["California"] } | | "Marketing managers outside the US at Salesforce" | companyIdentifier: "salesforce.com", contactFilters: { job_title_keywords: ["Marketing Manager"], locations_exclude: ["United States"] } | | "New hires at Stripe (last 3 months)" | companyIdentifier: "stripe.com", contactFilters: { current_role_max_months_since_start_date: 3 } |

Handling Follow-ups

ANY search modification requires re-calling this tool. Never filter in chat.

Interpret user intent:

  • "also/too/as well" → ADD to existing filters
  • "only/just" → NARROW within current context (e.g., "VPs only" after Finance search → "VP Finance")
  • "actually/instead/switch" → REPLACE filters entirely
  • When ambiguous, ask the user rather than guessing

Examples: 1. User: "Find SDRs at Verkada" → { job_title_keywords: ["SDR", "Sales Development"] } User: "Get AEs too" → ADD: { job_title_keywords: ["SDR", "Sales Development", "Account Executive"] }

2. User: "Find Finance people at Ramp" → { job_title_keywords: ["Finance"] } User: "Make it VPs only" → NARROW: { job_title_keywords: ["VP Finance"] }

3. User: "Find Finance people at Ramp" → { job_title_keywords: ["Finance"] } User: "Actually show me all VPs" → REPLACE: { job_title_keywords: ["VP"] }

Response Behavior

Users see results in a widget, so:

  • Do NOT repeat contact details—just summarize (e.g., "Found 20 engineers at OpenAI")
  • Tool returns a taskId for use with add-contact-data-points or add-company-data-points
  • For emails/phones, use add-contact-data-points with the taskId

Zero Results

Suggest broadening in order: 1. Remove or broaden title keywords (e.g., "Software Engineer" → "Engineer") 2. Remove location filter 3. Remove tenure filter 4. Verify company domain is correct

Parameters

Required
companyIdentifierstring

The company identifier to search for company and contacts. Either a domain (e.g. "clay.com") or a LinkedIn URL (e.g. "https://www.linkedin.com/company/grow-with-clay").

Optional
contactFiltersobject
dataPointsobject

Optional data points to enrich during search creation

Find-and-enrich-list-of-contacts

find-and-enrich-list-of-contacts
Full Description

Find and enrich specific named contacts at their companies.

Quick Reference

  • This tool: Find SPECIFIC named people (e.g., "John Smith at OpenAI", "Jane Doe at Stripe")
  • find-and-enrich-contacts-at-company: Find TYPES of people (e.g., "engineers at Stripe")
    • Do NOT use if user only provides company names without contact names
    • Do NOT use to enrich contacts already in an existing search — use add-contact-data-points with entityIds instead

Parameters

contacts (required)

Array of { contactName, companyIdentifier } objects.

  • contactName: Full name (e.g., "John Smith")
  • companyIdentifier: Domain or company LinkedIn URL (NOT person LinkedIn URLs)
    • Domains: "openai.com", "stripe.com"
    • LinkedIn: "linkedin.com/company/openai"
    • Company names: Convert if confident (e.g., "Stripe" → "stripe.com"), otherwise ask user
dataPoints (optional)

Enrich contacts/companies when creating a NEW search. For existing searches, use add-contact-data-points or add-company-data-points instead.

Structure: { contactDataPoints?: DataPoint[], companyDataPoints?: DataPoint[] }

DataPoint format:

  • Standard: { type: "<DataPointType>" }
  • Custom: { type: "Custom", customDataPoint: "<brief description>" }

Important: Only include customDataPoint field when type is "Custom"

Important: Only add data points the user explicitly asks for. "Find engineers at Stripe" → no data points. "Find engineers at Stripe with emails" → add Email.

Available contactDataPoints: Email, Summarize Work History, Find Thought Leadership

Available companyDataPoints: Headcount Growth, Recent News, Investors, Company Competitors, Company Customers, Tech Stack, Website Traffic, Open Jobs, Revenue Model, Annual Revenue, Latest Funding

Examples: | User request | dataPoints | |--------------|------------| | "engineers at Stripe with emails" | { contactDataPoints: [{type: "Email"}] } | | "Canva's competitors and funding" | { companyDataPoints: [{type: "Company Competitors"}, {type: "Latest Funding"}] } | | "VPs at Figma with emails + company tech stack" | { contactDataPoints: [{type: "Email"}], companyDataPoints: [{type: "Tech Stack"}] } | | "Notion's product roadmap" (custom) | { companyDataPoints: [{type: "Custom", customDataPoint: "product roadmap"}] } |

Examples

| User request | contacts | |--------------|----------| | "Find John Smith at OpenAI" | [{ contactName: "John Smith", companyIdentifier: "openai.com" }] | | "Look up Jane Doe at Stripe and Bob Lee at Figma" | [{ contactName: "Jane Doe", companyIdentifier: "stripe.com" }, { contactName: "Bob Lee", companyIdentifier: "figma.com" }] |

Follow-ups

  • "Add [name] at [company] too" → Re-call with ALL contacts (previous + new)
  • "Actually look up [different people]" → Re-call with only the new contacts

Response Behavior

Users see results in a widget, so:

  • Do NOT repeat contact details—just summarize (e.g., "Found 8 of 10 contacts across 5 companies")
  • Tool returns a taskId for use with add-contact-data-points or add-company-data-points

Parameters

Required
contactIdentifiersarray

Array of contact identifiers to find and enrich, with their company identifiers

Optional
dataPointsobject

Optional data points to enrich during search creation

Get-credits-available

get-credits-available
Full Description

Check if credits are available for the workspace. Returns hasWorkspaceCredits and hasPlatformCredits.

Get-existing-search

get-existing-search
Full Description

Retrieve an existing search by task ID. This tool retrieves the current state of search results including any enrichments that have completed since the search was created.

When to Use This Tool

This is a private tool, the chat and user are not exposed to it.

Parameters

taskId (required)

  • The task ID identifying the search to retrieve. This should be a taskId that was returned from a previous find-and-enrich-contacts-at-company or find-and-enrich-list-of-contacts tool call.

Parameters

Required
searchIdstring

The ID of the search to retrieve.

taskIdstring

The task ID identifying the search to retrieve.

Get-my-accounts

get-my-accounts
Full Description

Search your Salesforce accounts synced to Clay. Returns accounts you own in Salesforce, with optional filters. Optionally scope results to a specific Clay Audiences segment.

Quick Reference

  • This tool: Search YOUR Salesforce accounts (accounts where you are the owner)
    • Optionally scope to a named audience segment (e.g., "Enterprise", "ICP")
    • Requires Salesforce User and Account syncs to be configured in Clay Audiences

Parameters

audienceName (optional)

Name of a Clay Audiences segment to scope results to. When provided, only accounts that belong to the named segment AND are owned by you will be returned. Use this when the user mentions a specific audience, segment, or list name. Omit when the user just wants to search across all of their accounts.

filters (optional)

Narrow results by account attributes. All filters combine with AND (and are also AND-ed with the audience segment filter if provided).

| Filter | Type | Description | |--------|------|-------------| | companyName | string | Partial match on account name (e.g., "Acme") | | domain | string | Exact domain match (e.g., "acme.com"). Use the full domain, not a partial string. | | industry | string | Partial match on industry (e.g., "Technology") | | location | string | Match on headquarters location. Be specific: use a city name (e.g., "San Francisco"), state (e.g., "California"), or country (e.g., "United States") — not a combination. | | headcountMin | number | Minimum number of employees (inclusive, >=) | | headcountMax | number | Maximum number of employees (inclusive, <=) |

limit (optional)

Number of results to return. Default: 50, max: 100.

offset (optional)

Number of results to skip for pagination. Default: 0.

Examples

| User says | Parameters | |-----------|------------| | "Show me my accounts" | {} | | "My tech accounts" | { filters: { industry: "Technology" } } | | "Accounts in California with 100+ employees" | { filters: { location: "California", headcountMin: 100 } } | | "Find my account Acme Corp" | { filters: { companyName: "Acme" } } | | "Find acme.com" | { filters: { domain: "acme.com" } } | | "Accounts in my Enterprise segment" | { audienceName: "Enterprise" } | | "ICP accounts in San Francisco" | { audienceName: "ICP", filters: { location: "San Francisco" } } | | "My accounts from the Mid-Market audience with 50+ employees" | { audienceName: "Mid-Market", filters: { headcountMin: 50 } } |

Response Behavior

  • Summarize results concisely (e.g., "Found 15 accounts matching your filters")
  • List key details: account name, industry, and location
  • If zero results, suggest broadening filters or checking that Salesforce sync is configured
  • If an audience name was provided but not found, suggest checking the segment name in Clay Audiences

Parameters

Optional
audienceNamestring
filtersobject
limitinteger
Default: 50
offsetinteger
Default: 0

Get-task

get-task
Full Description

Get task status and results by task ID. This tool handles all task types (search, direct) and returns the current state.

When to Use This Tool

This is a private tool used by the widget for polling task status.

Parameters

taskId (required)

  • The task ID to retrieve. Accepts:
    • Universal task IDs: mcp-task-* (from run_subroutine_direct, etc.)
    • Legacy search IDs: cgas-search-id-* (backwards compatible)

Parameters

Required
taskIdstring

The task ID to retrieve (mcp-task-* or legacy cgas-search-id-*)

List Subroutines

list_subroutines
Full Description

List available custom functions. Available functions: . Call this to see their required inputs before using run_subroutine.

Run Subroutine

run_subroutine
Full Description

Execute a function on contacts/companies FROM AN EXISTING SEARCH ().

STOP! Choose the right tool:

  • User gave you specific values (LinkedIn URL, name, email)? → Use run_subroutine_direct instead!
  • User wants to run on contacts from a previous search? → Use THIS tool (run_subroutine)

Usage (only if you have a taskId from a previous search)

  • Single contact: pass taskId + entityIds + fieldMapping
  • All contacts: pass taskId + fieldMapping

fieldMapping format

Format: { "entityField": "subroutineInput" }

  • KEY = entity field name (from contact data, e.g. "name", "url", "domain")
  • VALUE = subroutine input name (from list_subroutines, e.g. "full_name", "linkedin_url")

Example: {"name": "full_name", "url": "linkedin_url", "domain": "company_domain"}

IMPORTANT

Do NOT try to generate or summarize the function results yourself. The results will appear in the widget.

Parameters

Required
subroutine_idstring

The ID of the subroutine to execute. Get this from list_subroutines.

taskIdstring

Required. The taskId from the existing search/widget to add results to.

Optional
entityIdsarray

Optional. Array of entityIds to run on. When omitted with fieldMapping, runs on all contacts.

fieldMappingobject

Required for batch mode (running on ALL contacts). Format: { "entityField": "subroutineInput" } — the KEY is the entity field name (from contact data), the VALUE is the subroutine input name. Example: if entity has "name" and subroutine needs "full_name", use {"name": "full_name"}. Either provide entityIds OR fieldMapping, not both.

Run Subroutine Direct

run_subroutine_direct
Full Description

Execute a custom function directly with provided inputs. NO existing task or entityIds needed.

When to Use This Tool

Use this tool when the user provides specific input values (like a LinkedIn URL, name, email, etc.) and wants to run a function on that data directly. This is the PREFERRED tool when the user gives you concrete values to work with.

When NOT to Use This Tool

Do NOT use this tool if you need to run on contacts from an existing search. Use run_subroutine instead for batch operations on search results.

Usage

Just provide:

  • subroutine_id: from list_subroutines
  • inputs: the actual values (e.g., {"Linkedin URL": "https://linkedin.com/in/someone", "Full name": "John Doe"})

IMPORTANT

Do NOT try to generate or summarize the function results yourself. The results will appear in the widget. Just confirm briefly that the function is running.

Response Behavior

Confirm briefly: "Running [function name]—results will appear shortly."

Parameters

Required
inputsobject

The actual input values for the subroutine. Keys must match the input names from list_subroutines. Example: {"Linkedin URL": "https://linkedin.com/in/john", "Full name": "John Doe"}

subroutine_idstring

The ID of the subroutine to execute. Get this from list_subroutines.

Run Subroutine No Mapping

run_subroutine_no_mapping
Full Description

Run a custom subroutine on search entities. The backend automatically generates the field mapping.

Parameters

Required
subroutine_idstring

The ID of the subroutine to execute.

taskIdstring

The taskId from the existing search.

Optional
entityIdsarray

Optional. Array of entityIds to run on. When omitted, runs on all entities.

Track-event

track-event
Full Description

Track an analytics event with optional properties.

Parameters

Required
eventNamestring

The name of the event to track

Optional
propertiesobject

Additional properties to include with the event