curl --request GET \
  --url https://api.heralded.ai/v1/brands/{brand_id}/competitors \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.heralded.ai/v1/brands/{brand_id}/competitors"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.heralded.ai/v1/brands/{brand_id}/competitors', 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.heralded.ai/v1/brands/{brand_id}/competitors",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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://api.heralded.ai/v1/brands/{brand_id}/competitors"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.heralded.ai/v1/brands/{brand_id}/competitors")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.heralded.ai/v1/brands/{brand_id}/competitors")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "channels": [
    {
      "answers": 123,
      "domain": "<string>",
      "mentioned": 123,
      "name": "<string>",
      "prompts": 123
    }
  ],
  "competitors": [
    {
      "domain": "<string>",
      "heralded_score": {
        "answers": 123,
        "change": {
          "baseline": {
            "first_answer_at": "2023-11-07T05:31:56Z",
            "last_answer_at": "2023-11-07T05:31:56Z",
            "reports": 123
          },
          "cells_unpaired": 123,
          "delta": 123,
          "direction": "up",
          "high": 123,
          "low": 123,
          "real": true
        },
        "denominator": 123,
        "high": 123,
        "low": 123,
        "numerator": 123,
        "state": "measured",
        "trend": [
          {
            "answers": 123,
            "at": "2023-11-07T05:31:56Z",
            "break_label": "<string>",
            "high": 123,
            "low": 123,
            "state": "measured",
            "value": 123
          }
        ],
        "value": 123
      },
      "is_you": true,
      "mentioned": {
        "answers": 123,
        "change": {
          "baseline": {
            "first_answer_at": "2023-11-07T05:31:56Z",
            "last_answer_at": "2023-11-07T05:31:56Z",
            "reports": 123
          },
          "cells_unpaired": 123,
          "delta": 123,
          "direction": "up",
          "high": 123,
          "low": 123,
          "real": true
        },
        "denominator": 123,
        "high": 123,
        "low": 123,
        "numerator": 123,
        "state": "measured",
        "trend": [
          {
            "answers": 123,
            "at": "2023-11-07T05:31:56Z",
            "break_label": "<string>",
            "high": 123,
            "low": 123,
            "state": "measured",
            "value": 123
          }
        ],
        "value": 123
      },
      "name": "<string>",
      "rank": 123,
      "recommended": {
        "answers": 123,
        "change": {
          "baseline": {
            "first_answer_at": "2023-11-07T05:31:56Z",
            "last_answer_at": "2023-11-07T05:31:56Z",
            "reports": 123
          },
          "cells_unpaired": 123,
          "delta": 123,
          "direction": "up",
          "high": 123,
          "low": 123,
          "real": true
        },
        "denominator": 123,
        "high": 123,
        "low": 123,
        "numerator": 123,
        "state": "measured",
        "trend": [
          {
            "answers": 123,
            "at": "2023-11-07T05:31:56Z",
            "break_label": "<string>",
            "high": 123,
            "low": 123,
            "state": "measured",
            "value": 123
          }
        ],
        "value": 123
      },
      "share_of_voice_pct": 123
    }
  ],
  "discovered": [
    {
      "answers": 123,
      "domain": "<string>",
      "high": 123,
      "low": 123,
      "name": "<string>",
      "state": "measured",
      "value": 123
    }
  ],
  "menus": {
    "intents": [
      {
        "count": 123,
        "label": "<string>",
        "value": "<string>"
      }
    ],
    "segments": [
      {
        "count": 123,
        "label": "<string>",
        "value": "<string>"
      }
    ],
    "topics": [
      {
        "count": 123,
        "label": "<string>",
        "value": "<string>"
      }
    ],
    "types": [
      {
        "count": 123,
        "label": "<string>",
        "value": "<string>"
      }
    ]
  },
  "meta": {
    "data_as_of": {
      "completed_at": "2023-11-07T05:31:56Z",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "query": {}
  },
  "next_cursor": "<string>",
  "page": {
    "can_track": true,
    "capacity": {
      "cap": 123,
      "used": 123
    },
    "channels": {
      "cells": [
        {
          "answers": 123,
          "brand_key": "<string>",
          "brand_name": "<string>",
          "domain": "<string>",
          "is_new": true,
          "line": "<string>",
          "mentioned": 123,
          "prompts": 123,
          "score": {
            "answer_read_id": "<string>",
            "answers": 123,
            "band": "<string>",
            "key": "<string>",
            "label": "<string>",
            "state": "measured",
            "tooltip": "<string>",
            "value": 123
          }
        }
      ],
      "limit": 123,
      "offset": 123,
      "total": 123
    },
    "discovered": {
      "cells": [
        {
          "answers": 123,
          "brand_key": "<string>",
          "brand_name": "<string>",
          "domain": "<string>",
          "is_new": true,
          "line": "<string>",
          "mentioned": 123,
          "prompts": 123,
          "score": {
            "answer_read_id": "<string>",
            "answers": 123,
            "band": "<string>",
            "key": "<string>",
            "label": "<string>",
            "state": "measured",
            "tooltip": "<string>",
            "value": 123
          }
        }
      ],
      "limit": 123,
      "offset": 123,
      "total": 123
    },
    "leaderboard": {
      "direction": "asc",
      "limit": 123,
      "offset": 123,
      "rows": [
        {
          "brand_key": "<string>",
          "brand_name": "<string>",
          "domain": "<string>",
          "is_you": true,
          "mentioned": 123,
          "rank": 123,
          "recommended": 123,
          "score": {
            "answer_read_id": "<string>",
            "answers": 123,
            "band": "<string>",
            "key": "<string>",
            "label": "<string>",
            "state": "measured",
            "tooltip": "<string>",
            "value": 123
          },
          "trend": {
            "delta": 123,
            "label": "<string>",
            "state": "up"
          }
        }
      ],
      "sort": "brand",
      "total": 123
    },
    "period": {
      "excluded_reports": 123,
      "first_answer_at": "2023-11-07T05:31:56Z",
      "last_answer_at": "2023-11-07T05:31:56Z",
      "preset": "1w",
      "reports": 123
    },
    "sentence": "<string>",
    "share_of_voice": {
      "denominator": 123,
      "info": "<string>",
      "population": "all_answers",
      "segments": [
        {
          "brand_key": "<string>",
          "count": 123,
          "kind": "you",
          "label": "<string>",
          "numerator": 123,
          "pct": 123
        }
      ],
      "state": "measured"
    }
  },
  "period": {
    "excluded_reports": 123,
    "first_answer_at": "2023-11-07T05:31:56Z",
    "last_answer_at": "2023-11-07T05:31:56Z",
    "preset": "1w",
    "reports": 123
  },
  "share_of_voice": {
    "answers": 123,
    "excluded_answers": 123,
    "population": "all_answers",
    "rows": [
      {
        "denominator": 123,
        "is_you": true,
        "name": "<string>",
        "numerator": 123,
        "pct": 123
      }
    ],
    "state": "measured"
  }
}

