List competitors
Returns the competitors tracked in the workspace, one page at a time.
Required scope: v2:org.
url can be null.
curl -X GET "https://api.opttab.com/v1/external/competitors?page=1&pageSize=20" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN"
import requests
import json
url = "https://api.opttab.com/v1/external/competitors?page=1&pageSize=20"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())
const response = await fetch("https://api.opttab.com/v1/external/competitors?page=1&pageSize=20", {
method: "GET",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
}
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
)
func main() {
req, err := http.NewRequest("GET", "https://api.opttab.com/v1/external/competitors?page=1&pageSize=20", nil)
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://api.opttab.com/v1/external/competitors?page=1&pageSize=20')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'
response = http.request(request)
puts response.body
{
"items": [
{
"id": "55555555-5555-4555-8555-555555555555",
"name": "South Running",
"url": "https://south.example"
}
],
"page": 1,
"pageSize": 20,
"totalCount": 1
}
{
"error": "Validation failed",
"code": "VALIDATION_ERROR",
"details": {
"formErrors": [],
"fieldErrors": {
"pageSize": [
"Number must be less than or equal to 100"
]
}
}
}
{
"error": "API_KEY_INVALID",
"code": "UNAUTHORIZED"
}
{
"error": "API_KEY_SCOPE",
"code": "FORBIDDEN"
}
{
"error": "API_KEY_IP_DENIED",
"code": "FORBIDDEN"
}
{
"error": "ThrottlerException: Too Many Requests",
"code": "RATE_LIMITED"
}
/v1/external/competitors
Target server for requests. Edit to use your own host.
An API key secret from Settings › API. It starts with opt_live_.
Send it as Authorization: Bearer opt_live_xxxxxxxx. A session cookie, an X-API-Key
header and an ?api_key= query parameter do not authenticate.
opt_live_.
Send it as Authorization: Bearer opt_live_xxxxxxxx. A session cookie, an X-API-Key
header and an ?api_key= query parameter do not authenticate.
The page to return, starting at 1.
Items per page. Maximum 100.
Request Preview
Response
Response will appear here after sending the request
Authentication
Bearer token. An API key secret from Settings › API. It starts with opt_live_.
Send it as Authorization: Bearer opt_live_xxxxxxxx. A session cookie, an X-API-Key
header and an ?api_key= query parameter do not authenticate.
Query Parameters
Responses
The page returned.
Items per page.
Total items across all pages.