Get Competitor
curl --request GET \
--url https://app.octavehq.com/api/v2/competitor/get \
--header 'api_key: <api-key>'import requests
url = "https://app.octavehq.com/api/v2/competitor/get"
headers = {"api_key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {api_key: '<api-key>'}};
fetch('https://app.octavehq.com/api/v2/competitor/get', 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://app.octavehq.com/api/v2/competitor/get",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"api_key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.octavehq.com/api/v2/competitor/get"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("api_key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.octavehq.com/api/v2/competitor/get")
.header("api_key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/competitor/get")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["api_key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"oId": "<string>",
"createdAt": "<string>",
"name": "<string>",
"internalName": "<string>",
"description": "<string>",
"updatedAt": "<string>",
"deletedAt": "<string>",
"archivedAt": "<string>",
"active": true,
"data": {
"howTheyPosition": [
"<string>"
],
"ourKeyDifferentiators": [
"<string>"
],
"competitorStrengths": [
"<string>"
],
"competitorWeaknesses": [
"<string>"
],
"reasonsWeWin": [
"<string>"
],
"reasonsWeLose": [
"<string>"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
]
},
"user": {
"oId": "<string>",
"firstName": "John",
"lastName": "Doe"
},
"workspace": {
"oId": "<string>"
}
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}Competitor
Get Competitor
Get Competitor by OId
GET
/
api
/
v2
/
competitor
/
get
Get Competitor
curl --request GET \
--url https://app.octavehq.com/api/v2/competitor/get \
--header 'api_key: <api-key>'import requests
url = "https://app.octavehq.com/api/v2/competitor/get"
headers = {"api_key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {api_key: '<api-key>'}};
fetch('https://app.octavehq.com/api/v2/competitor/get', 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://app.octavehq.com/api/v2/competitor/get",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"api_key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.octavehq.com/api/v2/competitor/get"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("api_key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.octavehq.com/api/v2/competitor/get")
.header("api_key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/competitor/get")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["api_key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"oId": "<string>",
"createdAt": "<string>",
"name": "<string>",
"internalName": "<string>",
"description": "<string>",
"updatedAt": "<string>",
"deletedAt": "<string>",
"archivedAt": "<string>",
"active": true,
"data": {
"howTheyPosition": [
"<string>"
],
"ourKeyDifferentiators": [
"<string>"
],
"competitorStrengths": [
"<string>"
],
"competitorWeaknesses": [
"<string>"
],
"reasonsWeWin": [
"<string>"
],
"reasonsWeLose": [
"<string>"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
]
},
"user": {
"oId": "<string>",
"firstName": "John",
"lastName": "Doe"
},
"workspace": {
"oId": "<string>"
}
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}Authorizations
Query Parameters
Competitor OId
Response
Competitor data
Show child attributes
Show child attributes
Competitor OId
Creation date
Competitor name
Competitor internal name
Competitor description
Updated date
Deleted date
Archived date
Show child attributes
Show child attributes
User data
Show child attributes
Show child attributes
Workspace data
Show child attributes
Show child attributes
⌘I