Get citation statistics for a brand report

curl --request GET \
  --url https://data.otterly.ai/v1/reports/brand/{reportId}/citations/stats \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://data.otterly.ai/v1/reports/brand/{reportId}/citations/stats"

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

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

print(response.text)

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

fetch('https://data.otterly.ai/v1/reports/brand/{reportId}/citations/stats', 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://data.otterly.ai/v1/reports/brand/{reportId}/citations/stats",
  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://data.otterly.ai/v1/reports/brand/{reportId}/citations/stats"

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

}

require 'uri'
require 'net/http'

url = URI("https://data.otterly.ai/v1/reports/brand/{reportId}/citations/stats")

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

{
  "domainRank": {
    "citations": [
      {
        "domain": "adidas.com",
        "rank": 1,
        "citations": 42,
        "logoUrl": "https://logo.clearbit.com/adidas.com",
        "citationShare": 0.42,
        "main": true
      }
    ]
  },
  "domainCitations": {
    "current": 42,
    "total": 100,
    "citationShare": 0.42,
    "mostCitedUrls": [
      {
        "url": "https://www.adidas.com/us/running",
        "rank": 1,
        "currentCitations": 18,
        "citationShare": 0.42
      }
    ]
  },
  "citations": [
    {
      "url": "https://www.adidas.com/us/running",
      "rank": 1,
      "currentCitations": 18,
      "logoUrl": "https://logo.clearbit.com/adidas.com",
      "citationShare": 0.42
    }
  ],
  "competitors": [
    {
      "brandDomain": "nike.com",
      "domainCitations": {
        "current": 12,
        "total": 100,
        "citationShare": 0.12
      }
    }
  ]
}

{
  "message": "Validation failed",
  "target": "query",
  "errors": [
    {
      "path": "country",
      "message": "Required",
      "code": "invalid_type"
    }
  ]
}

{
  "message": "Report not found"
}

{
  "message": "Report not found"
}

{
  "message": "Report not found"
}

GET

reports

brand

{reportId}

citations

stats

Get citation statistics for a brand report

curl --request GET \
  --url https://data.otterly.ai/v1/reports/brand/{reportId}/citations/stats \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://data.otterly.ai/v1/reports/brand/{reportId}/citations/stats"

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

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

print(response.text)

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

fetch('https://data.otterly.ai/v1/reports/brand/{reportId}/citations/stats', 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://data.otterly.ai/v1/reports/brand/{reportId}/citations/stats",
  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://data.otterly.ai/v1/reports/brand/{reportId}/citations/stats"

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

}

require 'uri'
require 'net/http'

url = URI("https://data.otterly.ai/v1/reports/brand/{reportId}/citations/stats")

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

{
  "domainRank": {
    "citations": [
      {
        "domain": "adidas.com",
        "rank": 1,
        "citations": 42,
        "logoUrl": "https://logo.clearbit.com/adidas.com",
        "citationShare": 0.42,
        "main": true
      }
    ]
  },
  "domainCitations": {
    "current": 42,
    "total": 100,
    "citationShare": 0.42,
    "mostCitedUrls": [
      {
        "url": "https://www.adidas.com/us/running",
        "rank": 1,
        "currentCitations": 18,
        "citationShare": 0.42
      }
    ]
  },
  "citations": [
    {
      "url": "https://www.adidas.com/us/running",
      "rank": 1,
      "currentCitations": 18,
      "logoUrl": "https://logo.clearbit.com/adidas.com",
      "citationShare": 0.42
    }
  ],
  "competitors": [
    {
      "brandDomain": "nike.com",
      "domainCitations": {
        "current": 12,
        "total": 100,
        "citationShare": 0.12
      }
    }
  ]
}

{
  "message": "Validation failed",
  "target": "query",
  "errors": [
    {
      "path": "country",
      "message": "Required",
      "code": "invalid_type"
    }
  ]
}

{
  "message": "Report not found"
}

{
  "message": "Report not found"
}

{
  "message": "Report not found"
}

Authorizations

Authorization

string

header

required

Provide your API key as a Bearer token: Authorization: Bearer YOUR_API_KEY.

Path Parameters

reportId

string

required

Brand report identifier.

Minimum string length: 1

Example:

"01HX7K2YV9D3M8N0G6Q5R4S3T2"

Query Parameters

startDate

string

required

Start date for the stats window (inclusive).

Minimum string length: 1

Example:

"2025-01-01"

endDate

string

required

End date for the stats window (inclusive).

Minimum string length: 1

Example:

"2025-01-31"

country

string

required

Country code to filter by. Lowercase ISO 3166-1 alpha-2; use uk for the United Kingdom.

Minimum string length: 1

Example:

"us"

engines

Optional. AI engine(s) to filter by. Repeat the param or pass a single value.

Available options:

chatgpt,

google,

perplexity,

copilot,

google_ai_mode,

gemini,

claude

Example:

"chatgpt"

tagId

string

Optional. Filter stats by tag id.

domainLimit

integer

Optional. Cap on number of distinct domains aggregated into the response. Positive integer. At most 400 domains are returned whatever the value; fewer is possible after brand variation domains are merged.

Example:

10

Response

Citation statistics for the brand report.

domainRank

object

required

Show child attributes

domainCitations

object

required

Show child attributes

citations

object[]

required

Show child attributes

competitors

object[]

required

Show child attributes

Engines

Workspaces

Tags

Prompts

Audits

Brand Reports

Competitors

Accounts

Get citation statistics for a brand report

Authorizations

Path Parameters

Query Parameters

Response