Mentions - GeoArk AI

Mentions report

curl --request POST \
  --url https://api.geoark.ai/api/customer/v1/reports/mentions \
  --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/mentions"

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/mentions', 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/mentions",
  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/mentions"

	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/mentions")
  .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/mentions")

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": "<array>",
  "total": 123
}

POST

reports

mentions

Mentions report

curl --request POST \
  --url https://api.geoark.ai/api/customer/v1/reports/mentions \
  --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/mentions"

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/mentions', 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/mentions",
  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/mentions"

	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/mentions")
  .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/mentions")

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": "<array>",
  "total": 123
}

POST /reports/mentions

Returns brand mentions with source type, URL, title, snippet, platform, and sentiment. Optional date filter. Each mention includes the prompt that was asked (query.queryText) — the query that led to this mention — so you can see which prompt surfaced each result. Endpoint: POST https://api.geoark.ai/api/customer/v1/reports/mentions

Request

Send your API key in the X-API-Key header or as api_key query parameter (see Authentication). Body (JSON, all optional):

Field	Type	Description
`brand_id`	string	Filter by brand ID. Omit for all brands.
`project_id`	string	Alias for `brand_id`.
`start_date`	string	Start date `YYYY-MM-DD`.
`end_date`	string	End date `YYYY-MM-DD`.
`limit`	number	Max items. Default: 1000.
`offset`	number	Pagination offset. Default: 0.

Response

Each object in data includes the mention details plus query — with queryText (the prompt that was asked), id, and platform (CHATGPT, CLAUDE, GEMINI, PERPLEXITY, GROK, DEEPSEEK, or LLAMA) — so you know which query produced the mention.

{
  "data": [
    {
      "id": "...",
      "brand": { "id": "...", "name": "Acme Inc" },
      "sourceType": "ARTICLE",
      "sourceName": "Tech Review",
      "sourceUrl": "https://...",
      "title": "Best tools for 2025",
      "snippet": "Acme Inc is recommended for...",
      "platform": "CHATGPT",
      "sentiment": "POSITIVE",
      "discoveredAt": "2025-02-20T14:00:00.000Z",
      "query": { "id": "...", "queryText": "best CRM", "platform": "CHATGPT" }
    }
  ],
  "total": 15
}

Status codes

200 — Success
400 — Validation error
401 — Invalid or missing API key
402 — Paid subscription required (Custom plan)

Authorizations

X-API-Key

string

header

required

API key from Dashboard → API Keys (Custom plan).

Body

application/json

brand_id

string

Filter by brand ID. Omit for all brands.

project_id

string

Alias for brand_id (integration compatibility).

start_date

string<date>

Start date (YYYY-MM-DD). Default: 30 days ago.

end_date

string<date>

End date (YYYY-MM-DD). Default: today.

limit

integer

default:1000

Max items to return.

Required range: 1 <= x <= 10000

offset

integer

default:0

Offset for pagination.

Required range: x >= 0

Response

Mentions report

data

array

total

integer

​POST /reports/mentions

​Request

​Response

​Status codes

Authorizations

Body

Response

POST /reports/mentions

Request

Response

Status codes