API Introduction - GeoArk AI

This reference covers the Customer API — the endpoints you use with an API key to pull data into your own reports, dashboards, or integrations. No login or password; just the key.

Base URL

https://api.geoark.ai/api/customer/v1

Use this base URL in Postman, curl, or your app.

Authentication

Generate an API key in the dashboard (API Keys, Custom plan). Send it with every request:

Header (recommended): X-API-Key: <your_api_key>
Query (optional): ?api_key=<your_api_key>

Endpoints Overview

Icon	Endpoint	Purpose
📈	`POST /reports/brands`	Brand visibility metrics by date range
🎯	`POST /reports/queries`	Query runs with visibility and sentiment
💬	`POST /reports/mentions`	Brand mentions with source and sentiment

Response Format

Responses are JSON. Errors include error and optional message:

{
  "error": "Query limit reached",
  "message": "Your Free plan allows up to 2 prompts per month. Upgrade to run more.",
  "currentUsage": 2,
  "limit": 2,
  "plan": "FREE"
}

Rate Limits

Rate limits may apply. A 429 response means you’re over the limit — slow down and retry later.