Intellizence REST API Documentation

The REST APIs are available under https://api.intellizence.com/api/v1/ endpoint. You’ll have to pass the API key in HTTP header with the name x-api-key. Please send a mail to customersuccess@intellizence.com to get an API key.

List Companies

Returns a list of matching companies from the Intellizence database

GET /api/v1/companies HTTP/1.1
Param Mandatory Description
name N Partial name of the Company, minimum 3 chars required.
domain N Partial Domain Name without http(s), minimum 6 chars required.
You have to pass either Company Name or Domain Name.
Response body
{
    "status":"status_code",
    "message":"status_message",
    "companies": [
        {
            "id": "intellizence_company_id_1",
            "name": "company_name_1",
            "domain": "company_domain_1"
        },
        {
            "id": "intellizence_company_id_2",
            "name": "company_name_2",
            "domain": "company_domain_2"
        }
    ]
}
Status code Description
200 Success
201 Input minimum 3 chars of Company Name or minimum 6 chars of Domain Name
202 Minimum 3 chars of Company Name required
203 Minimum 6 chars of Domain Name required

Add Group

Add a group

POST /api/v1/group/{GROUP_NAME} HTTP/1.1 
Replace GROUP_NAME with the group name that you would like to add
Response body
{
            "status": "status_code",
            "message": "status_message"
}
Status code Description
200 Group added
201 Group Name already exists

Delete Group

Delete a group

DELETE /api/v1/group/{GROUP_NAME} HTTP/1.1 
Replace GROUP_NAME with the group name that you would like to delete
Response body
{
            "status": "status_code",
            "message": "status_message"
}
Status code Description
200 Group deleted
404 Group Name does not exist

List of tracked Companies

Returns a list of tracked companies for the given API key and Group Name

GET /api/v1/tracked-companies/{GROUP_NAME} HTTP/1.1 
Replace GROUP_NAME with the group name
Response body
{
    "status":"status_code",
    "message":"status_message",
    "companies": [
        {
            "id": "intellizence_company_id_1",
            "name": "company_name_1",
            "domain": "company_domain_1"
        },
        {
            "id": "intellizence_company_id_2",
            "name": "company_name_2",
            "domain": "company_domain_2"
        }
    ]
}
Status code Description
200 Success
404 Group Name does not exist

Add Company

Add a Company to track

POST /api/v1/company/{GROUP_NAME}/{COMPANY_ID} HTTP/1.1
Replace COMPANY_ID with the Intellizence Company Id that you would like to add and GROUP_NAME with the Group Name
Response body
{
            "status": "status_code",
            "message": "status_message"
}
Status code Description
200 Company added
201 Post a valid Company Id
202 Company Id does not exist in the Intellizence database
203 Company already been tracked
404 Group Name does not exist

Remove Company

Remove a Company from tracking

DELETE /api/v1/company/{GROUP_NAME}/{COMPANY_ID} HTTP/1.1
Replace COMPANY_ID with the Intellizence Company Id that you would like to remove and GROUP_NAME with the Group Name
Response body
{
            "status": "status_code",
            "message": "status_message"
}
Status code Description
200 Company removed
201 Post a valid Company Id
202 Company not been tracked
404 Group Name does not exist

Bulk add Companies

Add companies to track

POST /api/v1/company/{GROUP_NAME} HTTP/1.1
Replace GROUP_NAME with the Group Name under which the companies have to be added
Request body
{
            "companyIds": ["company_id"]
}
Param Mandatory Description
company_id Y Array of Intellizence Company Ids that you would like to add
Response body
{
            "nonExistingCompanyIds": ["company_id"],
            "alreadyTrackedCompanyIds": ["company_id"],
            "addedCompanyIds": ["company_id"]
}
Param Description
nonExistingCompanyIds Array of Company Ids which are not existing in the Intellizence database
alreadyTrackedCompanyIds Array of Company Ids which are already been tracked
addedCompanyIds Array of Company Ids which are added

