Companies track
curl --request POST \
--url https://api.adside.ai/v1/workspaces/{workspaceId}/research/companies \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"websiteUrl": "<string>",
"collectionIds": [
"<string>"
],
"nickname": "<string>",
"notes": "<string>",
"priority": 3,
"confirmationToken": "<string>"
}
'import requests
url = "https://api.adside.ai/v1/workspaces/{workspaceId}/research/companies"
payload = {
"websiteUrl": "<string>",
"collectionIds": ["<string>"],
"nickname": "<string>",
"notes": "<string>",
"priority": 3,
"confirmationToken": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
websiteUrl: '<string>',
collectionIds: ['<string>'],
nickname: '<string>',
notes: '<string>',
priority: 3,
confirmationToken: '<string>'
})
};
fetch('https://api.adside.ai/v1/workspaces/{workspaceId}/research/companies', 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.adside.ai/v1/workspaces/{workspaceId}/research/companies",
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([
'websiteUrl' => '<string>',
'collectionIds' => [
'<string>'
],
'nickname' => '<string>',
'notes' => '<string>',
'priority' => 3,
'confirmationToken' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.adside.ai/v1/workspaces/{workspaceId}/research/companies"
payload := strings.NewReader("{\n \"websiteUrl\": \"<string>\",\n \"collectionIds\": [\n \"<string>\"\n ],\n \"nickname\": \"<string>\",\n \"notes\": \"<string>\",\n \"priority\": 3,\n \"confirmationToken\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.adside.ai/v1/workspaces/{workspaceId}/research/companies")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"websiteUrl\": \"<string>\",\n \"collectionIds\": [\n \"<string>\"\n ],\n \"nickname\": \"<string>\",\n \"notes\": \"<string>\",\n \"priority\": 3,\n \"confirmationToken\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.adside.ai/v1/workspaces/{workspaceId}/research/companies")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"websiteUrl\": \"<string>\",\n \"collectionIds\": [\n \"<string>\"\n ],\n \"nickname\": \"<string>\",\n \"notes\": \"<string>\",\n \"priority\": 3,\n \"confirmationToken\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"trackedCompany": {
"id": "<string>",
"workspaceId": "<string>",
"companyProfileId": "<string>",
"nickname": "<string>",
"notes": "<string>",
"priority": 3,
"classification": "COMPETITOR",
"status": "active",
"createdAt": "<string>",
"updatedAt": "<string>",
"companyProfile": {
"id": "<string>",
"domain": "<string>",
"websiteUrl": "<string>",
"companyName": "<string>",
"logo": "<string>",
"icon": "<string>",
"tagline": "<string>",
"brandColors": [
"<string>"
],
"toneOfVoice": [
"<string>"
],
"industry": "<string>",
"vertical": "<string>",
"marketPositioning": "<string>",
"websiteSnapshot": "<string>",
"websiteMarkdown": "<string>",
"lastScrapedAt": "<string>",
"scrapedVersion": 0,
"createdAt": "<string>",
"updatedAt": "<string>"
}
},
"needsScrape": true,
"outcome": "already_tracked",
"enrichmentQueued": true
}Research
Companies track
Track or reactivate a company and request its research
CLI: adside research companies track
POST
/
v1
/
workspaces
/
{workspaceId}
/
research
/
companies
Companies track
curl --request POST \
--url https://api.adside.ai/v1/workspaces/{workspaceId}/research/companies \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"websiteUrl": "<string>",
"collectionIds": [
"<string>"
],
"nickname": "<string>",
"notes": "<string>",
"priority": 3,
"confirmationToken": "<string>"
}
'import requests
url = "https://api.adside.ai/v1/workspaces/{workspaceId}/research/companies"
payload = {
"websiteUrl": "<string>",
"collectionIds": ["<string>"],
"nickname": "<string>",
"notes": "<string>",
"priority": 3,
"confirmationToken": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
websiteUrl: '<string>',
collectionIds: ['<string>'],
nickname: '<string>',
notes: '<string>',
priority: 3,
confirmationToken: '<string>'
})
};
fetch('https://api.adside.ai/v1/workspaces/{workspaceId}/research/companies', 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.adside.ai/v1/workspaces/{workspaceId}/research/companies",
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([
'websiteUrl' => '<string>',
'collectionIds' => [
'<string>'
],
'nickname' => '<string>',
'notes' => '<string>',
'priority' => 3,
'confirmationToken' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.adside.ai/v1/workspaces/{workspaceId}/research/companies"
payload := strings.NewReader("{\n \"websiteUrl\": \"<string>\",\n \"collectionIds\": [\n \"<string>\"\n ],\n \"nickname\": \"<string>\",\n \"notes\": \"<string>\",\n \"priority\": 3,\n \"confirmationToken\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.adside.ai/v1/workspaces/{workspaceId}/research/companies")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"websiteUrl\": \"<string>\",\n \"collectionIds\": [\n \"<string>\"\n ],\n \"nickname\": \"<string>\",\n \"notes\": \"<string>\",\n \"priority\": 3,\n \"confirmationToken\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.adside.ai/v1/workspaces/{workspaceId}/research/companies")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"websiteUrl\": \"<string>\",\n \"collectionIds\": [\n \"<string>\"\n ],\n \"nickname\": \"<string>\",\n \"notes\": \"<string>\",\n \"priority\": 3,\n \"confirmationToken\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"trackedCompany": {
"id": "<string>",
"workspaceId": "<string>",
"companyProfileId": "<string>",
"nickname": "<string>",
"notes": "<string>",
"priority": 3,
"classification": "COMPETITOR",
"status": "active",
"createdAt": "<string>",
"updatedAt": "<string>",
"companyProfile": {
"id": "<string>",
"domain": "<string>",
"websiteUrl": "<string>",
"companyName": "<string>",
"logo": "<string>",
"icon": "<string>",
"tagline": "<string>",
"brandColors": [
"<string>"
],
"toneOfVoice": [
"<string>"
],
"industry": "<string>",
"vertical": "<string>",
"marketPositioning": "<string>",
"websiteSnapshot": "<string>",
"websiteMarkdown": "<string>",
"lastScrapedAt": "<string>",
"scrapedVersion": 0,
"createdAt": "<string>",
"updatedAt": "<string>"
}
},
"needsScrape": true,
"outcome": "already_tracked",
"enrichmentQueued": true
}Authorizations
A personal API key (adside_pat_…) or a token from adside login. Either carries the permissions of the person it belongs to.
Path Parameters
Minimum string length:
1Body
application/json