Skip to main content
POST
Brand visibility report

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):
project_id — Alias for brand_id (for integration compatibility). Use one or the other.

Response

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