Bulk Remove Companies

Remove companies from tracking

DELETE /api/v1/company/{GROUP_NAME} HTTP/1.1
Replace GROUP_NAME with the Group Name under which the companies have to be removed
Request body
{
            "companyIds": ["company_id"]
}
Param Mandatory Description
company_id Y Array of Intellizence Company Ids that you would like to remove
Response body
{
            "nonExistingCompanyIds": ["company_id"],
            "nonTrackedCompanyIds": ["company_id"],
            "removedCompanyIds": ["company_id"]
}
Param Description
nonExistingCompanyIds Array of Company Ids which are not existing in the Intellizence database
nonTrackedCompanyIds Array of Company Ids which are not been tracked
removedCompanyIds Array of Company Ids which are removed

Recommend Company

Recommend a Company Name to be added in the Intellizence database

POST /api/v1/recommend-company HTTP/1.1
Request body
{
            "name": "company_name",
            "domain": "company_domain_name",
            "notes": "notes"
}
Param Mandatory Description
name N Company Name that you would recommended to be added in the Intellizence database
domain N Company Domain Name that you would recommended to be added in the Intellizence database
notes N Any comments / notes that you want to add to help us in resolving the recommended company
Input either Company Name or/and Company Domain Name.
Response body
{
            "status": "status_code",
            "message": "status_message",
            "recommendation":{
                  "id": "recommendation_id",
                  "ETA": "ETA"
            }
}
Status code Description
200 Request to recommend a company is successful
201 Post a valid Company Name or Company Domain Name
id Unique id given to this recommendation, which can be used to find the status of recommendation
ETA ETA when this recommendation be acted upon

Check Company Recommendation Status

Check the status of the recommendation to add a Company Name in the Intellizence database

GET /api/v1/company-recommendation/{RECOMMENDATION_ID} HTTP/1.1
Replace RECOMMENDATION_ID with the recommendation id that you received in response of posting the recommendation
Response body
{
            "status": "status_code",
            "message": "status_message",
            "matches":[
                   {
                        "id": "company_id",
                        "name": "company_name",
                        "domain": "company_domain"
                   }
            ]
}
Status code Description
201 Recommendation request is pending
404 Invalid recommendation id
EXACT_MATCH Exact match found for the recommended company name and the recommended company name is added in Intellizence database
REBRANDED_MERGED_ACQUIRED The recommended company is been rebranded or merged or acquired.
MULTI_MATCHES There are many matches exist for the recommended company name
INVALID The recommended company name is invalid
matches Array which contains:
  • Intellizence company id, name and domain in case of EXACT_MATCH and REBRANDED_MERGED_ACQUIRED
  • All matching company names and domains in case of MULTI_MATCHES
  • Empty array in case of INVALID

List Triggers

Returns list of all available triggers in the Intellizence database

GET /api/v1/triggers HTTP/1.1
Response body
{
    "triggers": [
        {
            "id": "trigger_code_1",
            "name": "trigger_name_1"
        },
        {
            "id": "trigger_code_2",
            "name": "trigger_name_2"
        }
    ]
}

List of tracked Triggers

Returns a list of all tracked triggers for the given API key

GET /api/v1/tracked-triggers/{GROUP_NAME} HTTP/1.1 
Replace GROUP_NAME with the Group Name
Response body
{
    "status":"status_code",
    "message":"status_message",
    "triggers": [
        {
            "id": "trigger_code_1",
            "name": "trigger_name_1"
        },
        {
            "id": "trigger_code_2",
            "name": "trigger_name_2"
        }
    ]
}
Status code Description
200 Success
404 Group Name does not exist

Add Trigger

Add a Trigger to track

POST /api/v1/trigger/{GROUP_NAME}/{TRIGGER_CODE} HTTP/1.1
Replace TRIGGER_CODE with the Intellizence Trigger Code that you would like to add and GROUP_NAME with the Group Name
Response body
{
            "status": "status_code"
}
Status code Description
200 Trigger added
201 Post a valid Trigger Code
202 Trigger Code does not exist in the Intellizence database
203 Trigger already been tracked
404 Group Name does not exist

