Endpoints

POST /account-intelligence

This endpoint is used to retrieve account intelligence data on a given company.

Example usage

curl -X POST 'https://app.hockeystack.com/integration/sales/account-intelligence?v=2' \
     -H "Authorization: Bearer YOUR_API_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
       "company_domain": "example.com",
       "fields_to_get": "hockeystack_goals,company_details_hockeystack,website_visitors,website_visits"
     }'

Request body

• company_domain - required The normalized domain of the company to fetch. Do not include https:// or www. or any trailing slashes in the domain. E.g. hockeystack.com

• fields_to_get - optional The comma separated list of fields to fetch from the API. No spaces allowed before or after comma. Available options:

  • hockeystack_goals

  • company_details_hockeystack

  • website_visitors

  • website_visits

  If this param not provided, will return all the available fields and request may take longer to process, so ideally you should provide a specific set of fields that you are looking for.

Response format

{
  "result": {
    // Response status
    "status": string <'success'|'processing'|'error'>,
    // Response status code
    "code": number,
    // Company domain passed in request
    "companyDomain": string,
    "research": {
      // Contains a list of Goals defined in HockeyStack
      "hockeystack_goals": [{
        // Name of the goal
        "name": string,
        // Text description of the goal, generated by AI
        "nl_definition": string,
        //The number of times goal was reached by company
        "times_done": number
      }],
      // Contains details about the company that exist in the HockeyStack database
      "company_details_hockeystack": {},
      // Information about known website visitors
      "website_visitors": [{
        // Email of the visitor
        "email": string,
        // Full name of the visitor
        "full_name": string,
        // Title of the visitor at the given company
        "title": string,
        // LinkedIn Profile URL of the visitor, starting with https://
        "linkedin_profile": string,
        // Whether or not the visitor is a decision maker at the company
        "is_decision_maker": boolean
      }],
      // Latest 200 pageviews of the company
      "website_visits": [{
        // Either the email of the person that did the pageview, or their anonymous id
        "user_id": string,
        // The referrer of the session
        "referrer": string,
        // The full page url, starting with https://
        "page_url": string,
        // The UTM Source from the URL parameters
        "utm_source": string,
        // The UTM Medium from the URL parameters
        "utm_medium": string,
        // The UTM Campaign from the URL parameters
        "utm_campaign": string,
        // The UTM Content from the URL parameters
        "utm_content": string,
        // The UTM Term from the URL parameters
        "utm_term": string,
        // The date of the pageview, in YYYY-MM-DD HH:mm:ss format, in UTC
        "action_date": string03:48"
      }]
    }
  }
}