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

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

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"
}
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
Input either Company Name or/and Company Domain Name.
Response body
{
            "status": "status_code",
            "message": "status_message"
}
                                        
Status code Description
200 Request to recommend a company is successful
201 Post a valid Company Name or Company Domain Name

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

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

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
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