Skip to main content
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
}
'
{
  "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 the X-API-Key header or as api_key query parameter (see Authentication). Body (JSON, all optional):
IconFieldTypeDescription
🏷ī¸brand_idstringFilter by brand ID. Omit for all brands.
📅start_datestringStart date YYYY-MM-DD. Default: 30 days ago.
📅end_datestringEnd date YYYY-MM-DD. Default: today.
đŸ”ĸlimitnumberMax items (1–10000). Default: 1000.
↩ī¸offsetnumberPagination 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

​
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

Brand visibility report

​
data
object[]
​
total
integer