Remove Trigger

Remove a Trigger from tracking

DELETE /api/v1/trigger/{GROUP_NAME}/{TRIGGER_CODE} HTTP/1.1
Replace TRIGGER_CODE with the Intellizence Trigger Code that you would like to remove and GROUP_NAME with the Group Name
Response body
{
            "status": "status_code"
}
Status code Description
200 Trigger removed
201 Post a valid Trigger Code
202 Trigger is not been tracked
404 Group Name does not exist

Bulk add Triggers

Add Triggers to track

POST /api/v1/trigger/{GROUP_NAME} HTTP/1.1
Replace GROUP_NAME with the Group Name under which the triggers have to be added
Request body
{
            "triggerCodes": ["trigger_code"]
}
Param Mandatory Description
trigger_code Y Array of Intellizence Trigger Codes that you would like to add
Response body
{
            "nonExistingTriggerCodes": ["trigger_code"],
            "alreadyTrackedTriggerCodes": ["trigger_code"],
            "addedTriggerCodes": ["trigger_code"]
}
Param Description
nonExistingTriggerCodes Array of Trigger Codes which are not existing in the Intellizence database
alreadyTrackedTriggerCodes Array of Trigger Codes which are already been tracked
addedTriggerCodes Array of Trigger Codes which are added

Bulk Remove Triggers

Remove triggers from tracking

DELETE /api/v1/trigger/{GROUP_NAME} HTTP/1.1
Replace GROUP_NAME with the Group Name under which the triggers have to be removed
Request body
{
            "triggerCodes": ["trigger_code"]
}
Param Mandatory Description
trigger_code Y Array of Intellizence Trigger Codes that you would like to remove
Response body
{
            "nonExistingTriggerCodes": ["trigger_code"],
            "nonTrackedTriggerCodes": ["trigger_code"],
            "removedTriggerCodes": ["trigger_code"]
}
Param Description
nonExistingTriggerCodes Array of Trigger Codes which are not existing in the Intellizence database
nonTrackedTriggerCodes Array of Trigger Codes which are not been tracked
removedTriggerCodes Array of Trigger Codes which are removed

Search

Returns news based on search parameters

GET /api/v1/search HTTP/1.1
Param Mandatory Description
company N It will return news for this Company Name
domain N It will return news for this Company Domain Name without http(s)
trigger N It will return news for this Trigger
keyword N It will return news which has this keyword
startDate N It will return news published from this date in format DD/MM/YYYY
endDate N It will return news published till this date in format DD/MM/YYYY
page N Page number for which news are required, default is 1
limit N Number of news per page, default is 30 and maximum value can be 100
group Y It will return news for the Companies and Triggers under this Group Name 
If Company Name is not passed, it will return news for all the tracked companies.
                                            
If Trigger is not passed, it will return news for all the tracked triggers.
                                            
If none of the above parameters are passed, it will return recent 30 news for all the tracked
companies and triggers.
Response body
{
    "status": "status_code",
    "news": [
        {
            "id": "new_id_1",
            "publisher": "news_publisher_1",
            "title": "new_title_1",
            "url": "new_url_1",
            "content": "news_content_1",
            "publishDate": "news_published_date_1",
            "company": "[company_1", "company_2"],
            "triggers": ["trigger_1", "trigger_2"]
        },
        {
            "title": "new_title_2",
            "content": "news_content_2",
            "date": "news_published_date_2",
            "publisher": "news_publisher_2",
            "company": "news_company_2",
            "triggers": ["trigger_1", "trigger_2"]
        }
    ]
}
Status code Description
200 Success
201 Start Date should be in DD/MM/YYYY format
202 End Date should be in DD/MM/YYYY format
203 Company not been tracked
204 Trigger not been tracked
205 Company Name does not exist in the Intellizence database
206 Domain Name does not exist in the Intellizence database
207 Trigger does not exist in the Intellizence database
404 Group Name does not exist