{
  "code": "invalid_cursor",
  "detail": "The cursor is invalid or belongs to a different query.",
  "instance": "example-request-id",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}

{
  "code": "invalid_token",
  "detail": "The Authorization header carries no API key Heralded knows: it is missing, mistyped, revoked or expired.",
  "instance": "example-request-id",
  "status": 401,
  "title": "Unauthorized",
  "type": "about:blank"
}

{
  "code": "not_found",
  "detail": "Nothing here that this API key can read.",
  "instance": "example-request-id",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

{
  "code": "workspace_archived",
  "detail": "The API key's organization is archived.",
  "instance": "example-request-id",
  "status": 409,
  "title": "Conflict",
  "type": "about:blank"
}

{
  "code": "invalid_request",
  "detail": "The request's parameters are invalid; `errors` names each one.",
  "errors": [
    {
      "loc": [
        "query",
        "limit"
      ],
      "msg": "Input should be less than or equal to 100",
      "type": "less_than_equal"
    }
  ],
  "instance": "example-request-id",
  "status": 422,
  "title": "Unprocessable Content",
  "type": "about:blank"
}

{
  "code": "rate_limited",
  "detail": "This caller is past its requests for the minute. Retry after the seconds in Retry-After.",
  "instance": "example-request-id",
  "rate_limit": {
    "limit": 120,
    "remaining": 0,
    "reset": 60,
    "window": 60
  },
  "status": 429,
  "title": "Too Many Requests",
  "type": "about:blank"
}