Brand visibility report
curl --request POST \
--url https://api.geoark.ai/api/customer/v1/reports/brands \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"brand_id": "<string>",
"project_id": "<string>",
"start_date": "2023-12-25",
"end_date": "2023-12-25",
"limit": 1000,
"offset": 0
}
'import requests
url = "https://api.geoark.ai/api/customer/v1/reports/brands"
payload = {
"brand_id": "<string>",
"project_id": "<string>",
"start_date": "2023-12-25",
"end_date": "2023-12-25",
"limit": 1000,
"offset": 0
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
brand_id: '<string>',
project_id: '<string>',
start_date: '2023-12-25',
end_date: '2023-12-25',
limit: 1000,
offset: 0
})
};
fetch('https://api.geoark.ai/api/customer/v1/reports/brands', 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.geoark.ai/api/customer/v1/reports/brands",
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([
'brand_id' => '<string>',
'project_id' => '<string>',
'start_date' => '2023-12-25',
'end_date' => '2023-12-25',
'limit' => 1000,
'offset' => 0
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.geoark.ai/api/customer/v1/reports/brands"
payload := strings.NewReader("{\n \"brand_id\": \"<string>\",\n \"project_id\": \"<string>\",\n \"start_date\": \"2023-12-25\",\n \"end_date\": \"2023-12-25\",\n \"limit\": 1000,\n \"offset\": 0\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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.geoark.ai/api/customer/v1/reports/brands")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"brand_id\": \"<string>\",\n \"project_id\": \"<string>\",\n \"start_date\": \"2023-12-25\",\n \"end_date\": \"2023-12-25\",\n \"limit\": 1000,\n \"offset\": 0\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.geoark.ai/api/customer/v1/reports/brands")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"brand_id\": \"<string>\",\n \"project_id\": \"<string>\",\n \"start_date\": \"2023-12-25\",\n \"end_date\": \"2023-12-25\",\n \"limit\": 1000,\n \"offset\": 0\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"brand": {
"id": "<string>",
"name": "<string>"
},
"visibility": 123,
"visibility_count": 123,
"visibility_total": 123,
"sentiment": 123,
"sentiment_count": 123,
"position": 123,
"position_count": 123
}
],
"total": 123
}Brand visibility report
Visibility, sentiment, and position metrics per brand.
POST
/
reports
/
brands
Brand visibility report
curl --request POST \
--url https://api.geoark.ai/api/customer/v1/reports/brands \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"brand_id": "<string>",
"project_id": "<string>",
"start_date": "2023-12-25",
"end_date": "2023-12-25",
"limit": 1000,
"offset": 0
}
'import requests
url = "https://api.geoark.ai/api/customer/v1/reports/brands"
payload = {
"brand_id": "<string>",
"project_id": "<string>",
"start_date": "2023-12-25",
"end_date": "2023-12-25",
"limit": 1000,
"offset": 0
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
brand_id: '<string>',
project_id: '<string>',
start_date: '2023-12-25',
end_date: '2023-12-25',
limit: 1000,
offset: 0
})
};
fetch('https://api.geoark.ai/api/customer/v1/reports/brands', 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.geoark.ai/api/customer/v1/reports/brands",
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([
'brand_id' => '<string>',
'project_id' => '<string>',
'start_date' => '2023-12-25',
'end_date' => '2023-12-25',
'limit' => 1000,
'offset' => 0
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.geoark.ai/api/customer/v1/reports/brands"
payload := strings.NewReader("{\n \"brand_id\": \"<string>\",\n \"project_id\": \"<string>\",\n \"start_date\": \"2023-12-25\",\n \"end_date\": \"2023-12-25\",\n \"limit\": 1000,\n \"offset\": 0\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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.geoark.ai/api/customer/v1/reports/brands")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"brand_id\": \"<string>\",\n \"project_id\": \"<string>\",\n \"start_date\": \"2023-12-25\",\n \"end_date\": \"2023-12-25\",\n \"limit\": 1000,\n \"offset\": 0\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.geoark.ai/api/customer/v1/reports/brands")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"brand_id\": \"<string>\",\n \"project_id\": \"<string>\",\n \"start_date\": \"2023-12-25\",\n \"end_date\": \"2023-12-25\",\n \"limit\": 1000,\n \"offset\": 0\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"brand": {
"id": "<string>",
"name": "<string>"
},
"visibility": 123,
"visibility_count": 123,
"visibility_total": 123,
"sentiment": 123,
"sentiment_count": 123,
"position": 123,
"position_count": 123
}
],
"total": 123
}POST /reports/brands
Returns brand visibility metrics for the given date range: visibility percentage, sentiment, and average position. Endpoint:POST https://api.geoark.ai/api/customer/v1/reports/brands
Request
Send your API key in theX-API-Key header or as api_key query parameter (see Authentication).
Body (JSON, all optional):
| Icon | Field | Type | Description |
|---|---|---|---|
| 🏷️ | brand_id | string | Filter by brand ID. Omit for all brands. |
| 📅 | start_date | string | Start date YYYY-MM-DD. Default: 30 days ago. |
| 📅 | end_date | string | End date YYYY-MM-DD. Default: today. |
| 🔢 | limit | number | Max items (1–10000). Default: 1000. |
| ↩️ | offset | number | Pagination offset. Default: 0. |
project_id — Alias for brand_id (for integration compatibility). Use one or the other.Response
{
"data": [
{
"brand": { "id": "...", "name": "Acme Inc" },
"visibility": 72.5,
"visibility_count": 29,
"visibility_total": 40,
"sentiment": 68.2,
"sentiment_count": 29,
"position": 2.1,
"position_count": 29
}
],
"total": 1
}
Status codes
- 200 — Success
- 400 — Validation error (e.g. invalid date format)
- 401 — Invalid or missing API key
- 402 — Paid subscription required (Custom plan)
Authorizations
APIKeyHeaderAPIKeyQuery
API key from Dashboard → API Keys (Custom plan).
Body
application/json
Filter by brand ID. Omit for all brands.
Alias for brand_id (integration compatibility).
Start date (YYYY-MM-DD). Default: 30 days ago.
End date (YYYY-MM-DD). Default: today.
Max items to return.
Required range:
1 <= x <= 10000Offset for pagination.
Required range:
x >= 0⌘I