Business Event Datasets Configurations

Returns business event Dataset configurations

GET /v1/business-entity-configurations HTTP/1.1
Response body
{
    "status": "status_code",
    "configurations": [
        {
            "id": "configuration id",
            "title": "title"
        } 
    ]
}

Business Event Datasets

Returns business event Datasets based on search parameters

GET /v1/business-entities HTTP/1.1
Param Mandatory Description
id Y Business event dataset configuration id. Please refer business event dataset configuration api to get configurations
startDate Y It will return business event datasets from this date in format DD/MM/YYYY
endDate Y It will return business event datasets till this date in format DD/MM/YYYY
Response body - Fundraising
{
    "status": "status_code",
    "data": [
        {
            "title": "source title",
            "url": "source url",
            "announcedDate": "announced date",
            "venture": {
                    "name":"name of the company raised funds",
                    "id": "company id",
                    "domain": "company website domain",
                    "industrySegments": "array of industry segments associated with the company",
                    "industries": "array of industries associated with the company",
                    "HQLocation": "company headquarters"
            },
            "amount": "amount raised"
            "currency": "currency",
            "fundingRound": "funding round",
            "investors": "list of investors in comma separated values",
            "leadInvestors": "list of lead investors in comma separated values"
        } 
    ]
}
Response body - Merger & Acquisition
{
    "status": "status_code",
    "data": [
        {
            "title": "source title",
            "url": "source url",
            "announcedDate": "announced date",
            "acquiringCompany": {
                    "name":"name of the acquiring company",
                    "id": "company id",
                    "domain": "company website domain",
                    "industrySegments": "array of industry segments associated with the company",
                    "industries": "array of industries associated with the company",
                    "HQLocation": "company headquarters"
            },
            "acquiredCompany": {
                    "name":"name of the acquired company",
                    "id": "company id",
                    "domain": "company website domain",
                    "industrySegments": "array of industry segments associated with the company",
                    "industries": "array of industries associated with the company",
                    "HQLocation": "company headquarters"
            },
            "dealAmount": "deal amount"
            "currency": "currency",
            "typeOfAcquisition": "type of acquisition",
            "mnaStatus": "merger & acquisition status"
        } 
    ]
}
Response body - Layoff 
{
    "status": "status_code",
    "data": [
        {
            "title": "source title",
            "url": "source url",
            "announcedDate": "announced date",
            "companyName": {
                    "name":"name of the company laying off",
                    "id": "company id",
                    "domain": "company website domain",
                    "industrySegments": "array of industry segments associated with the company",
                    "industries": "array of industries associated with the company",
                    "HQLocation": "company headquarters"
            },
            "number": "laid off number"
            "numberType": "is laid off number - Numeric or Percent",
            "typeOfJob": "type of job",
            "layoffType": "Array of layoff type",
            "layoffReason": "layoff reason",
            "location": {
                    "country":"country",
                    "state": "state",
                    "city": "city"
            },
            "roleImpacted": "role impacted"
        } 
    ]
}

Push News

Post news to the given REST end point

POST /api/v1/push-news/{GROUP_NAME}/{DAYS} HTTP/1.1
Replace GROUP_NAME with the Group Name and DAYS with the number of days for which news have to be posted.
Maximum number of days can be 5 
You’ll have to pass the REST end point URL to which news have to be posted in HTTP header with the name callback-url.
Response body
{
            "response": "response"
}
Param Description
response Response received from the callback-url after posting the news
News are posted in the JSON format
{
    "group": "group_name",
    "postedDate": "posted_date",
    "news": [
        {
            "id": "new_id",
            "publisher": "news_publisher",
            "title": "new_title",
            "url": "new_url",
            "desc": "news_desc",
            "publishDate": "news_published_date",
            "companies": [ 
               {
                "id": "Intellizence_company_id"
                }
            ],
            "triggers": ["trigger"]
        }
    ]
}